CellRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.img.cell.CellRandomAccess<T,C>

All Implemented Interfaces:

EuclideanSpace, AbstractCellImg.CellImgSampler<C>, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>
```
public class CellRandomAccess<T extends NativeType<T>,C extends Cell<?>>
extends AbstractLocalizable
implements RandomAccess<T>, AbstractCellImg.CellImgSampler<C>
```
RandomAccess on a AbstractCellImg. The boundaries of the current cell are cached, so that position changes within the same cell have minimal overhead.

Author:

Tobias Pietzsch

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`cellDims`
`protected long[]`	`currentCellMax`
`protected long[]`	`currentCellMin`
`protected int[]`	`currentCellSteps`
`protected long[]`	`dimensions`
`protected CellGrid`	`grid`
`protected int`	`index` The current index of the type.
`protected boolean`	`isOutOfBounds`
`protected long[]`	`oobCellMax`
`protected long[]`	`oobCellMin`
`protected RandomAccess<C>`	`randomAccessOnCells`
`protected T`	`type`
`protected Index`	`typeIndex`

Fields inherited from class net.imglib2.AbstractLocalizable
position

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier Constructor and Description

CellRandomAccess(AbstractCellImg<T,?,C,?> img)

protected CellRandomAccess(CellRandomAccess<T,C> randomAccess)

Constructors
Modifier	Constructor and Description
	`CellRandomAccess(AbstractCellImg<T,?,C,?> img)`
`protected`	`CellRandomAccess(CellRandomAccess<T,C> randomAccess)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`CellRandomAccess<T,C>`	`copy()`
`CellRandomAccess<T,C>`	`copyRandomAccess()`
`void`	`fwd(int d)` Move by 1 in one dimension.
`T`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`C`	`getCell()`
`void`	`move(int[] distance)` Move the element relative to its current location using an int[] as distance vector.
`void`	`move(int distance, int d)` 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[] distance)` Move the element relative to its current location using a long[] as distance vector.
`void`	`move(long distance, int d)` Move the element in one dimension for some distance.
`void`	`setPosition(int[] pos)` Set the position of the element.
`void`	`setPosition(int pos, int d)` 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[] pos)` Set the position of the element.
`void`	`setPosition(long pos, int d)` Set the position of the element for one dimension.

Methods inherited from class net.imglib2.AbstractLocalizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

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

Methods inherited from interface net.imglib2.Localizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, positionAsLongArray, positionAsPoint

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Field Detail
  - type
```
protected final T extends NativeType<T> type
```
  - typeIndex
```
protected final Index typeIndex
```
  - grid
```
protected final CellGrid grid
```
  - randomAccessOnCells
```
protected final RandomAccess<C extends Cell<?>> randomAccessOnCells
```
  - cellDims
```
protected final int[] cellDims
```
  - dimensions
```
protected final long[] dimensions
```
  - currentCellSteps
```
protected int[] currentCellSteps
```
  - currentCellMin
```
protected long[] currentCellMin
```
  - currentCellMax
```
protected long[] currentCellMax
```
  - isOutOfBounds
```
protected boolean isOutOfBounds
```
  - oobCellMin
```
protected final long[] oobCellMin
```
  - oobCellMax
```
protected final long[] oobCellMax
```
  - index
```
protected int index
```
    The current index of the type. It is faster to duplicate this here than to access it through type.getIndex().
- Constructor Detail
  - CellRandomAccess
```
protected CellRandomAccess(CellRandomAccess<T,C> randomAccess)
```
  - CellRandomAccess
```
public CellRandomAccess(AbstractCellImg<T,?,C,?> img)
```
- Method Detail
  - getCell
```
public C getCell()
```
    Specified by:
    
    getCell in interface AbstractCellImg.CellImgSampler<C extends Cell<?>>
    
    Returns:
    
    the cell the sampler is currently in.
  - get
```
public T 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<T extends NativeType<T>>
  - copy
```
public CellRandomAccess<T,C> copy()
```
    Specified by:
    
    copy in interface Sampler<T extends NativeType<T>>
    
    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)
  - copyRandomAccess
```
public CellRandomAccess<T,C> copyRandomAccess()
```
    Specified by:
    
    copyRandomAccess in interface RandomAccess<T extends NativeType<T>>
  - fwd
```
public void fwd(int d)
```
    Description copied from interface: Positionable
    
    Move by 1 in one dimension.
    
    Specified by:
    
    fwd in interface Positionable
    
    Parameters:
    
    d - dimension
  - bck
```
public void bck(int d)
```
    Description copied from interface: Positionable
    
    Move by -1 in one dimension.
    
    Specified by:
    
    bck in interface Positionable
    
    Parameters:
    
    d - dimension
  - move
```
public void move(int distance,
                 int d)
```
    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
    
    d - dimension
  - move
```
public void move(long distance,
                 int d)
```
    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
    
    d - dimension
  - 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(int[] distance)
```
    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:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(long[] distance)
```
    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:
    
    distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(int pos,
                        int d)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    pos - absolute position in dimension d
    
    d - dimension
  - setPosition
```
public void setPosition(long pos,
                        int d)
```
    Description copied from interface: Positionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    pos - absolute position in dimension d
    
    d - dimension
  - 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(int[] pos)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    pos - absolute position, length must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(long[] pos)
```
    Description copied from interface: Positionable
    
    Set the position of the element.
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    pos - absolute position, length must be ≥ EuclideanSpace.numDimensions()

Class CellRandomAccess<T extends NativeType<T>,C extends Cell<?>>

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizable

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizable

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RandomAccess

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Field Detail

type

typeIndex

grid

randomAccessOnCells

cellDims

dimensions

currentCellSteps

currentCellMin

currentCellMax

isOutOfBounds

oobCellMin

oobCellMax

index

Constructor Detail

CellRandomAccess

CellRandomAccess

Method Detail

getCell

get

copy

copyRandomAccess

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition