AbstractRegionOfInterest (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractIterableRegionOfInterest, AngleRegionOfInterest, BinaryMaskRegionOfInterest, CompositeRegionOfInterest, LineRegionOfInterest

Deprecated.
```
@Deprecated
public abstract class AbstractRegionOfInterest
extends Object
implements RegionOfInterest
```
The AbstractRegionOfInterest implements the IterableRegionOfInterest using a raster function and a membership function that are implemented by a derived class.

Author:

Stephan Saalfeld, Lee Kamentsky, leek

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractRegionOfInterest.AROIRandomAccess` Deprecated. The AROIRandomAccess inner class implements the random access part of the ROI, allowing random sampling of pixel membership in the ROI.

Field Summary

Fields
Modifier and Type Field and Description

protected int nDimensions
Deprecated.

Fields
Modifier and Type	Field and Description
`protected int`	`nDimensions` Deprecated.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractRegionOfInterest(int nDimensions)
Deprecated.

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected abstract 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)
`protected void`	`invalidateCachedState()` Deprecated.
`void`	`move(double[] displacement)` Deprecated.
`int`	`numDimensions()` Deprecated. Gets the space's number of dimensions.
`void`	`realMax(double[] max)` Deprecated. Write the maximum of each dimension into double[].
`double`	`realMax(int d)` Deprecated. Get the maximum in dimension d.
`void`	`realMax(RealPositionable max)` Deprecated. Sets a `RealPositionable` to the maximum of this `Interval`
`void`	`realMin(double[] min)` Deprecated. Write the minimum of each dimension into double[].
`double`	`realMin(int d)` Deprecated. Get the minimum in dimension d.
`void`	`realMin(RealPositionable min)` Deprecated. Sets a `RealPositionable` to the minimum of this `Interval`
`RealRandomAccess<BitType>`	`realRandomAccess()` Deprecated. Create a random access sampler for real coordinates.
`RealRandomAccess<BitType>`	`realRandomAccess(RealInterval interval)` Deprecated. TODO Check if constraining real random access to an interval could be exploited for a more efficient solution.
`protected void`	`validateRealExtremaCache()` Deprecated.

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

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

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

- Field Detail
  - nDimensions
```
protected int nDimensions
```
    Deprecated.
- Constructor Detail
  - AbstractRegionOfInterest
```
protected AbstractRegionOfInterest(int nDimensions)
```
    Deprecated.
- Method Detail
  - getRealExtrema
```
protected abstract 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)
    
    Parameters:
    
    minima -
    
    maxima -
  - validateRealExtremaCache
```
protected void validateRealExtremaCache()
```
    Deprecated.
  - invalidateCachedState
```
protected void invalidateCachedState()
```
    Deprecated.
  - realMin
```
public double realMin(int d)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMin
```
public void realMin(double[] min)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Write the minimum of each dimension into double[].
    
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(RealPositionable min)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the minimum of this Interval
    
    Specified by:
    
    realMin in interface RealInterval
  - realMax
```
public double realMax(int d)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - realMax
```
public void realMax(double[] max)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Write the maximum of each dimension into double[].
    
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(RealPositionable max)
```
    Deprecated.
    
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the maximum of this Interval
    
    Specified by:
    
    realMax in interface RealInterval
  - numDimensions
```
public int numDimensions()
```
    Deprecated.
    
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - realRandomAccess
```
public RealRandomAccess<BitType> realRandomAccess()
```
    Deprecated.
    
    Description copied from interface: RealRandomAccessible
    
    Create a random access sampler for real coordinates.
    
    Specified by:
    
    realRandomAccess in interface RealRandomAccessible<BitType>
    
    Returns:
    
    random access sampler
  - realRandomAccess
```
public RealRandomAccess<BitType> realRandomAccess(RealInterval interval)
```
    Deprecated.
    
    TODO Check if constraining real random access to an interval could be exploited for a more efficient solution.
    
    Specified by:
    
    realRandomAccess in interface RealRandomAccessible<BitType>
  - move
```
public void move(double[] displacement)
```
    Deprecated.
    
    Specified by:
    
    move in interface RegionOfInterest

Class AbstractRegionOfInterest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Field Detail

nDimensions

Constructor Detail

AbstractRegionOfInterest

Method Detail

getRealExtrema

validateRealExtremaCache

invalidateCachedState

realMin

realMin

realMin

realMax

realMax

realMax

numDimensions

realRandomAccess

realRandomAccess

move