Position (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.Position

All Implemented Interfaces:

EuclideanSpace, Iterator, Localizable, Positionable, RealLocalizable
```
public class Position
extends Object
implements Localizable, Positionable, Iterator
```
A Position is used to move within a given reference Extents object.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description
`Position(Extents parentSpace)` Constructor - takes an `Extents` object that represents the parent space to iterate within.
`Position(Position pos)` Constructs a position that is a copy of the given position.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck()` Moves the `Position` backward by one step.
`void`	`bck(int d)` Moves the `Position` backward one step in specified dimension.
`long`	`dimension(int i)` Returns the dimension of the `Position`'s parent `Extents` at a given i.
`void`	`first()` Sets the `Position` to its first state (all dimension positions to min values).
`void`	`fwd()` Moves the `Position` forward by one step.
`void`	`fwd(int d)` Moves the `Position` forward one step in specified dimension.
`double`	`getDoublePosition(int d)` Gets the current `Position`'s i'th coordinate as a double
`Extents`	`getExtents()` Returns the parent space `Extents` associated with this `Position`.
`float`	`getFloatPosition(int d)` Gets the current `Position`'s i'th coordinate as a float
`long`	`getIndex()` Gets the long index from the current `Position`.
`int`	`getIntPosition(int d)` Gets the current `Position`'s i'th coordinate as an int
`long`	`getLongPosition(int d)` Gets the current `Position`'s i'th coordinate as a long
`boolean`	`hasNext()` Returns true if position can be moved forward (i.e.
`boolean`	`hasPrev()` Returns true if position can be moved backward (i.e.
`void`	`jumpBck(long steps)` Moves the `Position` backward the given number of steps.
`void`	`jumpFwd(long steps)` Moves the `Position` forward the given number of steps.
`void`	`last()` Sets the `Position` to its last state (all dimension positions to max-1)
`void`	`localize(double[] pos)` Populates a given double[] with the current `Position`'s coordinates
`void`	`localize(float[] pos)` Populates a given float[] with the current `Position`'s coordinates
`void`	`localize(int[] pos)` Populates a given int[] with the current `Position`'s coordinates
`void`	`localize(long[] pos)` Populates a given long[] with the current `Position`'s coordinates
`void`	`move(int[] distance)` Moves all dimensions of the `Position` by given deltas.
`void`	`move(int distance, int d)` Moves a given dimension of the `Position` by a given delta.
`void`	`move(Localizable localizable)` Moves all dimensions of the `Position` by given deltas.
`void`	`move(long[] deltas)` Moves all dimensions of the `Position` by given deltas.
`void`	`move(long delta, int dim)` Moves a given dimension of the `Position` by a given delta.
`int`	`numDimensions()` Returns the number of dimensions within the `Position`.
`void`	`reset()` Resets the `Position` for forward or backward traversal.
`void`	`setIndex(long index)` Sets the `Position` from a given long index.
`void`	`setPosition(int[] position)` Sets the values of the `Position` for all dimensions.
`void`	`setPosition(int position, int d)` Sets the value of the `Position` for a given dimension.
`void`	`setPosition(Localizable localizable)` Sets the values of the `Position` for all dimensions.
`void`	`setPosition(long[] value)` Sets the values of the `Position` for all dimensions.
`void`	`setPosition(long value, int dim)` Sets the value of the `Position` for a given dimension.
`String`	`toString()`

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

Methods inherited from interface net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

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

- Constructor Detail
  - Position
```
public Position(Extents parentSpace)
```
    Constructor - takes an Extents object that represents the parent space to iterate within.
  - Position
```
public Position(Position pos)
```
    Constructs a position that is a copy of the given position.
- Method Detail
  - getExtents
```
public Extents getExtents()
```
    Returns the parent space Extents associated with this Position.
  - numDimensions
```
public int numDimensions()
```
    Returns the number of dimensions within the Position.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - dimension
```
public long dimension(int i)
```
    Returns the dimension of the Position's parent Extents at a given i.
  - hasNext
```
public boolean hasNext()
```
    Returns true if position can be moved forward (i.e. position is not in the last position).
    
    Specified by:
    
    hasNext in interface Iterator
  - hasPrev
```
public boolean hasPrev()
```
    Returns true if position can be moved backward (i.e. position is not in the first position).
  - reset
```
public void reset()
```
    Resets the Position for forward or backward traversal.
    
    Specified by:
    
    reset in interface Iterator
  - first
```
public void first()
```
    Sets the Position to its first state (all dimension positions to min values).
  - last
```
public void last()
```
    Sets the Position to its last state (all dimension positions to max-1)
  - fwd
```
public void fwd()
```
    Moves the Position forward by one step. Increments the dimension positions from left to right.
    
    Specified by:
    
    fwd in interface Iterator
    
    Throws:
    
    IllegalStateException - if called from last position.
  - bck
```
public void bck()
```
    Moves the Position backward by one step. Decrements the dimension positions from left to right.
    
    Throws:
    
    IllegalStateException - if called from first position.
  - fwd
```
public void fwd(int d)
```
    Moves the Position forward one step in specified dimension. Throws an exception if specified move would take position outside parent Extents.
    
    Specified by:
    
    fwd in interface Positionable
  - bck
```
public void bck(int d)
```
    Moves the Position backward one step in specified dimension. Throws an exception if specified move would take position outside parent Extents.
    
    Specified by:
    
    bck in interface Positionable
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Moves the Position forward the given number of steps.
    
    Specified by:
    
    jumpFwd in interface Iterator
  - jumpBck
```
public void jumpBck(long steps)
```
    Moves the Position backward the given number of steps.
  - move
```
public void move(long delta,
                 int dim)
```
    Moves a given dimension of the Position by a given delta. Throws an exception if delta would move Position outside its parent Extents.
    
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(long[] deltas)
```
    Moves all dimensions of the Position by given deltas. Throws an exception if any delta would move Position outside its parent Extents.
    
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(int distance,
                 int d)
```
    Moves a given dimension of the Position by a given delta. Throws an exception if delta would move Position outside its parent Extents.
    
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(int[] distance)
```
    Moves all dimensions of the Position by given deltas. Throws an exception if any delta would move Position outside its parent Extents.
    
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(Localizable localizable)
```
    Moves all dimensions of the Position by given deltas. Throws an exception if any delta would move Position outside its parent Extents. The delta is encoded as a relative Localizable vector.
    
    Specified by:
    
    move in interface Positionable
  - setPosition
```
public void setPosition(long value,
                        int dim)
```
    Sets the value of the Position for a given dimension. Throws an exception if the given value is outside the bounds of the parent Extents.
    
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(long[] value)
```
    Sets the values of the Position for all dimensions. Throws an exception if any given value is outside the bounds of the parent Extents.
    
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(int[] position)
```
    Sets the values of the Position for all dimensions. Throws an exception if any given value is outside the bounds of the parent Extents.
    
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(int position,
                        int d)
```
    Sets the value of the Position for a given dimension. Throws an exception if the given value is outside the bounds of the parent Extents.
    
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Sets the values of the Position for all dimensions. Throws an exception if any given value is outside the bounds of the parent Extents. The position is encoded as an absolute Localizable vector.
    
    Specified by:
    
    setPosition in interface Positionable
  - setIndex
```
public void setIndex(long index)
```
    Sets the Position from a given long index. The index ranges from 0 to extents.numElements()-1. Throws an exception if index out of range.
  - getIndex
```
public long getIndex()
```
    Gets the long index from the current Position. The index ranges from 0 to extents.numElements()-1.
  - localize
```
public void localize(int[] pos)
```
    Populates a given int[] with the current Position's coordinates
    
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] pos)
```
    Populates a given long[] with the current Position's coordinates
    
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(float[] pos)
```
    Populates a given float[] with the current Position's coordinates
    
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] pos)
```
    Populates a given double[] with the current Position's coordinates
    
    Specified by:
    
    localize in interface RealLocalizable
  - getIntPosition
```
public int getIntPosition(int d)
```
    Gets the current Position's i'th coordinate as an int
    
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int d)
```
    Gets the current Position's i'th coordinate as a long
    
    Specified by:
    
    getLongPosition in interface Localizable
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Gets the current Position's i'th coordinate as a float
    
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Gets the current Position's i'th coordinate as a double
    
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Position

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Constructor Detail

Position

Position

Method Detail

getExtents

numDimensions

dimension

hasNext

hasPrev

reset

first

last

fwd

bck

fwd

bck

jumpFwd

jumpBck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

setIndex

getIndex

localize

localize

localize

localize

getIntPosition

getLongPosition

getFloatPosition

getDoublePosition

toString