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.raster.impl.store;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.util.ArrayList;

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

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

import org.gvsig.raster.impl.provider.RasterProvider;

/**

 * A kind of dataset which can be queried should implement this interface.

 *

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

 */

public interface QueryableRaster {

        /**

         * Gets the dataset of this queryable raster

         * @return RasterDataSet

         */

        public RasterDataStore getDataStore();

        /**

         * Gets the rater providers

         * @return RasterProvider

         *         returns the list of providers

         */

        public ArrayList<RasterProvider> getProviders();

        /**

         * Gets the provider in the i position

         * @return RasterProvider

         *         returns a RasterProvider 

         */

        public RasterProvider getProvider(int i);

        /**

         * Obtiene el n?mero de ficheros en la lista

         * @return integer.

         */

        public int getDataStoreCount();

        /**

         * Obtiene la lista de bandas

         * @return BandList

         */

        public BandList getBands();

        /**

         * Asigna las bandas dibujables cuando se solicita una acci?n de lectura de datos

         * @param db int[]

         */

        public void setDrawableBands(int[] db);

        /**

         * Removes the drawable bands

         */

        public void clearDrawableBands();

        /**

         * Obtiene las bandas dibujables cuando se solicita una acci?n de lectura de datos

         * @return

         */

        public int[] getDrawableBands();

        /**

         * Obtiene el n?mero de bandas del raster

         * @return N?mero de bandas

         */

        public int getBandCount();

        /**

         * Obtiene el valor NoData asociado al raster.

         * @return

         */

        public double getNoDataValue();

        /**

         * Para este dataset asigna que bandas se pintaran

         * sobre el RasterBuf cuando se haga un update. Especificamos a 

         * trav?s de los par?metros para que posici?n del RasterBuf ir? 

         * dibujada con que banda del fichero de imagen.

         * @param posRasterBuf        Posici?n del RasterBuf que queremos pintar.

         * @param imageBand        Banda de la imagen que se pintar?

         */

        public void addDrawableBand(int posRasterBuf, int imageBand);

        /**

         * Obtiene la paleta correspondiente al nombre del fichero pasado por par?metro. 

         * @param fileName Nombre del fichero

         * @return Paleta o null si no la tiene

         */

        public ColorTable getColorTable(String fileName);

        /**

         * Obtiene la paleta correspondiente a uno de los ficheros que forman el GeoMultiRasterFile

         * @param i Posici?n del raster

         * @return Paleta asociada a este o null si no tiene

         */

        public ColorTable getColorTable(int i);

        /**

         * Obtiene el extent del raster.

         * @return Extent

         */

        public Extent getExtent();

        /**

         * Gets an extent adjusted to the bounding box of this raster

         * @param e

         * @return

         */

        public Extent adjustToExtent(Extent e);

        /**

         * Obtiene la altura del raster en p?xeles.

         * @return altura

         */

        public double getHeight();

        /**

         * Obtiene la anchura del raster en p?xeles.

         * @return anchura

         */

        public double getWidth();

        /**

         * Recupera del raster la matriz de transformaci?n que lo situa en cualquier parte de la vista

         * @param band

         * @return AffineTransform

         */

        public AffineTransform getAffineTransform();

        /**

         * Convierte un punto desde coordenadas pixel a coordenadas del mundo.

         * @param pt Punto a transformar

         * @return punto transformado en coordenadas del mundo

         */

        public Point2D rasterToWorld(Point2D pt);

        /**

         * Convierte un punto desde del mundo a coordenadas pixel.

         * @param pt Punto a transformar

         * @return punto transformado en coordenadas pixel

         */

        public Point2D worldToRaster(Point2D pt);

        /**

         * Asigna el flag que dice si la carga del siguiente buffer es en memoria. El poner este flag a true hace que se

         * ponga a false el de readOnly autom?ticamente.

         * @param memory true si la siguiente carga de buffer se hace en memoria y false se deja decidir al dataset 

         * el tipo de buffer

         */

        public void setMemoryBuffer(boolean memoryBuffer);

        /**

         * Obtiene una ventana de datos de la imagen a partir de coordenadas reales. 

         * No aplica supersampleo ni subsampleo sino que devuelve una matriz de igual tama?o a los

         * pixeles de disco. 

         * @param x Posici?n X superior izquierda

         * @param y Posici?n Y superior izquierda

         * @param w Ancho en coordenadas reales

         * @param h Alto en coordenadas reales

         * @param adjustToExtent Flag que dice si el extent solicitado debe ajustarse al extent del raster o no.

         * @param bandList

         * @return Buffer de datos

         */

        public Buffer getWindowRaster(double ulx, double uly, double lrx, double lry) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException;

        /**

         * Obtiene una ventana de datos de la imagen a partir de coordenadas reales. 

         * No aplica supersampleo ni subsampleo sino que devuelve una matriz de igual tama?o a los

         * pixeles de disco. 

         * @param x Posici?n X superior izquierda

         * @param y Posici?n Y superior izquierda

         * @param w Ancho en coordenadas reales

         * @param h Alto en coordenadas reales

         * @param adjustToExtent Flag que dice si el extent solicitado debe ajustarse al extent del raster o no.

         * @param bandList

         * @return Buffer de datos

         */

        public Buffer getWindowRaster(double ulx, double uly, double w, double h, boolean adjustToExtent) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException;

        /**

         * Obtiene una ventana de datos de la imagen a partir de coordenadas reales. 

         * Aplica supersampleo o subsampleo en funci?n del tama?o del buffer. Esta operaci?n la gestiona

         * el driver.

         * @param minX Valor m?nimo de la X en coordenadas reales

         * @param minY Valor m?nimo de la Y en coordenadas reales

         * @param maxX Valor m?ximo de la X en coordenadas reales

         * @param maxY Valor m?ximo de la Y en coordenadas reales

         * @param bufWidth ancho del buffer lde datos

         * @param bufHeight alto del buffer de datos

         * @param adjustToExtent Flag que dice si el extent solicitado debe ajustarse al extent del raster o no.

         * @param bandList

         * @return Buffer de datos

         */

        public Buffer getWindowRaster(double ulx, double uly, double lrx, double lry, int bufWidth, int bufHeight, boolean adjustToExtent) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException;

        /**

         * Obtiene una ventana de datos de la imagen a partir de coordenadas reales. 

         * No aplica supersampleo ni subsampleo sino que devuelve una matriz de igual tama?o a los

         * pixeles de disco. 

         * @param x Posici?n X superior izquierda

         * @param y Posici?n Y superior izquierda

         * @param w Ancho en coordenadas pixel

         * @param h Alto en coordenadas pixel

         * @param bandList

         * @return Buffer de datos

         */

        public Buffer getWindowRaster(int x, int y, int w, int h) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException;

        /**

         * Obtiene una ventana de datos de la imagen a partir de coordenadas reales. 

         * Aplica supersampleo o subsampleo en funci?n del tama?o del buffer

         * @param x Posici?n X superior izquierda en pixels

         * @param y Posici?n Y superior izquierda en pixels

         * @param w Ancho en pixels

         * @param h Alto en pixels

         * @param bufWidth ancho del buffer de datos

         * @param bufHeight alto del buffer de datos

         * @param bandList

         * @return Buffer de datos

         */

        public Buffer getWindowRaster(int x, int y, int w, int h, int bufWidth, int bufHeight) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException;

        /**

         * Dado unas coordenadas reales, un tama?o de buffer y un tama?o de raster. 

         * Si el buffer es de mayor tama?o que el raster (supersampleo) quiere decir que 

         * por cada pixel de buffer se repiten varios del raster. Esta funci?n calcula el 

         * n?mero de pixels de desplazamiento en X e Y que corresponden al primer pixel del

         * buffer en la esquina superior izquierda. Esto es necesario porque la coordenada

         * solicitada es real y puede no caer sobre un pixel completo. Este calculo es

         * util cuando un cliente quiere supersamplear sobre un buffer y que no se lo haga

         * el driver autom?ticamente.

         * @param dWorldTLX Coordenada real X superior izquierda

         * @param dWorldTLY Coordenada real Y superior izquierda

         * @param nWidth Ancho del raster

         * @param nHeight Alto del raster

         * @param bufWidth Ancho del buffer

         * @param bufHeight Alto del buffer

         * @return Array de cuatro. Los dos primeros elementos son el desplazamiento en X e Y y los dos segundos

         * el tama?o en pixels de buffer de un pixel de la imagen en ancho y alto.  

         */

        public double[] calcSteps(double dWorldTLX, double dWorldTLY, double dWorldBRX, double dWorldBRY,

                        double nWidth, double nHeight, int bufWidth, int bufHeight);

}