Constructor Detail

• RectangleRegionOfInterest

  public RectangleRegionOfInterest(double[] origin,
                                   double[] extent)

  Deprecated. 

Method Detail

• getOrigin

  public void getOrigin(RealPositionable ptOrigin)

  Deprecated. 
  Write the position into a RealPositionable

  Parameters:

  ptOrigin - write the origin position to this RealPositionable

• getOrigin

  public void getOrigin(double[] org)

  Deprecated. 
  Write the origin position to this array

  Parameters:

  org - write position here

• getOrigin

  public double getOrigin(int d)

  Deprecated. 
  Get one component of the origin position

  Parameters:

  d - the dimension to retrieve

  Returns:

  the position of the origin along the given dimension

• setOrigin

  public void setOrigin(RealLocalizable ptOrigin)

  Deprecated. 
  Set the origin using a point. Updating the origin will move the rectangle without changing its size.

  Parameters:

  ptOrigin - - new origin. This should define the minima of the rectangle

• setOrigin

  public void setOrigin(double[] origin)

  Deprecated. 
  Set the origin using a double array of coordinates. Updating the origin will move the rectangle without changing its size.

  Parameters:

  origin - the coordinates of the minima of the rectangle

• setOrigin

  public void setOrigin(double origin,
                        int d)

  Deprecated. 
  Set the origin for a particular coordinate

  Parameters:

  origin - new value of the minimum of the rectangle at the given coordinate

  d - zero-based index of the dimension to be affected

• setExtent

  public void setExtent(double[] extent)

  Deprecated. 
  Set the extent of the rectangle. Setting the extent will change the rectangle's size while maintaining the position of the origin.

  Parameters:

  extent - the extent (width, height, depth, duration, etc) of the rectangle

• setExtent

  public void setExtent(double extent,
                        int d)

  Deprecated. 
  Set the extent for a single dimension

  Parameters:

  extent -

  d -

• getExtent

  public void getExtent(RealPositionable p)

  Deprecated. 
  Write the extent into a RealPositionable

  Parameters:

  p - - RealPositionable that will hold the extent

• getExtent

  public void getExtent(double[] ext)

  Deprecated. 
  Copy the extents of the rectangle into the array provided

  Parameters:

  ext - on output, the extent of the rectangle

• getExtent

  public double getExtent(int d)

  Deprecated. 
  Get the extent of the rectangle in one dimension

  Parameters:

  d - dimension in question

  Returns:

  extent (eg. width, height) of rectangle in given dimension

• nextRaster

  protected boolean nextRaster(long[] position,
                               long[] end)

  Deprecated. 
  Description copied from class: AbstractIterableRegionOfInterest
  Advance the position to the next raster. The AbstractRegionOfInterest successively adds one to the lowest dimension of the position until the position is outside the ROI as determined by isMember. At this point, it calls nextRaster to find the start of the next raster. As an example, a rectangle might have x, y, width and height. The code would determine if the y position was before, within or after the rectangle bounds. If before, set position[0] = x, position[1] = y and return true, if within, set position[0] = x, position[1] += 1, if after, return false.

  Specified by:

  nextRaster in class AbstractIterableRegionOfInterest

  Parameters:

  position - on entry, the position of the raster after advancement to its end (or initial or final position)

  end - on exit, the coordinates of the end of the raster. Index 0 is generally the only pertinent variable, subsequent indices should be duplicates of the start raster. Nevertheless, using an array lets the caller pass the results as a modification of the array.

  Returns:

  true if there is a raster after this one.

• contains

  public boolean contains(double[] position)

  Deprecated. 
  Description copied from interface: RegionOfInterest
  Determine whether a point is a member of the region of interest

  Parameters:

  position - position in question

  Returns:

  true if a member

• size

  protected long size()

  Deprecated. 
  Description copied from class: AbstractIterableRegionOfInterest
  Return the # of elements available from a cursor over the ROI. The default method acquires successive rasters using nextRaster to get a sum of pixels. The implementer should consider overriding this to provide a more efficient implementation.

  Overrides:

  size in class AbstractIterableRegionOfInterest

• getExtrema

  protected void getExtrema(long[] minima,
                            long[] maxima)

  Deprecated. 
  Description copied from class: AbstractIterableRegionOfInterest
  Get the minimum and maximum corners of a bounding hypercube around all points in the ROI. The implementer should strongly consider implementing this to provide a more efficient implementation.

  Overrides:

  getExtrema in class AbstractIterableRegionOfInterest

  Parameters:

  minima - - minimum coordinates of the ROI

  maxima - - maximum coordinates of the ROI

• getRealExtrema

  protected void getRealExtrema(double[] minima,
                                double[] maxima)

  Deprecated. 
  Description copied from class: AbstractIterableRegionOfInterest
  Get the minimum and maximum corners of a bounding hypercube using real coordinates (which might have fractional components) The implementer should only override this if the ROI is described in real coordinates. Otherwise, the pixel extrema are used.

  Overrides:

  getRealExtrema in class AbstractIterableRegionOfInterest

• move

  public void move(double displacement,
                   int d)

  Deprecated.