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 Histogram {

    /**

     * Obtiene el n?mero de bandas del histograma

     * @return entero que representa el n?mero de bandas

     */

    public int getNumBands();

    /**

     * Obtiene la longitud (n?mero de valores) de una banda determinada

     * @param band Banda o obtener la longitud

     * @return entero con la longitud de la banda

     * rangos de valores y DataclassList.

     */

    public int getBandLenght(int band);

    /**

     * Obtiene el tipo de datos del histograma original

     *

     * @return el tipo de datos del histograma original

     */

    public int getDataType();

    /**

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

     * @param band N?mero de banda del valor a recuperar

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

     *

     * @return valor

     */

    public double getHistogramValueByPos(int band, int pos);

    /**

     * Obtiene un valor del histograma

     * @param band N?mero de banda del valor a recuperar

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

     * @return valor

     */

    public double getHistogramValue(int band, double px);

    /**

     * 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(Histogram hist);

    /**

     * Obtiene la tabla de valores

     *

     * @return la tabla de valores

     */

    public long[][] getTable();

    /**

     * Obtiene el histograma de la imagen negativa.

     *

     * @return el histograma de la imagen negativa.

     */

    public long[][] getNegativeTable();

    /**

     * Devuelve el minimo valor del histograma

     *

     * @return el minimo valor del histograma

     */

    public double getMinimum();

    /**

     * Devuelve el maximo valor del histograma

     *

     * @return el maximo valor del histograma

     */

    public double getMaximum();

    /**

     * Obtiene el n?mero de valores o clases del histograma

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

     */

    public int getNumValues();

    /**

     * Devuelve si un histograma esta en un rango RGB aceptable

     *

     * @return si un histograma esta en un rango RGB aceptable

     */

    public boolean isInRangeRGB();

    /**

     * Calculo de estad?sticas a partir de un histograma. El resultado de la funci?n es un array

     * bidimensional donde el primer ?ndice inndica la estadistica y el segundo el n?mero de banda.

     *

     * <UL>

     * <LI>m?nimo</LI>

     * <LI>m?ximo</LI>

     * <LI>media</LI>

     * <LI>mediana</LI>

     * <LI>N?mero de pixels</LI>

     * </UL>

     * @param histogram

     * @param beginPos Posici?n de inicio del histograma para contabilizar estadisticas

     * @param endPos Posici?n de fin del histograma para contabilizar estadisticas

     * @param bands bandas solicitadas. Cada elemento del vector representa una banda. Si est? a true se calcula la

     * estadistica para esa banda y si est? a false no se calcular?.

     *

     * @return las estad?sticas a partir del histograma.

     */

    public double[][] getBasicStats(double beginPos, double endPos, boolean[] bands);

    /**

     * Calculo de estad?sticas a partir de un histograma. El resultado de la funci?n es un array

     * bidimensional donde el primer ?ndice inndica la estadistica y el segundo el n?mero de banda.

     *

     * <UL>

     * <LI>m?nimo</LI>

     * <LI>m?ximo</LI>

     * <LI>media</LI>

     * <LI>mediana</LI>

     * <LI>N?mero de pixels</LI>

     * </UL>

     * @param histogram

     * @param bands bandas solicitadas. Cada elemento del vector representa una banda. Si est? a true se calcula la

     * estadistica para esa banda y si est? a false no se calcular?.

     *

     * @return las estad?sticas a partir del histograma.

     */

    public double[][] getBasicStats(boolean[] bands);

    /**

     * Calcula las estad?sticas.

     *

     * @param status

     */

    public void calculate(SimpleTaskStatus status);

    /**

     * @return true if the histogram has been calculated

     */

    public boolean isCalculated();

    /**

     * Devuelve los valores m?nimos de todas las bandas

     *

     * @return los valores m?nimos de todas las bandas

     */

    public double[] getMin();

    /**

     * Devuelve los valores m?nimos de todas las bandas

     *

     * @return los valores m?nimos de todas las bandas

     */

    public double[] getMax();

    /**

     * Devuelve el n?mero de valores de un intervalo

     *

     * @param band

     * @param interval

     * @return el n?mero de valores del intervalo

     */

    public int getValueCount(int band, int interval);

    /**

     * Devuelve el valor m?nimo de un intervalo

     *

     * @param band

     * @param interval

     * @return el valor m?nimo del intervalo

     */

    public int getIntervalMin(int band, int interval);

    /**

     * Devuelve el valor m?ximo de un intervalo

     *

     * @param band

     * @param interval

     * @return el valor m?ximo del intervalo

     */

    public int getIntervalMax(int band, int interval);

}