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.grid;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.store.props.BasicStats;

import org.gvsig.fmap.dal.coverage.store.props.ColorTable;

import org.gvsig.tools.dispose.Disposable;

/**

 * Interfaz que deben implementar los grid en los que se puede consultar sus datos.

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

 */

public interface Grid extends Disposable {

        /**

         *Aplica la lista de filtros sobre el buffer

         * @throws FilterAddException

         * @throws InterruptedException

         */

        public void applyFilters() throws ProcessInterruptedException, FilterAddException;

        /**

         * Carga el buffer de datos desde el reader para poder escribir sobre los datos de

         * la ventana original. Esto es ?til cuando el GridWriter se crea asociado a un raster

         * pero el buffer est? vacio, por ejemplo en el caso de crear un GridInterpolated. Un

         * GridInterpolated no carga ning?n buffer en memoria sino que accede a los datos en disco

         * a medida que se le van solicitando. Por ello, no es posible modificarlos sino cargamos

         * un buffer con los datos previamente.

         */

        public void loadWriterData() throws GridException;

        /**

         * Obtiene el buffer de datos del grid

         * @return RasterBuf

         */

        public Buffer getRasterBuf();

        /**

         * Asigna la banda sobre la que se realizan las operaciones. Por defecto es la banda 0

         * con lo que para el uso de MDTs no habr? que modificar este valor.

         * @param band Banda sobre la que se realizan las operaciones.

         */

        public void setBandToOperate(int band);

        /**

         * Obtiene el n?mero de bandas del grid o 0 si no tiene buffer de

         * datos asociado.

         * @return N?mero de bandas

         */

        public int getBandCount();

        /**

         * Obtiene el objeto que calcula las estad?sticas del Grid

         * @return IBasicStats

         */

        public BasicStats getStatistics();

        /**

         * Obtiene el valor de una celda de tipo byte. Si el punto excede los l?mites

         * del grid devuelve un valor NoData. La excepci?n ser? lanzada si intentamos

         * acceder a un tipo de dato erroneo.

         * @param x Posici?n X a recuperar

         * @param y Posici?n Y a recuperar

         * @throws RasterBufferInvalidAccessException

         * @return Valor byte

         */

        public byte getCellValueAsByte(int x, int y)throws GridException;

        /**

         * Obtiene el valor de una celda de tipo short. Si el punto excede los l?mites

         * del grid devuelve un valor NoData. La excepci?n ser? lanzada si intentamos

         * acceder a un tipo de dato erroneo.

         * @param x Posici?n X a recuperar

         * @param y Posici?n Y a recuperar

         * @throws RasterBufferInvalidAccessException

         * @return Valor short

         */

        public short getCellValueAsShort(int x, int y)throws GridException;

        /**

         * Obtiene el valor de una celda de tipo int. Si el punto excede los l?mites

         * del grid devuelve un valor NoData. La excepci?n ser? lanzada si intentamos

         * acceder a un tipo de dato erroneo.

         * @param x Posici?n X a recuperar

         * @param y Posici?n Y a recuperar

         * @throws RasterBufferInvalidAccessException

         * @return Valor int

         */

        public int getCellValueAsInt(int x, int y)throws GridException;

        /**

         * Obtiene el valor de una celda de tipo float. Si el punto excede los l?mites

         * del grid devuelve un valor NoData. La excepci?n ser? lanzada si intentamos

         * acceder a un tipo de dato erroneo.

         * @param x Posici?n X a recuperar

         * @param y Posici?n Y a recuperar

         * @throws RasterBufferInvalidAccessException

         * @return Valor float

         */

        public float getCellValueAsFloat(int x, int y)throws GridException;

        /**

         * Obtiene el valor de una celda de tipo double. Si el punto excede los l?mites

         * del grid devuelve un valor NoData. La excepci?n ser? lanzada si intentamos

         * acceder a un tipo de dato erroneo.

         * @param x Posici?n X a recuperar

         * @param y Posici?n Y a recuperar

         * @throws RasterBufferInvalidAccessException

         * @return Valor double

         */

        public double getCellValueAsDouble(int x, int y)throws GridException;

        /**

         * Asigna el m?todo de interpolaci?n. Si el lector no es interpolado se instanciar?

         * como interpolado sin necesidad de llamar a switchToInterpolationMethod. Los m?todos

         * de interpolaci?n soportados est?n definidos en la clase GridInterpolated como variables

         * est?ticas.

         *

         * @param iMethod

         */

        public void setInterpolationMethod(int iMethod);

        /**

         * Consulta al grid si el valor pasado por par?metro coincide con el valor NoData del

         * buffer.

         * @param dValue valor para comparar con el NoData del buffer

         * @return true si el valor pasado es NoData y false si no lo es

         */

        public boolean isNoDataValue(double dValue);

        /**

         * Obtiene la extensi?n de la ventana del raster accedida por el grid

         * @return Objeto GridExtent con la extensi?n.

         */

        public GridExtent getGridExtent();

        /**

         * Consulta si un punto est? dentro del grid o fuera de el

         * @param x Coordenada X del punto a consultar

         * @param y Coordenada Y del punto a consultar

         * @return true si el punto est? dentro del grid y false si est? fuera de ?l

         */

        public boolean isInGrid(int x, int y);

        /**

         * Obtiene el ancho en p?xeles del grid

         * @return entero que representa el ancho en p?xeles

         */

        public int getNX();

        /**

         * Obtiene el alto en p?xeles del grid

         * @return entero que representa el alto en p?xeles

         */

        public int getNY();

        /**

         * Obtiene el ancho en p?xeles del dataset completo

         * @return entero que representa el ancho en p?xeles del dataset completo

         */

        public int getLayerNX();

        /**

         * Obtiene el alto en p?xeles del dataset completo

         * @return entero que representa el alto en p?xeles del dataset completo

         */

        public int getLayerNY();

        /**

         * Tama?o de celda

         * @return

         */

        public double getCellSize();

        /**

         * Obtiene el tipo de datos

         * @return

         */

        public int getDataType();

        /**

         * Valor nodata asociado al grid

         * @return

         */

        public NoData getNoDataValue();

        /**

         * Obtiene la lista de paletas asociadas al grid

         * @return Lista de objetos GridPalette

         */

        public ColorTable getPalette();

        /**

         * Obtiene la pendiente de un ?rea de 3x3 p?xeles que tiene como

         * centro las coordenadas que se le indican

         * @param x Coordenada pixel X

         * @param y Coordenada pixel Y

         * @return

         * @throws GridException

         */

        public double getSlope(int x, int y)throws GridException;

        public double getAspect(int x, int y)throws GridException;

        public double getDistToNeighborInDir(int iDir);

        public int getDirToNextDownslopeCell(int x, int y)throws GridException;

        public int getDirToNextDownslopeCell(int x, int y, boolean bForceDirToNoDataCell)throws GridException;

        public GridCell[] getSortedArrayOfCells()throws GridException;

        public void assign(byte value)throws GridException;

        public void assign(short value)throws GridException;

        public void assign(int value)throws GridException;

        public void assign(float value)throws GridException;

        public void assign(double value)throws GridException;

        public void assign(Grid driver)throws GridException;

        public void addToCellValue(int x, int y, byte value) throws GridException;

        public void addToCellValue(int x, int y, short value) throws GridException;

        public void addToCellValue(int x, int y, int value) throws GridException;

        public void addToCellValue(int x, int y, float value) throws GridException;

        public void addToCellValue(int x, int y, double value) throws GridException;

        public void assignNoData();

        public void setCellValue(int x, int y, byte value)throws OutOfGridException;

        public void setCellValue(int x, int y, short value)throws OutOfGridException;

        public void setCellValue(int x, int y, int value)throws OutOfGridException;

        public void setCellValue(int x, int y, float value)throws OutOfGridException;

        public void setCellValue(int x, int y, double value)throws OutOfGridException;

        public void add(Grid driver) throws GridException;

        public void multiply(double dValue) throws GridException;

        /**

         * Asigna el valor que indica que una celda no tiene datos para el buffer

         * @param dNoDataValue Valor NoData

         */

        public void setNoDataValue(NoData dNoDataValue);

        public void setNoData(int x, int y);

        /**

         * Obtiene la lista de filtros.

         * @return Lista de filtros.

         */

        public RasterFilterList getFilterList();

        /**

         * Asigna la lista de filtros

         * @param filterList

         */

        public void setFilterList(RasterFilterList filterList);

        /**

         * Returns a GridCell object

         * @param iX

         *        X position

         * @param iY

         *        Y position

         * @return

         * @throws GridException

         */

        public GridCell getGridCell(int iX, int iY) throws GridException;

}