PositionableInterval (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.roi.util.PositionableInterval

All Implemented Interfaces:

Dimensions, EuclideanSpace, Interval, Localizable, Positionable, RealInterval, RealLocalizable

Direct Known Subclasses:

LabelRegion, PositionableWrappedIterableInterval
```
public class PositionableInterval
extends AbstractLocalizable
implements Positionable, Interval
```
An interval that can be moved around.
It is constructed with an initial source interval. After construction it has position 0, and interval bounds that are identical to the initial source interval.
If after that it is moved, both the position and interval bounds move.
Additionally, it is possible to move the origin(), which is useful for example to make the min corner or the center of the interval coincide with the position.

Author:

Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected long[] currentOffset

protected long[] initialMax

protected long[] initialMin
- Fields inherited from class net.imglib2.AbstractLocalizable
  position
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Fields
Modifier and Type	Field and Description
`protected long[]`	`currentOffset`
`protected long[]`	`initialMax`
`protected long[]`	`initialMin`

Constructor Summary

Constructors
Modifier Constructor and Description

PositionableInterval(Interval initial)

protected PositionableInterval(PositionableInterval other)
Copy constructor.

Constructors
Modifier	Constructor and Description
	`PositionableInterval(Interval initial)`
`protected`	`PositionableInterval(PositionableInterval other)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`long`	`dimension(int d)` Default implementation of `Dimensions.dimension(int)`.
`void`	`dimensions(long[] dimensions)` Write the number of pixels in each dimension into long[].
`void`	`fwd(int d)` Move by 1 in one dimension.
`long`	`max(int d)` Get the maximum in dimension d.
`void`	`max(long[] max)` Write the maximum of each dimension into long[].
`void`	`max(Positionable max)` Sets a `Positionable` to the maximum of this `Interval`
`long`	`min(int d)` Get the minimum in dimension d.
`void`	`min(long[] min)` Write the minimum of each dimension into long[].
`void`	`min(Positionable min)` Sets a `Positionable` to the minimum of this `Interval`
`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.
`PositionableLocalizable`	`origin()` Get the `Positionable`, `Localizable` origin of this interval.
`void`	`realMax(double[] max)` Write the maximum of each dimension into double[].
`double`	`realMax(int d)` Default implementation of `RealInterval.realMax(int)`.
`void`	`realMax(RealPositionable max)` Sets a `RealPositionable` to the maximum of this `Interval`
`void`	`realMin(double[] min)` Write the minimum of each dimension into double[].
`double`	`realMin(int d)` Default implementation of `RealInterval.realMin(int)`.
`void`	`realMin(RealPositionable min)` Sets a `RealPositionable` to the minimum of this `Interval`
`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.
`String`	`toString()`

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, wait, wait, wait

Methods inherited from interface net.imglib2.Interval
maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Methods inherited from interface net.imglib2.Dimensions
allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

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

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

- Field Detail
  - currentOffset
```
protected final long[] currentOffset
```
  - initialMin
```
protected final long[] initialMin
```
  - initialMax
```
protected final long[] initialMax
```
- Constructor Detail
  - PositionableInterval
```
public PositionableInterval(Interval initial)
```
  - PositionableInterval
```
protected PositionableInterval(PositionableInterval other)
```
    Copy constructor.
- Method Detail
  - origin
```
public PositionableLocalizable origin()
```
    Get the Positionable, Localizable origin of this interval.
    The origin is the relative offset of the position to the minimum. For example if a positionable (bitmask) region is made from a BitType image with a circular pattern, then it is more natural if the region position refers to the center of the pattern instead of the upper left corner of the BitType image. This can be achieved by positioning the origin.
    Assume a region is created from a 9x9 bitmask. The region initially has min=(0,0), max=(8,8), position=(0,0). Because both position and min are (0,0), initially origin=(0,0). Now assume the origin is moved to the center of the bitmask using origin().setPosition(new int[]{4,4}). After this, min=(-4,-4), max=(4,4), position=(0,0), and origin=(4,4).
    
    Returns:
    
    the origin to which the interval is relative.
  - 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
  - realMin
```
public double realMin(int d)
```
    Description copied from interface: Interval
    
    Default implementation of RealInterval.realMin(int).
    
    Specified by:
    
    realMin in interface Interval
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMin
```
public void realMin(double[] min)
```
    Description copied from interface: RealInterval
    
    Write the minimum of each dimension into double[].
    
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(RealPositionable min)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the minimum of this Interval
    
    Specified by:
    
    realMin in interface RealInterval
  - realMax
```
public double realMax(int d)
```
    Description copied from interface: Interval
    
    Default implementation of RealInterval.realMax(int).
    
    Specified by:
    
    realMax in interface Interval
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - realMax
```
public void realMax(double[] max)
```
    Description copied from interface: RealInterval
    
    Write the maximum of each dimension into double[].
    
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(RealPositionable max)
```
    Description copied from interface: RealInterval
    
    Sets a RealPositionable to the maximum of this Interval
    
    Specified by:
    
    realMax in interface RealInterval
  - min
```
public long min(int d)
```
    Description copied from interface: Interval
    
    Get the minimum in dimension d.
    
    Specified by:
    
    min in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - min
```
public void min(long[] min)
```
    Description copied from interface: Interval
    
    Write the minimum of each dimension into long[].
    
    Specified by:
    
    min in interface Interval
  - min
```
public void min(Positionable min)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the minimum of this Interval
    
    Specified by:
    
    min in interface Interval
  - max
```
public long max(int d)
```
    Description copied from interface: Interval
    
    Get the maximum in dimension d.
    
    Specified by:
    
    max in interface Interval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - max
```
public void max(long[] max)
```
    Description copied from interface: Interval
    
    Write the maximum of each dimension into long[].
    
    Specified by:
    
    max in interface Interval
  - max
```
public void max(Positionable max)
```
    Description copied from interface: Interval
    
    Sets a Positionable to the maximum of this Interval
    
    Specified by:
    
    max in interface Interval
  - dimensions
```
public void dimensions(long[] dimensions)
```
    Description copied from interface: Dimensions
    
    Write the number of pixels in each dimension into long[].
    
    Specified by:
    
    dimensions in interface Dimensions
  - dimension
```
public long dimension(int d)
```
    Description copied from interface: Interval
    
    Default implementation of Dimensions.dimension(int).
    
    Specified by:
    
    dimension in interface Dimensions
    
    Specified by:
    
    dimension in interface Interval
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PositionableInterval

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.Interval

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.Dimensions

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

currentOffset

initialMin

initialMax

Constructor Detail

PositionableInterval

PositionableInterval

Method Detail

origin

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

realMin

realMin

realMin

realMax

realMax

realMax

min

min

min

max

max

max

dimensions

dimension

toString