net.imglib2.roi.util

Class PositionableInterval

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	bck(int d)
long	dimension(int d)
void	dimensions(long[] dimensions)
void	fwd(int d)
long	max(int d)
void	max(long[] max)
void	max(Positionable max)
long	min(int d)
void	min(long[] min)
void	min(Positionable min)
void	move(int[] distance)
void	move(int distance, int d)
void	move(Localizable localizable)
void	move(long[] distance)
void	move(long distance, int d)
PositionableLocalizable	origin() Get the Positionable, Localizable origin of this interval.
void	realMax(double[] max)
double	realMax(int d)
void	realMax(RealPositionable max)
void	realMin(double[] min)
double	realMin(int d)
void	realMin(RealPositionable min)
void	setPosition(int[] pos)
void	setPosition(int pos, int d)
void	setPosition(Localizable localizable)
void	setPosition(long[] pos)
void	setPosition(long pos, int d)
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)

Specified by:

fwd in interface Positionable

bck

public void bck(int d)

Specified by:

bck in interface Positionable

move

public void move(int distance,
                 int d)

Specified by:

move in interface Positionable

move

public void move(long distance,
                 int d)

Specified by:

move in interface Positionable

move

public void move(Localizable localizable)

Specified by:

move in interface Positionable

move

public void move(int[] distance)

Specified by:

move in interface Positionable

move

public void move(long[] distance)

Specified by:

move in interface Positionable

setPosition

public void setPosition(Localizable localizable)

Specified by:

setPosition in interface Positionable

setPosition

public void setPosition(int[] pos)

Specified by:

setPosition in interface Positionable

setPosition

public void setPosition(long[] pos)

Specified by:

setPosition in interface Positionable

setPosition

public void setPosition(int pos,
                        int d)

Specified by:

setPosition in interface Positionable

setPosition

public void setPosition(long pos,
                        int d)

Specified by:

setPosition in interface Positionable

realMin

public double realMin(int d)

Specified by:

realMin in interface Interval

Specified by:

realMin in interface RealInterval

realMin

public void realMin(double[] min)

Specified by:

realMin in interface RealInterval

realMin

public void realMin(RealPositionable min)

Specified by:

realMin in interface RealInterval

realMax

public double realMax(int d)

Specified by:

realMax in interface Interval

Specified by:

realMax in interface RealInterval

realMax

public void realMax(double[] max)

Specified by:

realMax in interface RealInterval

realMax

public void realMax(RealPositionable max)

Specified by:

realMax in interface RealInterval

min

public long min(int d)

Specified by:

min in interface Interval

min

public void min(long[] min)

Specified by:

min in interface Interval

min

public void min(Positionable min)

Specified by:

min in interface Interval

max

public long max(int d)

Specified by:

max in interface Interval

max

public void max(long[] max)

Specified by:

max in interface Interval

max

public void max(Positionable max)

Specified by:

max in interface Interval

dimensions

public void dimensions(long[] dimensions)

Specified by:

dimensions in interface Dimensions

dimension

public long dimension(int d)

Specified by:

dimension in interface Dimensions

Specified by:

dimension in interface Interval

toString

public String toString()

Overrides:

toString in class Object