UnsafeRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.img.unsafe.UnsafeRandomAccess<T>

Type Parameters:

T -

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>
```
public class UnsafeRandomAccess<T extends NativeLongAccessType<T>>
extends AbstractLocalizable
implements RandomAccess<T>
```
RandomAccess on an ArrayImg.

Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected T type
- Fields inherited from class net.imglib2.AbstractLocalizable
  position
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Fields
Modifier and Type	Field and Description
`protected T`	`type`

Constructor Summary

Constructors
Modifier Constructor and Description

UnsafeRandomAccess(UnsafeImg<T,?> container)

protected UnsafeRandomAccess(UnsafeRandomAccess<T> randomAccess)

Constructors
Modifier	Constructor and Description
	`UnsafeRandomAccess(UnsafeImg<T,?> container)`
`protected`	`UnsafeRandomAccess(UnsafeRandomAccess<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.
`void`	`bckDim0()` Moves one step backward in dimension 0
`UnsafeRandomAccess<T>`	`copy()`
`UnsafeRandomAccess<T>`	`copyRandomAccess()`
`void`	`fwd(int d)` Move by 1 in one dimension.
`void`	`fwdDim0()` Moves one step forward in dimension 0
`T`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`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)` Moves n steps in dimension 0
`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`	`moveDim0(int distance)` Moves n steps in dimension 0
`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.
`void`	`setPositionDim0(int pos)` Sets the `UnsafeRandomAccess` to a certain position in dimension 0 Careful: it assumes that it is only a one-dimensional image, all other dimensions would be set to zero (this saves one subtraction)
`void`	`setPositionDim0(long pos)` Sets the `UnsafeRandomAccess` to a certain position in dimension 0 Careful: it assumes that it is only a one-dimensional image, all other dimensions would be set to zero (this saves one subtraction)

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 NativeLongAccessType<T> type
```
- Constructor Detail
  - UnsafeRandomAccess
```
protected UnsafeRandomAccess(UnsafeRandomAccess<T> randomAccess)
```
  - UnsafeRandomAccess
```
public UnsafeRandomAccess(UnsafeImg<T,?> container)
```
- Method Detail
  - 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 NativeLongAccessType<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(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()
  - 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
  - copy
```
public UnsafeRandomAccess<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T extends NativeLongAccessType<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 UnsafeRandomAccess<T> copyRandomAccess()
```
    Specified by:
    
    copyRandomAccess in interface RandomAccess<T extends NativeLongAccessType<T>>
  - fwdDim0
```
public void fwdDim0()
```
    Moves one step forward in dimension 0
  - bckDim0
```
public void bckDim0()
```
    Moves one step backward in dimension 0
  - moveDim0
```
public void moveDim0(int distance)
```
    Moves n steps in dimension 0
    
    Parameters:
    
    distance - - how many steps (positive or negative)
  - move
```
public void move(long distance)
```
    Moves n steps in dimension 0
    
    Parameters:
    
    distance - - how many steps (positive or negative)
  - setPositionDim0
```
public void setPositionDim0(int pos)
```
    Sets the UnsafeRandomAccess to a certain position in dimension 0 Careful: it assumes that it is only a one-dimensional image, all other dimensions would be set to zero (this saves one subtraction)
    
    Parameters:
    
    pos - - the new position
  - setPositionDim0
```
public void setPositionDim0(long pos)
```
    Sets the UnsafeRandomAccess to a certain position in dimension 0 Careful: it assumes that it is only a one-dimensional image, all other dimensions would be set to zero (this saves one subtraction)
    
    Parameters:
    
    pos - - the new position

Class UnsafeRandomAccess<T extends NativeLongAccessType<T>>

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

Constructor Detail

UnsafeRandomAccess

UnsafeRandomAccess

Method Detail

get

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

copy

copyRandomAccess

fwdDim0

bckDim0

moveDim0

move

setPositionDim0

setPositionDim0