org.jaitools.imageutils
Class ROIGeometry

java.lang.Object
  javax.media.jai.ROI
      org.jaitools.imageutils.ROIGeometry

All Implemented Interfaces:

Serializable

public class ROIGeometry
extends javax.media.jai.ROI

An ROI class backed by a vector object providing precision and the ability to handle massive regions. It has a minimal memory footprint allowing it to be used with massive images.

JAI operations often involve converting ROI objects to images. This class implements its getAsImage() method using the JAITools "VectorBinarize" operator to avoid exhausting available memory when dealing with ROIs that cover massive image areas.

Note that this class can be used to honour floating precision pixel coordinates by setting the useFixedPrecision constructor argument to false. The effect of the default fixed coordinate precision is to provide equivalent behaviour to that of the standard ROIShape, where pixel coordinates are treated as referring to the upper-left pixel corner.

Since:

1.1

Version:

$Id$

Author:

Michael Bedward, Andrea Aime

See Also:

Serialized Form

Field Summary

static boolean	DEFAULT_ROIGEOMETRY_ANTIALISING Default setting for use of anti-aliasing when drawing the reference Geometry during a getAsImage() request.
static boolean	DEFAULT_ROIGEOMETRY_USEFIXEDPRECISION Default setting for use of fixed precision (true).

Constructor Summary

ROIGeometry(com.vividsolutions.jts.geom.Geometry geom)
Constructor which takes a Geometry object to be used as the reference against which to test inclusion of image coordinates.

ROIGeometry(com.vividsolutions.jts.geom.Geometry geom, boolean useFixedPrecision)
Constructor which takes a Geometry object and a boolean value for whether to use fixed coordinate precision (equivalent to working with integer pixel coordinates).

ROIGeometry(com.vividsolutions.jts.geom.Geometry geom, boolean antiAliasing, boolean useFixedPrecision)
Constructors a new ROIGeometry.

ROIGeometry(com.vividsolutions.jts.geom.Geometry geom, boolean antiAliasing, boolean useFixedPrecision, RenderingHints hints)
Fully-specified constructor.

ROIGeometry(com.vividsolutions.jts.geom.Geometry geom, RenderingHints hints)
Builds a new ROIGeometry.

Method Summary

javax.media.jai.ROI	add(javax.media.jai.ROI roi) Returns a new instance which is the union of this ROI and roi.
boolean	contains(double x, double y) Tests if this ROI contains the given image location.
boolean	contains(double x, double y, double w, double h) Tests if this ROI contains the given rectangle.
boolean	contains(int x, int y) Tests if this ROI contains the given image location.
boolean	contains(int x, int y, int w, int h) Tests if this ROI contains the given rectangle.
boolean	contains(Point p) Tests if this ROI contains the given point.
boolean	contains(Point2D p) Tests if this ROI contains the given point.
boolean	contains(Rectangle rect) Tests if this ROI contains the given rectangle.
boolean	contains(Rectangle2D rect) Tests if this ROI contains the given rectangle.
javax.media.jai.ROI	exclusiveOr(javax.media.jai.ROI roi) Returns a new instance which is the exclusive OR of this ROI and roi.
int[][]	getAsBitmask(int x, int y, int width, int height, int[][] mask) This method is not supported.
com.vividsolutions.jts.geom.Geometry	getAsGeometry() Returns the ROI as a JTS Geometry.
javax.media.jai.PlanarImage	getAsImage() Gets an image representation of this ROI using the VectorBinarize operation.
LinkedList	getAsRectangleList(int x, int y, int width, int height) This method is not supported.
protected LinkedList	getAsRectangleList(int x, int y, int width, int height, boolean mergeRectangles) This method is not supported.
Shape	getAsShape() Gets a new Shape representing this ROI.
Rectangle	getBounds() Gets the enclosing rectangle of this ROI.
Rectangle2D	getBounds2D() Gets the enclosing double-precision rectangle of this ROI.
int	getThreshold() This method is not supported.
javax.media.jai.ROI	intersect(javax.media.jai.ROI roi) Returns a new instance which is the intersection of this ROI and roi.
boolean	intersects(double x, double y, double w, double h) Tests if the given rectangle intersects with this ROI.
boolean	intersects(int x, int y, int w, int h) Tests if the given rectangle intersects with this ROI.
boolean	intersects(Rectangle rect) Tests if the given rectangle intersects with this ROI.
boolean	intersects(Rectangle2D rect) Tests if the given rectangle intersects with this ROI.
javax.media.jai.ROI	performImageOp(RenderedImageFactory RIF, ParameterBlock paramBlock, int sourceIndex, RenderingHints renderHints) This method is not supported.
javax.media.jai.ROI	performImageOp(String name, ParameterBlock paramBlock, int sourceIndex, RenderingHints renderHints) This method is not supported.
void	setThreshold(int threshold) This method is not supported.
javax.media.jai.ROI	subtract(javax.media.jai.ROI roi) Returns a new instance which is the difference of this ROI and roi.
javax.media.jai.ROI	transform(AffineTransform at) Returns a new ROI created by applying the given transform to this ROI.
javax.media.jai.ROI	transform(AffineTransform at, javax.media.jai.Interpolation interp) Returns a new ROI created by applying the given transform to this ROI.

Methods inherited from class javax.media.jai.ROI

mergeRunLengthList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROIGEOMETRY_ANTIALISING

public static final boolean DEFAULT_ROIGEOMETRY_ANTIALISING

Default setting for use of anti-aliasing when drawing the reference Geometry during a getAsImage() request. The default value is true which provides behaviour corresponding to that of the standard JAI ROIShape class.

See Also:

Constant Field Values

DEFAULT_ROIGEOMETRY_USEFIXEDPRECISION

public static final boolean DEFAULT_ROIGEOMETRY_USEFIXEDPRECISION

Default setting for use of fixed precision (true).

See Also:

Constant Field Values

Constructor Detail

ROIGeometry

public ROIGeometry(com.vividsolutions.jts.geom.Geometry geom)

Constructor which takes a Geometry object to be used as the reference against which to test inclusion of image coordinates. The argument geom must be either a Polygon or MultiPolygon. The input geometry is copied so subsequent changes to it will not be reflected in the ROIGeometry object.

Parameters:

geom - either a Polygon or MultiPolygon object defining the area(s) of inclusion.

Throws:

IllegalArgumentException - if geom is null or not an instance of either Polygon or MultiPolygon

ROIGeometry

public ROIGeometry(com.vividsolutions.jts.geom.Geometry geom,
                   boolean useFixedPrecision)

Constructor which takes a Geometry object and a boolean value for whether to use fixed coordinate precision (equivalent to working with integer pixel coordinates). The argument geom must be either a Polygon or MultiPolygon. The input geometry is copied so subsequent changes to it will not be reflected in the ROIGeometry object.

Parameters:

geom - either a Polygon or MultiPolygon object defining the area(s) of inclusion.

useFixedPrecision - whether to use fixed precision when comparing pixel coordinates to the reference geometry

Throws:

IllegalArgumentException - if geom is null or not an instance of either Polygon or MultiPolygon

ROIGeometry

public ROIGeometry(com.vividsolutions.jts.geom.Geometry geom,
                   boolean antiAliasing,
                   boolean useFixedPrecision)

Constructors a new ROIGeometry. The argument geom must be either a Polygon or MultiPolygon. The input geometry is copied so subsequent changes to it will not be reflected in the ROIGeometry object.

Parameters:

geom - either a Polygon or MultiPolygon object defining the area(s) of inclusion.

antiAliasing - whether to use anti-aliasing when converting this ROI to an image

useFixedPrecision - whether to use fixed precision when comparing pixel coordinates to the reference geometry

Throws:

IllegalArgumentException - if geom is null or not an instance of either Polygon or MultiPolygon

ROIGeometry

public ROIGeometry(com.vividsolutions.jts.geom.Geometry geom,
                   RenderingHints hints)

Builds a new ROIGeometry. The argument geom must be either a Polygon or MultiPolygon. The input geometry is copied so subsequent changes to it will not be reflected in the ROIGeometry object.

Parameters:

geom - either a Polygon or MultiPolygon object defining the area(s) of inclusion.

hints - The JAI hints to be used when generating the raster equivalent of this ROI

Throws:

IllegalArgumentException - if geom is null or not an instance of either Polygon or MultiPolygon

ROIGeometry

public ROIGeometry(com.vividsolutions.jts.geom.Geometry geom,
                   boolean antiAliasing,
                   boolean useFixedPrecision,
                   RenderingHints hints)

Fully-specified constructor. The argument geom must be either a Polygon or MultiPolygon. The input geometry is copied so subsequent changes to it will not be reflected in the ROIGeometry object.

Parameters:

geom - either a Polygon or MultiPolygon object defining the area(s) of inclusion.

antiAliasing - whether to use anti-aliasing when converting this ROI to an image

useFixedPrecision - whether to use fixed precision when comparing pixel coordinates to the reference geometry

hints - The JAI hints to be used when generating the raster equivalent of this ROI

Throws:

IllegalArgumentException - if geom is null or not an instance of either Polygon or MultiPolygon

Method Detail

add

public javax.media.jai.ROI add(javax.media.jai.ROI roi)

Returns a new instance which is the union of this ROI and roi. This is only possible if roi is an instance of ROIGeometry or ROIShape.

Overrides:

add in class javax.media.jai.ROI

Parameters:

roi - the ROI to add

Returns:

the union as a new instance

Throws:

UnsupportedOperationException - if roi is not an instance of ROIGeometry or ROIShape

contains

public boolean contains(Point p)

Tests if this ROI contains the given point.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

p - the point

Returns:

true if the point is within this ROI; false otherwise

contains

public boolean contains(Point2D p)

Tests if this ROI contains the given point.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

p - the point

Returns:

true if the point is within this ROI; false otherwise

contains

public boolean contains(int x,
                        int y)

Tests if this ROI contains the given image location.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

x - location X ordinate

y - location Y ordinate

Returns:

true if the location is within this ROI; false otherwise

contains

public boolean contains(double x,
                        double y)

Tests if this ROI contains the given image location.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

x - location X ordinate

y - location Y ordinate

Returns:

true if the location is within this ROI; false otherwise

contains

public boolean contains(Rectangle rect)

Tests if this ROI contains the given rectangle.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

rect - the rectangle

Returns:

true if the rectangle is within this ROI; false otherwise

contains

public boolean contains(Rectangle2D rect)

Tests if this ROI contains the given rectangle.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

rect - the rectangle

Returns:

true if the rectangle is within this ROI; false otherwise

contains

public boolean contains(int x,
                        int y,
                        int w,
                        int h)

Tests if this ROI contains the given rectangle.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

x - rectangle origin X ordinate

y - rectangle origin Y ordinate

w - rectangle width

h - rectangle height

Returns:

true if the rectangle is within this ROI; false otherwise

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)

Tests if this ROI contains the given rectangle.

Overrides:

contains in class javax.media.jai.ROI

Parameters:

x - rectangle origin X ordinate

y - rectangle origin Y ordinate

w - rectangle width

h - rectangle height

Returns:

true if the rectangle is within this ROI; false otherwise

exclusiveOr

public javax.media.jai.ROI exclusiveOr(javax.media.jai.ROI roi)

Returns a new instance which is the exclusive OR of this ROI and roi. This is only possible if roi is an instance of ROIGeometry or ROIShape.

Overrides:

exclusiveOr in class javax.media.jai.ROI

Parameters:

roi - the ROI to add

Returns:

the union as a new instance

Throws:

UnsupportedOperationException - if roi is not an instance of ROIGeometry or ROIShape

getAsBitmask

public int[][] getAsBitmask(int x,
                            int y,
                            int width,
                            int height,
                            int[][] mask)

This method is not supported.

Overrides:

getAsBitmask in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

getAsImage

public javax.media.jai.PlanarImage getAsImage()

Gets an image representation of this ROI using the VectorBinarize operation. For an ROI with very large bounds but simple shape(s) the resulting image has a small memory footprint.

Overrides:

getAsImage in class javax.media.jai.ROI

Returns:

a new image representing this ROI

See Also:

VectorBinarizeDescriptor

getAsRectangleList

public LinkedList getAsRectangleList(int x,
                                     int y,
                                     int width,
                                     int height)

This method is not supported.

Overrides:

getAsRectangleList in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

getAsRectangleList

protected LinkedList getAsRectangleList(int x,
                                        int y,
                                        int width,
                                        int height,
                                        boolean mergeRectangles)

This method is not supported.

Overrides:

getAsRectangleList in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

getAsShape

public Shape getAsShape()

Gets a new Shape representing this ROI.

Overrides:

getAsShape in class javax.media.jai.ROI

Returns:

the shape

getAsGeometry

public com.vividsolutions.jts.geom.Geometry getAsGeometry()

Returns the ROI as a JTS Geometry.

Returns:

the geometry

getBounds

public Rectangle getBounds()

Gets the enclosing rectangle of this ROI.

Overrides:

getBounds in class javax.media.jai.ROI

Returns:

a new rectangle

getBounds2D

public Rectangle2D getBounds2D()

Gets the enclosing double-precision rectangle of this ROI.

Overrides:

getBounds2D in class javax.media.jai.ROI

Returns:

a new rectangle

getThreshold

public int getThreshold()

This method is not supported.

Overrides:

getThreshold in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

intersect

public javax.media.jai.ROI intersect(javax.media.jai.ROI roi)

Returns a new instance which is the intersection of this ROI and roi. This is only possible if roi is an instance of ROIGeometry or ROIShape.

Overrides:

intersect in class javax.media.jai.ROI

Parameters:

roi - the ROI to intersect with

Returns:

the intersection as a new instance

Throws:

UnsupportedOperationException - if roi is not an instance of ROIGeometry or ROIShape

intersects

public boolean intersects(Rectangle rect)

Tests if the given rectangle intersects with this ROI.

Overrides:

intersects in class javax.media.jai.ROI

Parameters:

rect - the rectangle

Returns:

true if there is an intersection; false otherwise

intersects

public boolean intersects(Rectangle2D rect)

Tests if the given rectangle intersects with this ROI.

Overrides:

intersects in class javax.media.jai.ROI

Parameters:

rect - the rectangle

Returns:

true if there is an intersection; false otherwise

intersects

public boolean intersects(int x,
                          int y,
                          int w,
                          int h)

Tests if the given rectangle intersects with this ROI.

Overrides:

intersects in class javax.media.jai.ROI

Parameters:

x - rectangle origin X ordinate

y - rectangle origin Y ordinate

w - rectangle width

h - rectangle height

Returns:

true if there is an intersection; false otherwise

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)

Tests if the given rectangle intersects with this ROI.

Overrides:

intersects in class javax.media.jai.ROI

Parameters:

x - rectangle origin X ordinate

y - rectangle origin Y ordinate

w - rectangle width

h - rectangle height

Returns:

true if there is an intersection; false otherwise

performImageOp

public javax.media.jai.ROI performImageOp(RenderedImageFactory RIF,
                                          ParameterBlock paramBlock,
                                          int sourceIndex,
                                          RenderingHints renderHints)

This method is not supported.

Overrides:

performImageOp in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

performImageOp

public javax.media.jai.ROI performImageOp(String name,
                                          ParameterBlock paramBlock,
                                          int sourceIndex,
                                          RenderingHints renderHints)

This method is not supported.

Overrides:

performImageOp in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

setThreshold

public void setThreshold(int threshold)

This method is not supported.

Overrides:

setThreshold in class javax.media.jai.ROI

Throws:

UnsupportedOperationException - if called

subtract

public javax.media.jai.ROI subtract(javax.media.jai.ROI roi)

Returns a new instance which is the difference of this ROI and roi. This is only possible if roi is an instance of ROIGeometry or ROIShape.

Overrides:

subtract in class javax.media.jai.ROI

Parameters:

roi - the ROI to add

Returns:

the union as a new instance

Throws:

UnsupportedOperationException - if roi is not an instance of ROIGeometry or ROIShape

transform

public javax.media.jai.ROI transform(AffineTransform at,
                                     javax.media.jai.Interpolation interp)

Returns a new ROI created by applying the given transform to this ROI.

Overrides:

transform in class javax.media.jai.ROI

Parameters:

at - the transform

interp - ignored

Returns:

the new ROI

transform

public javax.media.jai.ROI transform(AffineTransform at)

Returns a new ROI created by applying the given transform to this ROI.

Overrides:

transform in class javax.media.jai.ROI

Parameters:

at - the transform

Returns:

the new ROI