Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.fmap.dal.coverage.store.props;

import org.gvsig.fmap.dal.coverage.datastruct.BufferHistogram;

import org.gvsig.fmap.dal.coverage.exception.HistogramException;

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.process.IncrementableTask;

/**

 * Interfaz para la gesti?n de histogramas de un raster. Es la encargada del calculo de un histograma

 * total o parcial de un raster a partir de los datos de disco. Adem?s tambi?n es la encargada de gestionar

 * salvar este histograma a .rmf. En caso de que solicite un histograma del raster completo este ir?

 * a buscarlo al fichero rmf asociado antes de calcularlo por si ya existise. Al realizar el calculo

 * del histograma de la imagen completa este ser? salvado en el fichero .rmf asociado al raster.

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface HistogramComputer extends IncrementableTask {

        /**

         * Obtiene el minimo valor de las estadisticas de un histograma.

         * @return double

         */

        public double getMinimum();

        /**

         * Obtiene el maximo valor de las estadisticas de un histograma.

         * @return double

         */

        public double getMaximum();

        /**

         * Obtiene el histograma. Si puede conseguirlo del fichero rmf ir? all? a 

         * buscarlo sino lo calcular?.

         * @return histograma 

         */

        public BufferHistogram getBufferHistogram() throws HistogramException, ProcessInterruptedException;

        /**

         * Pone a cero el porcentaje de progreso del proceso de calculo de histograma

         */

        public void resetPercent();

        /**

         * Force to recalculate the histogram next time that the method getBufferHistogram

         * be called 

         */

        public void refreshHistogram();

        /**

         * This value represents the percentage of the image that will be used 

         * for this process. The default value is one, that means that the entire 

         * image will be processed

         */

        public void setScaleHistogram(double scale);

}