AbstractROI

java.lang.Object
- org.gvsig.raster.roi.AbstractROI

All Implemented Interfaces:

ROI

Direct Known Subclasses:

RasterROI, VectorialROIImpl
```
public abstract class AbstractROI
extends java.lang.Object
implements ROI
```
Clase que representa las Regiones de Interes.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PERSISTENT_DESCRIPTION`
`static java.lang.String`	`PERSISTENT_NAME`
`protected Extent`	`roiExtent` Mínimo extent que contiene al ROI.
`protected Statistics`	`statistic`
`protected int`	`xOffset` Coord. x del grid donde está laz esquina sup. iz. del roi (coords. pixel).
`protected int`	`yOffset` Coord. y del grid donde está la esquina sup. iz. del roi (coords. pixel).

Constructor Summary

Constructors
Constructor and Description

AbstractROI(RasterDataStore store)

Constructors
Constructor and Description
`AbstractROI(RasterDataStore store)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ROI`	`add(ROI roi)`
`void`	`clearBandsSubset()` Restaura el subconjunto accesible por el ROI a todas las bandas del Grid.
`ROI`	`exclusiveOr(ROI roi)`
`int`	`getBandCount()`
`int[]`	`getBandsSubset()`
`double`	`getCellSize()`
`java.awt.Color`	`getColor()`
`long`	`getID()`
`int`	`getLayerHeight()`
`int`	`getLayerWidth()`
`double`	`getMaxValue()`
`double`	`getMeanValue()`
`double`	`getMinValue()`
`java.lang.String`	`getName()`
`double`	`getNoDataValue()`
`Extent`	`getROIExtent()` Gets the bounding box of this ROI
`int`	`getROIPxHeight()`
`int`	`getROIPxWidth()`
`static Extent`	`getROIsMaximunExtent(java.util.List<ROI> rois)` Obtiene el extent máximo de todas las ROIs pasadas por parámetro.
`protected Statistics`	`getStatistic()`
`RasterDataStore`	`getStore()`
`Extent`	`getStoreExtent()`
`long`	`getValues()`
`double[][]`	`getVarCovMatrix()` Devuelve la matriz de varianza-covarianza, si no se encuentra calculada se calcula
`double`	`getVariance()`
`ROI`	`intersect(ROI roi)`
`abstract boolean`	`isInside(double x, double y, double w, double h)` Checks if a rectangle in pixel coordinates intersects with some geometry of this ROI
`abstract boolean`	`isInsideOfPolygon(int x, int y)` Checks if a point in pixel coordinates which is inside the grid, belongs to a geometry
`void`	`loadFromState(PersistentState state)` Deprecated. The regions of interest should not be persisted
`static void`	`registerPersistence()` Deprecated. The regions of interest should not be persisted
`void`	`saveToState(PersistentState state)` Deprecated. The regions of interest should not be persisted
`void`	`setBandsSubset(int[] bandsSubset)` Establece el Subconjunto de bandas que abarca el ROI.
`void`	`setColor(java.awt.Color color)`
`void`	`setID(long id)`
`void`	`setName(java.lang.String name)`
`ROI`	`subtract(ROI roi)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PERSISTENT_NAME
```
public static final java.lang.String PERSISTENT_NAME
```
    See Also:
    
    Constant Field Values
  - PERSISTENT_DESCRIPTION
```
public static final java.lang.String PERSISTENT_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - statistic
```
protected Statistics statistic
```
  - roiExtent
```
protected Extent roiExtent
```
    Mínimo extent que contiene al ROI.
  - xOffset
```
protected int xOffset
```
    Coord. x del grid donde está laz esquina sup. iz. del roi (coords. pixel).
  - yOffset
```
protected int yOffset
```
    Coord. y del grid donde está la esquina sup. iz. del roi (coords. pixel).
- Constructor Detail
  - AbstractROI
```
public AbstractROI(RasterDataStore store)
```
- Method Detail
  - getStore
```
public RasterDataStore getStore()
```
    Specified by:
    
    getStore in interface ROI
  - getROIsMaximunExtent
```
public static Extent getROIsMaximunExtent(java.util.List<ROI> rois)
```
    Obtiene el extent máximo de todas las ROIs pasadas por parámetro.
    
    Parameters:
    
    rois - Lista de ROIs para calcular la extensión máxima que ocupan
    
    Returns:
    
    Entent máximo
  - add
```
public ROI add(ROI roi)
```
  - intersect
```
public ROI intersect(ROI roi)
```
  - subtract
```
public ROI subtract(ROI roi)
```
  - exclusiveOr
```
public ROI exclusiveOr(ROI roi)
```
  - getCellSize
```
public double getCellSize()
```
  - getROIExtent
```
public Extent getROIExtent()
```
    Description copied from interface: ROI
    
    Gets the bounding box of this ROI
    
    Specified by:
    
    getROIExtent in interface ROI
    
    Returns:
  - getStoreExtent
```
public Extent getStoreExtent()
```
  - getLayerWidth
```
public int getLayerWidth()
```
  - getLayerHeight
```
public int getLayerHeight()
```
  - getValues
```
public long getValues()
               throws GridException
```
    Returns:
    
    número de celdas del ROI.
    
    Throws:
    
    GridException
  - getMaxValue
```
public double getMaxValue()
                   throws GridException
```
    Throws:
    
    GridException
  - getMeanValue
```
public double getMeanValue()
                    throws GridException
```
    Throws:
    
    GridException
  - getMinValue
```
public double getMinValue()
                   throws GridException
```
    Throws:
    
    GridException
  - getVarCovMatrix
```
public double[][] getVarCovMatrix()
                           throws GridException
```
    Devuelve la matriz de varianza-covarianza, si no se encuentra calculada se calcula
    
    Throws:
    
    GridException
  - getROIPxWidth
```
public int getROIPxWidth()
```
  - getROIPxHeight
```
public int getROIPxHeight()
```
  - getNoDataValue
```
public double getNoDataValue()
```
  - getVariance
```
public double getVariance()
                   throws GridException
```
    Throws:
    
    GridException
  - isInsideOfPolygon
```
public abstract boolean isInsideOfPolygon(int x,
                                          int y)
```
    Checks if a point in pixel coordinates which is inside the grid, belongs to a geometry
    
    Specified by:
    
    isInsideOfPolygon in interface ROI
    
    Parameters:
    
    x - X coordinate
    
    y - Y coordinate
    
    Returns:
    
    true is inside of a geometry
  - isInside
```
public abstract boolean isInside(double x,
                                 double y,
                                 double w,
                                 double h)
```
    Checks if a rectangle in pixel coordinates intersects with some geometry of this ROI
    
    Specified by:
    
    isInside in interface ROI
    
    Parameters:
    
    x - X upper left coordinate
    
    y - Y upper left coordinate
    
    w - Width of the area in pixels
    
    h - Height of the area in pixels
    
    Returns:
    
    true is inside of a geometry
  - getColor
```
public java.awt.Color getColor()
```
    Specified by:
    
    getColor in interface ROI
  - setColor
```
public void setColor(java.awt.Color color)
```
    Specified by:
    
    setColor in interface ROI
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface ROI
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface ROI
  - getID
```
public long getID()
```
    Specified by:
    
    getID in interface ROI
  - setID
```
public void setID(long id)
```
    Specified by:
    
    setID in interface ROI
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setBandsSubset
```
public void setBandsSubset(int[] bandsSubset)
```
    Establece el Subconjunto de bandas que abarca el ROI.
  - clearBandsSubset
```
public void clearBandsSubset()
```
    Restaura el subconjunto accesible por el ROI a todas las bandas del Grid.
  - getBandCount
```
public int getBandCount()
```
    Returns:
    
    Número de bandas que abarca el ROI.
  - getBandsSubset
```
public int[] getBandsSubset()
```
    Returns:
    
    Subconjunto de bandas que abarca el ROI.
  - getStatistic
```
protected Statistics getStatistic()
```
  - loadFromState
```
public void loadFromState(PersistentState state)
                   throws PersistenceException
```
    Deprecated. The regions of interest should not be persisted
    
    Throws:
    
    PersistenceException
  - saveToState
```
public void saveToState(PersistentState state)
                 throws PersistenceException
```
    Deprecated. The regions of interest should not be persisted
    
    Throws:
    
    PersistenceException
  - registerPersistence
```
public static void registerPersistence()
```
    Deprecated. The regions of interest should not be persisted

Class AbstractROI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERSISTENT_NAME

PERSISTENT_DESCRIPTION

statistic

roiExtent

xOffset

yOffset

Constructor Detail

AbstractROI

Method Detail

getStore

getROIsMaximunExtent

add

intersect

subtract

exclusiveOr

getCellSize

getROIExtent

getStoreExtent

getLayerWidth

getLayerHeight

getValues

getMaxValue

getMeanValue

getMinValue

getVarCovMatrix

getROIPxWidth

getROIPxHeight

getNoDataValue

getVariance

isInsideOfPolygon

isInside

getColor

setColor

getName

setName

getID

setID

toString

setBandsSubset

clearBandsSubset

getBandCount

getBandsSubset

getStatistic

loadFromState

saveToState

registerPersistence