Package net.imglib2

Class Point

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractLocalizable

net.imglib2.Point

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RealLocalizable

Direct Known Subclasses:

AbstractProjector2D, CellGrid.CellIntervalsRA, FunctionRandomAccessible.FunctionRandomAccess, Grid.CellIntervalsRA, HyperSlicesView.HyperSlicesViewRandomAccess, Localizables.LocationRandomAccess, PositionRandomAccessible.PositionRandomAccess

public class Point
extends AbstractLocalizable
implements Positionable

A Point is a position in Euclidean space specified in integer coordinates.

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizable

position

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor	Description
	Point(int n)	Create a point in nDimensional space initialized to 0,0,...
	Point(int... position)	Create a point at a definite location in a space of the dimensionality of the position.
	Point(long... position)	Create a point at a definite location in a space of the dimensionality of the position.
protected	Point(long[] position, boolean copy)	Protected constructor that can re-use the passed position array.
	Point(Localizable localizable)	Create a point using the position and dimensionality of a Localizable

Method Summary

Modifier and Type	Method	Description
void	bck(int d)	Move by -1 in one dimension.
boolean	equals(java.lang.Object obj)
void	fwd(int d)	Move by 1 in one dimension.
int	hashCode()
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(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	move(Localizable localizable)	Move the element relative to its current location using an Localizable as distance vector.
void	setPosition(int[] position)	Set the position of the element.
void	setPosition(int position, int d)	Set the position of the element for one dimension.
void	setPosition(long[] position)	Set the position of the element.
void	setPosition(long position, 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
java.lang.String	toString()
static Point	wrap(long[] position)	Create a point that stores its coordinates in the provided position array.

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.Localizable

localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Constructor Detail

Point

protected Point(long[] position,
                boolean copy)

Protected constructor that can re-use the passed position array.

Parameters:

position - array used to store the position.

copy - flag indicating whether position array should be duplicated.

Point

public Point(int n)

Create a point in nDimensional space initialized to 0,0,...

Parameters:

n - number of dimensions of the space

Point

public Point(long... position)

Create a point at a definite location in a space of the dimensionality of the position.

Parameters:

position - the initial position. The length of the array determines the dimensionality of the space.

Point

public Point(int... position)

Create a point at a definite location in a space of the dimensionality of the position.

Parameters:

position - the initial position. The length of the array determines the dimensionality of the space.

Point

public Point(Localizable localizable)

Create a point using the position and dimensionality of a Localizable

Parameters:

localizable - the initial position. Its dimensionality determines the dimensionality of the space.

Method Detail

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[] position)

Description copied from interface: Positionable

Set the position of the element.

Specified by:

setPosition in interface Positionable

Parameters:

position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(long[] position)

Description copied from interface: Positionable

Set the position of the element.

Specified by:

setPosition in interface Positionable

Parameters:

position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(int position,
                        int d)

Description copied from interface: Positionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface Positionable

Parameters:

position - absolute position in dimension d

d - dimension

setPosition

public void setPosition(long position,
                        int d)

Description copied from interface: Positionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface Positionable

Parameters:

position - absolute position in dimension d

d - dimension

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

wrap

public static Point wrap(long[] position)

Create a point that stores its coordinates in the provided position array.

Parameters:

position - array to use for storing the position.