AbstractRegionOfInterest.AROIRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

EuclideanSpace, Positionable, RealLocalizable, RealPositionable, RealRandomAccess<BitType>, Sampler<BitType>

Enclosing class:

AbstractRegionOfInterest
```
protected class AbstractRegionOfInterest.AROIRandomAccess
extends Object
implements RealRandomAccess<BitType>
```
The AROIRandomAccess inner class implements the random access part of the ROI, allowing random sampling of pixel membership in the ROI.

Constructor Summary

Constructors
Modifier Constructor and Description

AROIRandomAccess()

protected AROIRandomAccess(AbstractRegionOfInterest.AROIRandomAccess randomAccess)

Constructors
Modifier	Constructor and Description
	`AROIRandomAccess()`
`protected`	`AROIRandomAccess(AbstractRegionOfInterest.AROIRandomAccess randomAccess)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int dim)` Move by -1 in one dimension.
`AbstractRegionOfInterest.AROIRandomAccess`	`copy()`
`AbstractRegionOfInterest.AROIRandomAccess`	`copyRealRandomAccess()`
`void`	`fwd(int dim)` Move by 1 in one dimension.
`BitType`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`double`	`getDoublePosition(int dim)` Return the current position in a given dimension.
`float`	`getFloatPosition(int dim)` Return the current position in a given dimension.
`void`	`localize(double[] pos)` Write the current position into the passed array.
`void`	`localize(float[] pos)` Write the current position into the passed array.
`void`	`move(double[] pos)` Move the element relative to its current location using a float[] as distance vector.
`void`	`move(double distance, int dim)` Move the element in one dimension for some distance.
`void`	`move(float[] pos)` Move the element relative to its current location using a float[] as distance vector.
`void`	`move(float distance, int dim)` Move the element in one dimension for some distance.
`void`	`move(int[] pos)` Move the element relative to its current location using an int[] as distance vector.
`void`	`move(int distance, int dim)` Move the element in one dimension for some distance.
`void`	`move(Localizable localizable)` Move the element relative to its current location using an `Localizable` as distance vector.
`void`	`move(long[] pos)` Move the element relative to its current location using a long[] as distance vector.
`void`	`move(long distance, int dim)` Move the element in one dimension for some distance.
`void`	`move(RealLocalizable localizable)` Move the element relative to its current location using a `RealLocalizable` as distance vector.
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`setPosition(double[] position)` Set the position of the element.
`void`	`setPosition(double position, int dim)` Set the position of the element for one dimension.
`void`	`setPosition(float[] position)` Set the position of the element.
`void`	`setPosition(float position, int dim)` Set the position of the element for one dimension.
`void`	`setPosition(int[] position)` Set the position of the element.
`void`	`setPosition(int position, int dim)` Set the position of the element for one dimension.
`void`	`setPosition(Localizable localizable)` Place the element at the same location as a given `Localizable`
`void`	`setPosition(long[] position)` Set the position of the element.
`void`	`setPosition(long position, int dim)` Set the position of the element for one dimension.
`void`	`setPosition(RealLocalizable localizable)` Place the element at the same location as a given `RealLocalizable`
`protected void`	`updateCachedMembershipStatus()`

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

Methods inherited from interface net.imglib2.RealRandomAccess
setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

- Constructor Detail
  - AROIRandomAccess
```
protected AROIRandomAccess(AbstractRegionOfInterest.AROIRandomAccess randomAccess)
```
  - AROIRandomAccess
```
public AROIRandomAccess()
```
- Method Detail
  - localize
```
public void localize(float[] pos)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    pos - receives current position
  - localize
```
public void localize(double[] pos)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    pos - receives current position
  - getFloatPosition
```
public float getFloatPosition(int dim)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    dim - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int dim)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    dim - dimension
    
    Returns:
    
    dimension of current position
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - move
```
public void move(float distance,
                 int dim)
```
    Description copied from interface: RealPositionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface RealPositionable
  - move
```
public void move(double distance,
                 int dim)
```
    Description copied from interface: RealPositionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface RealPositionable
  - move
```
public void move(int distance,
                 int dim)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    dim - dimension
  - move
```
public void move(long distance,
                 int dim)
```
    Description copied from interface: Positionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    distance - relative offset in dimension d
    
    dim - dimension
  - move
```
public void move(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a RealLocalizable as distance vector.
    
    Specified by:
    
    move in interface RealPositionable
    
    Parameters:
    
    localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an Localizable as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(float[] pos)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a float[] as distance vector.
    
    Specified by:
    
    move in interface RealPositionable
  - move
```
public void move(double[] pos)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a float[] as distance vector.
    
    Specified by:
    
    move in interface RealPositionable
  - move
```
public void move(int[] pos)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using an int[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    pos - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(long[] pos)
```
    Description copied from interface: Positionable
    
    Move the element relative to its current location using a long[] as distance vector.
    
    Specified by:
    
    move in interface Positionable
    
    Parameters:
    
    pos - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Place the element at the same location as a given RealLocalizable
    
    Specified by:
    
    setPosition in interface RealPositionable
    
    Parameters:
    
    localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Description copied from interface: Positionable
    
    Place the element at the same location as a given Localizable
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(float[] position)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface RealPositionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(double[] position)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface RealPositionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(int[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(long[] position)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(float position,
                        int dim)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface RealPositionable
  - setPosition
```
public void setPosition(double position,
                        int dim)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface RealPositionable
  - setPosition
```
public void setPosition(int position,
                        int dim)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    dim - dimension
  - setPosition
```
public void setPosition(long position,
                        int dim)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position in dimension d
    
    dim - dimension
  - updateCachedMembershipStatus
```
protected void updateCachedMembershipStatus()
```
  - fwd
```
public void fwd(int dim)
```
    Description copied from interface: Positionable
    
    Move by 1 in one dimension.
    
    Specified by:
    
    fwd in interface Positionable
    
    Parameters:
    
    dim - dimension
  - bck
```
public void bck(int dim)
```
    Description copied from interface: Positionable
    
    Move by -1 in one dimension.
    
    Specified by:
    
    bck in interface Positionable
    
    Parameters:
    
    dim - dimension
  - get
```
public BitType get()
```
    Description copied from interface: Sampler
    
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
    
    Specified by:
    
    get in interface Sampler<BitType>
  - copy
```
public AbstractRegionOfInterest.AROIRandomAccess copy()
```
    Specified by:
    
    copy in interface Sampler<BitType>
    
    Returns:
    
    - A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)
  - copyRealRandomAccess
```
public AbstractRegionOfInterest.AROIRandomAccess copyRealRandomAccess()
```
    Specified by:
    
    copyRealRandomAccess in interface RealRandomAccess<BitType>

Class AbstractRegionOfInterest.AROIRandomAccess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealRandomAccess

Methods inherited from interface net.imglib2.RealLocalizable

Constructor Detail

AROIRandomAccess

AROIRandomAccess

Method Detail

localize

localize

getFloatPosition

getDoublePosition

numDimensions

move

move

move

move

move

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

updateCachedMembershipStatus

fwd

bck

get

copy

copyRealRandomAccess