Application: gvSIG desktop » gvSIG raster

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.buffer.api;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * @author fdiaz

 *

 */

public interface Statistics {

    /**

     * Gets the number of values by band

     *

     * @return the number of values by band

     */

    public long[] getNumberOfValues();

    /**

     * Devuelve una lista con los m?ximos de todas las bandas

     *

     * @return Valor m?ximo

     */

    public double[] getMax();

    /**

     * Obtiene el valor del segundo m?ximo

     *

     * @return Valor del segundo m?ximo

     */

    public double[] getSecondMax();

    /**

     * Obtiene el valor del segundo m?nimo

     *

     * @return Valor del segundo m?nimo

     */

    public double[] getSecondMin();

    /**

     * Devuelve el m?ximo valor de todos los m?ximos de las bandas

     *

     * @return M?ximo

     */

    public double getMaximun();

    /**

     * Devuelve el m?nimo valor de todos los m?nimos de las bandas

     *

     * @return M?ximo

     */

    public double getMinimun();

    /**

     * Devuelve el m?ximo valor RGB de todos los m?ximos de las bandas

     *

     * @return M?ximo

     */

    public double getMaximunByteUnsigned();

    /**

     * Devuelve el m?nimo valor RGB de todos los m?nimos de las bandas

     * @return M?ximo

     */

    public double getMinimunByteUnsigned();

    /**

     * Obtiene el valor m?dio

     *

     * @return Valor medio

     */

    public double[] getMean();

    /**

     * Devuelve una lista con los m?nimos de todas las bandas

     *

     * @return Valor m?nimo

     */

    public double[] getMin();

    /**

     * Obtiene el m?nimo cuando el raster es de typo byte RGB

     *

     * @return el m?nimo cuando el raster es de typo byte RGB

     */

    public double[] getMinByteUnsigned();

    /**

     * Obtiene el m?ximo cuando el raster es de typo byte RGB

     *

     * @return el m?ximo cuando el raster es de typo byte RGB

     */

    public double[] getMaxByteUnsigned();

    /**

     * Obtiene el segundo m?ximo cuando el raster es de typo byte RGB

     *

     * @return el segundo m?ximo cuando el raster es de typo byte RGB

     */

    public double[] getSecondMaxByteUnsigned();

    /**

     * Obtiene el segundo m?nimo cuando el raster es de typo byte RGB

     *

     * @return el segundo m?nimo cuando el raster es de typo byte RGB

     */

    public double[] getSecondMinByteUnsigned();

    /**

     * Obtiene la varianza

     *

     * @return Varianza

     */

    public double[] getVariance();

    /**

     * Gets the number of bands

     *

     * @return the number of bands

     */

    public int getBandCount();

    /**

     * Obtiene un valor de recorte de colas para un porcentaje dado. El valor ser? un array

     * bidimensional ([N?mero de bandas][2]) donde para cada banda se almacena el valor en

     * esa posici?n del recorte de colas. Este recorte consiste en ordenar los elementos del

     * raster (o una muestra de ellos) y devolver el valor que corresponde al porcentaje comenzando

     * desde el principio del array ordenado y desde el final de ?l (m?nimo y m?ximo).

     *

     * @param percent Porcentaje de recorte

     * @param valueByBand array bidimensional de enteros o doubles. Depende del tipo de dato del raster.

     * @return El valor de recorte de colas para el porcentaje dado

     */

    public Object getTailTrimValue(double percent);

    /**

     * Obtiene un valor de recorte de colas para una posici?n dada. El valor ser? un array

     * bidimensional ([N?mero de bandas][2]) donde para cada banda se almacena el valor en

     * esa posici?n del recorte de colas. Este recorte consiste en ordenar los elementos del

     * raster (o una muestra de ellos) y devolver el valor que corresponde al porcentaje comenzando

     * desde el principio del array ordenado y desde el final de ?l (m?nimo y m?ximo).

     * @param pos posici?n de recorte

     * @param valueByBand array bidimensional de enteros o doubles. Depende del tipo de dato del raster.

     * @return el valor de recorte de colas para la posici?n dada

     */

    public Object[] getTailTrimValue(int pos);

    /**

     * Devuelve el n?mero de valores de recorte de colas calculados.

     * @return N?mero de valores de recorte de colas calculados.

     */

    public int getTailTrimCount();

    /**

     * Obtiene el flag que informa de si las estad?sticas est?n calculadas o no.

     * @return true indica que est?n calculadas y false que no lo est?n

     */

    public boolean isCalculated();

    /**

     * Throws the thread which figure out statistics

     * @param scale

     * @param status

     * @throws FileNotOpenException

     * @throws RasterDriverException

     * @throws ProcessInterruptedException

     */

    public void calculate(double scale, SimpleTaskStatus status);

    /**

     * Gets the number of pixels by band

     *

     * @return  the number of pixels by band

     */

    public long[] getNumberOfCells();

    /**

     * Devuelve la matriz de varianza-covarianza, si no se encuentra calculada se calcula

     *

     * @return Matriz de varianza-covarianza

     */

    public double[][] getVarianceCovarianceMatrix();

    /**

     * Clones this object

     *

     * @return this cloned object

     */

    public Statistics clone();

}