Application: gvSIG desktop

/* 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.statistics;

import org.gvsig.raster.lib.buffer.api.Band;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * @author fdiaz

 *

 */

public interface StatisticsBand {

    /**

     * Gets the number of values by band

     *

     * @return the number of values by band

     */

    public long getBandLength();

    /**

     * Obtiene el tipo de datos de la banda

     *

     * @return el tipo de datos de la banda

     */

    public int getDataType();

    /**

     * 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 la banda

     *

     * @return maximum

     */

    public double getMaximum();

    /**

     * Devuelve el m?nimo valor de la banda

     *

     * @return minimum

     */

    public double getMinimum();

    /**

     * Obtiene el valor medio

     *

     * @return Valor medio

     */

    public double getMean();

    /**

     * Obtiene la varianza

     *

     * @return Varianza

     */

    public double getVariance();

    /**

     * Obtiene la mediana

     *

     * @return Median

     */

    public double getMedian();

    /**

     * Obtiene un valor de recorte de colas para un porcentaje dado. 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

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

     */

    public double[] getTailTrimValue(double percent);

    /**

     * Obtiene un valor de recorte de colas para una posici?n dada. 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

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

     */

    public double[] getTailTrimValue(int pos);

    /**

     * 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 status

     * @throws FileNotOpenException

     * @throws RasterDriverException

     * @throws ProcessInterruptedException

     */

    public void calculate(SimpleTaskStatus status, Band band); //??? scale ???

    /**

     * Gets histogram of the band

     *

     * @return HistogramBand

     */

    public HistogramBand getHistogramBand();

    /**

     * @return NoData values count

     */

    public long getNoDataValuesCount();

}