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

import java.awt.Color;

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

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

/**

 * Region of interest 

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

 */

public interface ROI {

        public RasterDataStore getStore();

        /**

         * Checks if the rectangle defined in the parameters is inside if the ROI or outside

         */

        public boolean isInside(double x, double y, double w, double h);

        /**

         * Checks if a point in pixel coordinates is inside of this region of interest

         * @return true whether the point is inside

         */

        public boolean isInsideOfPolygon(int x, int y);

        /**

         * Gets the bounding box of this ROI

         * @return

         */

        public Extent getROIExtent();

        public Color getColor();

        public void setColor(Color color);

        public String getName();

        public void setName(String name);

        public long getID();

        public void setID(long id);

//        public ROI add(ROI roi);

//        

//        public ROI intersect(ROI roi);

//        

//        public ROI subtract(ROI roi);

//        

//        public ROI exclusiveOr(ROI roi);

//        

//        public double getAspect(int x, int y)

//                        throws GridException;

//

//        public double getCellSize();

//        

//        /**

//         * Obtiene el valor de una celda de tipo byte. Si el punto no pertenece al

//         * ROI devuelve un valor NoData. La excepci?n ser? lanzada si intentamos 

//         * acceder a un tipo de dato erroneo.

//         * @param x Posici?n X en coordenadas pixel del ROI

//         * @param y Posici?n Y en coordenadas pixel del ROI

//         * @throws RasterBufferInvalidAccessException

//         * @return Valor byte

//         */

//        public byte getCellValueAsByte(int x, int y)

//                        throws GridException;

//

//        /**

//         * Obtiene el valor de una celda de tipo double. Si el punto no pertenece al

//         * ROI devuelve un valor NoData. La excepci?n ser? lanzada si intentamos 

//         * acceder a un tipo de dato erroneo.

//         * @param x Posici?n X en coordenadas pixel del ROI

//         * @param y Posici?n Y en coordenadas pixel del ROI

//         * @throws RasterBufferInvalidAccessException

//         * @return Valor double

//         */

//        public double getCellValueAsDouble(int x, int y)

//                        throws GridException;

//

//        /**

//         * Obtiene el valor de una celda de tipo Float. Si el punto no pertenece al

//         * ROI devuelve un valor NoData. La excepci?n ser? lanzada si intentamos 

//         * acceder a un tipo de dato erroneo.

//         * @param x Posici?n X en coordenadas pixel del ROI

//         * @param y Posici?n Y en coordenadas pixel del ROI

//         * @throws RasterBufferInvalidAccessException

//         * @return Valor Float

//         */

//        public float getCellValueAsFloat(int x, int y)

//                        throws GridException;

//

//        /**

//         * Obtiene el valor de una celda de tipo int. Si el punto no pertenece al

//         * ROI devuelve un valor NoData. La excepci?n ser? lanzada si intentamos 

//         * acceder a un tipo de dato erroneo.

//         * @param x Posici?n X en coordenadas pixel del ROI

//         * @param y Posici?n Y en coordenadas pixel del ROI

//         * @throws RasterBufferInvalidAccessException

//         * @return Valor int

//         */

//        public int getCellValueAsInt(int x, int y)

//                        throws GridException;

//

//        /**

//         * Obtiene el valor de una celda de tipo short. Si el punto no pertenece al

//         * ROI devuelve un valor NoData. La excepci?n ser? lanzada si intentamos 

//         * acceder a un tipo de dato erroneo.

//         * @param x Posici?n X en coordenadas pixel del ROI

//         * @param y Posici?n Y en coordenadas pixel del ROI

//         * @throws RasterBufferInvalidAccessException

//         * @return Valor short

//         */

//        public short getCellValueAsShort(int x, int y)

//                        throws GridException;

//

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

//

//        public int getDirToNextDownslopeCell(int x, int y,boolean bForceDirToNoDataCell)

//                                                                                                        throws GridException;

//

//        public double getDistToNeighborInDir(int iDir);

//

//        public GridExtent getGridExtent();

//

//        public int getLayerNX();

//

//        public int getLayerNY();

//        

//        /**

//         * 

//         * @return n?mero de celdas del ROI.

//         */

//        public long getValues() throws GridException;

//        

//        public double getMaxValue() throws GridException;

//        

//        public double getMeanValue() throws GridException;

//

//        public double getMinValue() throws GridException;

//

//        /**

//        * Devuelve la matriz de varianza-covarianza, si no se encuentra calculada se calcula

//        * @retrun Matriz de varianza-covarianza

//        */

//        public double[][] getVarCovMatrix() throws GridException;

//        

//        public int getNX();

//

//        public int getNY();

//

//        public double getNoDataValue();

//

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

//

//        public GridCell[] getSortedArrayOfCells() throws GridException;

//

//        public double getVariance() throws GridException;

//

//        

//        public boolean isNoDataValue(double dValue);

//

//        public void setInterpolationMethod(int iMethod);

//

//        public Grid getGrid();

//

//        

//        public long getID();

//        

//        public void setID(long id);

//

//        

//        /**

//         *Establece el Subconjunto de bandas que abarca el ROI. 

//         *

//         */

//        public void setBandsSubset(int bandsSubset[]);

//        

//        /**

//         * Restaura el subconjunto accesible por el ROI a todas las bandas del Grid.

//         */

//        public void clearBandsSubset();

//        

//        /**

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

//

//        /**

//         * 

//         * @return N?mero de bandas que abarca el ROI.

//         */

//        public int getBandCount();

//

//        /**

//         * 

//         * @return Subconjunto de bandas que abarca el ROI.

//         */

//        public int[] getBandsSubset();

}