AbstractIterableRegionOfInterest (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.AbstractRegionOfInterest
- - net.imglib2.roi.AbstractIterableRegionOfInterest

All Implemented Interfaces:

EuclideanSpace, RealInterval, RealRandomAccessible<BitType>, RealRandomAccessibleRealInterval<BitType>, IterableRegionOfInterest, RegionOfInterest

Direct Known Subclasses:

EllipseRegionOfInterest, GeneralPathRegionOfInterest, PolygonRegionOfInterest, RectangleRegionOfInterest

Deprecated.
```
@Deprecated
public abstract class AbstractIterableRegionOfInterest
extends AbstractRegionOfInterest
implements IterableRegionOfInterest
```
TODO

Author:

Stephan Saalfeld

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractIterableRegionOfInterest.AROIClippedIterableInterval<T extends Type<T>>` Deprecated.
`protected class`	`AbstractIterableRegionOfInterest.AROIIterableInterval<T extends Type<T>>` Deprecated.
`protected class`	`AbstractIterableRegionOfInterest.AROIIterationOrder` Deprecated.

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest
AbstractRegionOfInterest.AROIRandomAccess

Field Summary
- Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest
  nDimensions

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractIterableRegionOfInterest(int nDimensions)
Deprecated.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractIterableRegionOfInterest(int nDimensions)` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected long`	`dimension(int d)` Deprecated.
`protected void`	`dimensions(long[] d)` Deprecated.
`protected long`	`getCachedSize()` Deprecated.
`protected void`	`getExtrema(long[] minima, long[] maxima)` Deprecated. Get the minimum and maximum corners of a bounding hypercube around all points in the ROI.
`<T extends Type<T>> IterableInterval<T>`	`getIterableIntervalOverROI(RandomAccessible<T> src)` Deprecated. Given a sampler in the ROI's space, provide an iterable that can make iterators over the space, sampling pixels from the sampler.
`protected void`	`getRealExtrema(double[] minima, double[] maxima)` Deprecated. 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.
`protected void`	`invalidateCachedState()` Deprecated.
`protected boolean`	`jumpFwd(long totalSteps, long[] position, long[] end, Interval interval)` Deprecated. Jump forward a certain number of steps from the given position.
`protected long`	`max(int d)` Deprecated.
`protected void`	`max(long[] max)` Deprecated.
`protected void`	`max(Positionable max)` Deprecated.
`protected long`	`min(int d)` Deprecated.
`protected void`	`min(long[] min)` Deprecated.
`protected void`	`min(Positionable min)` Deprecated.
`protected abstract boolean`	`nextRaster(long[] position, long[] end)` Deprecated. Advance the position to the next raster.
`protected boolean`	`nextRaster(long[] position, long[] end, Interval interval)` Deprecated. Advance the position to the next raster, taking care that the raster is wholly within the given interval.
`protected void`	`remove(long[] position)` Deprecated. Remove a pixel from a ROI if possible.
`protected long`	`size()` Deprecated. Return the # of elements available from a cursor over the ROI.

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest
move, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin, realRandomAccess, realRandomAccess, validateRealExtremaCache

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

Methods inherited from interface net.imglib2.roi.RegionOfInterest
contains, move, move

Methods inherited from interface net.imglib2.RealRandomAccessible
getAt, getAt, getAt, realRandomAccess, realRandomAccess

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Constructor Detail
  - AbstractIterableRegionOfInterest
```
protected AbstractIterableRegionOfInterest(int nDimensions)
```
    Deprecated.
- Method Detail
  - nextRaster
```
protected abstract boolean nextRaster(long[] position,
                                      long[] end)
```
    Deprecated.
    
    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.
    
    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.
  - nextRaster
```
protected boolean nextRaster(long[] position,
                             long[] end,
                             Interval interval)
```
    Deprecated.
    
    Advance the position to the next raster, taking care that the raster is wholly within the given interval. Consider overriding if knowing the interval can be used to skip rasters outside of the interval.
    
    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.
    
    interval - the raster must be within this interval.
    
    Returns:
    
    true if there is a raster after this one.
  - jumpFwd
```
protected boolean jumpFwd(long totalSteps,
                          long[] position,
                          long[] end,
                          Interval interval)
```
    Deprecated.
    
    Jump forward a certain number of steps from the given position. The implementer may want to override this function. For instance, for a rectangle, the implementer may want to advance the position by the number of steps if the number of steps is less than x - width or perform a more complicated operation involving division by the width if the number of steps is greater.
    
    Parameters:
    
    totalSteps - - number of steps to move
    
    position - - the internal position which should be advanced by the number of steps
    
    end - - the end position of the current raster on entry and on exit.
    
    interval - - constraining interval. Pixels will only be counted while jumping for the region within the interval. If interval is null, there is no constraining interval.
    
    Returns:
    
    true if taking that number of steps still lands within the ROI.
  - getIterableIntervalOverROI
```
public <T extends Type<T>> IterableInterval<T> getIterableIntervalOverROI(RandomAccessible<T> src)
```
    Deprecated.
    
    Description copied from interface: IterableRegionOfInterest
    
    Given a sampler in the ROI's space, provide an iterable that can make iterators over the space, sampling pixels from the sampler. You can then use these cursors to get at all of the pixels in the ROI.
    
    Specified by:
    
    getIterableIntervalOverROI in interface IterableRegionOfInterest
    
    Parameters:
    
    src - - a RandomAccessible that can generate RandomAccess objects. The cursors that IterableInterval generates will use "src" to generate a RandomAccess to sample the space.
  - size
```
protected long size()
```
    Deprecated.
    
    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.
  - getExtrema
```
protected void getExtrema(long[] minima,
                          long[] maxima)
```
    Deprecated.
    
    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.
    
    Parameters:
    
    minima - - minimum coordinates of the ROI
    
    maxima - - maximum coordinates of the ROI
  - invalidateCachedState
```
protected void invalidateCachedState()
```
    Deprecated.
    
    Overrides:
    
    invalidateCachedState in class AbstractRegionOfInterest
  - getRealExtrema
```
protected void getRealExtrema(double[] minima,
                              double[] maxima)
```
    Deprecated.
    
    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.
    
    Specified by:
    
    getRealExtrema in class AbstractRegionOfInterest
    
    Parameters:
    
    minima -
    
    maxima -
  - remove
```
protected void remove(long[] position)
```
    Deprecated.
    
    Remove a pixel from a ROI if possible. The implementer can override this to add a removal behavior to their ROI, for instance, turning off a mask bit at the indicated position.
    
    Parameters:
    
    position - - position that should be removed from the ROI.
  - getCachedSize
```
protected long getCachedSize()
```
    Deprecated.
  - dimension
```
protected long dimension(int d)
```
    Deprecated.
  - dimensions
```
protected void dimensions(long[] d)
```
    Deprecated.
  - max
```
protected void max(long[] max)
```
    Deprecated.
  - max
```
protected void max(Positionable max)
```
    Deprecated.
  - max
```
protected long max(int d)
```
    Deprecated.
  - min
```
protected void min(long[] min)
```
    Deprecated.
  - min
```
protected void min(Positionable min)
```
    Deprecated.
  - min
```
protected long min(int d)
```
    Deprecated.

Class AbstractIterableRegionOfInterest

Nested Class Summary

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest

Field Summary

Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.roi.RegionOfInterest

Methods inherited from interface net.imglib2.RealRandomAccessible

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.EuclideanSpace

Constructor Detail

AbstractIterableRegionOfInterest

Method Detail

nextRaster

nextRaster

jumpFwd

getIterableIntervalOverROI

size

getExtrema

invalidateCachedState

getRealExtrema

remove

getCachedSize

dimension

dimensions

max

max

max

min

min

min