PlanarRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizableInt
  - - net.imglib2.img.planar.PlanarRandomAccess<T>

Type Parameters:

T -

All Implemented Interfaces:

EuclideanSpace, PlanarImg.PlanarContainerSampler, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>

Direct Known Subclasses:

PlanarRandomAccess1D
```
public class PlanarRandomAccess<T extends NativeType<T>>
extends AbstractLocalizableInt
implements RandomAccess<T>, PlanarImg.PlanarContainerSampler
```
RandomAccess on a PlanarImg.

Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected int sliceIndex

protected int[] sliceSteps

protected T type

protected Index typeIndex

protected int width
- Fields inherited from class net.imglib2.AbstractLocalizableInt
  position
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Fields
Modifier and Type	Field and Description
`protected int`	`sliceIndex`
`protected int[]`	`sliceSteps`
`protected T`	`type`
`protected Index`	`typeIndex`
`protected int`	`width`

Constructor Summary

Constructors
Modifier Constructor and Description

PlanarRandomAccess(PlanarImg<T,?> container)

protected PlanarRandomAccess(PlanarRandomAccess<T> randomAccess)

Constructors
Modifier	Constructor and Description
	`PlanarRandomAccess(PlanarImg<T,?> container)`
`protected`	`PlanarRandomAccess(PlanarRandomAccess<T> 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.
`PlanarRandomAccess<T>`	`copy()`
`PlanarRandomAccess<T>`	`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.
`int`	`getCurrentSliceIndex()`
`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.AbstractLocalizableInt
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
  - sliceSteps
```
protected final int[] sliceSteps
```
  - width
```
protected final int width
```
  - type
```
protected final T extends NativeType<T> type
```
  - typeIndex
```
protected final Index typeIndex
```
  - sliceIndex
```
protected int sliceIndex
```
- Constructor Detail
  - PlanarRandomAccess
```
protected PlanarRandomAccess(PlanarRandomAccess<T> randomAccess)
```
  - PlanarRandomAccess
```
public PlanarRandomAccess(PlanarImg<T,?> container)
```
- Method Detail
  - getCurrentSliceIndex
```
public int getCurrentSliceIndex()
```
    Specified by:
    
    getCurrentSliceIndex in interface PlanarImg.PlanarContainerSampler
    
    Returns:
    
    the index of the slice the sampler is currently accessing.
  - 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 PlanarRandomAccess<T> 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 PlanarRandomAccess<T> 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 PlanarRandomAccess<T extends NativeType<T>>

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizableInt

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizableInt

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

sliceSteps

width

type

typeIndex

sliceIndex

Constructor Detail

PlanarRandomAccess

PlanarRandomAccess

Method Detail

getCurrentSliceIndex

get

copy

copyRandomAccess

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition