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;

/**

 * @author fdiaz

 *

 */

public interface HistogramBand {

    /**

     * Obtiene n?mero de valores

     *

     * @return entero con el n?mero de valores del histograma

     */

    public long getNumValues();

    /**

     * Obtiene el tipo de datos de la banda

     *

     * @return el tipo de datos de la banda

     */

    public int getDataType();

    // /**

    // * Obtiene un valor del histograma segun la posicion dentro de las clases

    // * @param pos Pixel o valor de la clase del valor a recuperar

    // *

    // * @return valor

    // */

    // public long getHistogramValueByPos(int pos);

    /**

     * Obtiene un valor del histograma

     *

     * @param value

     *            valor de la clase a recuperar

     * @return valor

     */

    public long getHistogramValue(double value);

    /**

     * Realiza la uni?n entre el histograma actual y el pasado

     * por par?metro.

     *

     * @param hist

     * @return true if the union has been possible

     */

    public boolean union(HistogramBand hist);

    /**

     * Obtiene los valores de las clases

     *

     * @return los valores de las clases

     */

    public long[] getFrequencies();

    /**

     * Obtiene el n?mero de clases del histograma

     *

     * @return entero que representa el n?mero de valores o clases del

     *         histograma

     */

    public int getNumClasses();

    /**

     * Devuelve el n?mero de valores de un intervalo

     *

     * @param interval

     * @return el n?mero de valores del intervalo

     */

    public long getValueCount(int interval);

    /**

     * Devuelve el valor m?nimo de un intervalo

     *

     * @param interval

     * @return el valor m?nimo del intervalo

     */

    public double getIntervalMin(int interval);

    /**

     * Devuelve el valor m?ximo de un intervalo

     *

     * @param interval

     * @return el valor m?ximo del intervalo

     */

    public double getIntervalMax(int interval);

    /**

     * @return median value

     */

    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);

}