Package net.imglib2
Class RealPoint
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractRealLocalizable
-
- net.imglib2.RealPoint
-
- All Implemented Interfaces:
EuclideanSpace
,Positionable
,RealLocalizable
,RealPositionable
- Direct Known Subclasses:
InverseDistanceWeightingInterpolator
,NearestNeighborSearchInterpolator
public class RealPoint extends AbstractRealLocalizable implements RealPositionable
A point is a location in EuclideanSpace.- Author:
- Lee Kamentsky, Stephan Saalfeld, Tobias Pietzsch
-
-
Field Summary
-
Fields inherited from class net.imglib2.AbstractRealLocalizable
position
-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Modifier Constructor Description RealPoint(double... position)
Create a point at a definite location in a space of the dimensionality of the position.protected
RealPoint(double[] position, boolean copy)
Protected constructor that can re-use the passed position array.RealPoint(float... position)
Create a point at a definite location in a space of the dimensionality of the position.RealPoint(int n)
Create a point in nDimensional space initialized to 0,0,...RealPoint(RealLocalizable localizable)
Create a point using the position and dimensionality of aRealLocalizable
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bck(int d)
Move by -1 in one dimension.void
fwd(int d)
Move by 1 in one dimension.void
move(double[] distance)
Move the element relative to its current location using a float[] as distance vector.void
move(double distance, int d)
Move the element in one dimension for some distance.void
move(float[] distance)
Move the element relative to its current location using a float[] as distance vector.void
move(float distance, int d)
Move the element in one dimension for some distance.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 anLocalizable
as distance vector.void
move(RealLocalizable localizable)
Move the element relative to its current location using aRealLocalizable
as distance vector.void
setPosition(double[] position)
Set the position of the element.void
setPosition(double position, int d)
Set the position of the element for one dimension.void
setPosition(float[] position)
Set the position of the element.void
setPosition(float position, int d)
Set the position of the element for one dimension.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 givenLocalizable
void
setPosition(RealLocalizable localizable)
Place the element at the same location as a givenRealLocalizable
java.lang.String
toString()
static RealPoint
wrap(double[] position)
Create a point that stores its coordinates in the provided position array.-
Methods inherited from class net.imglib2.AbstractRealLocalizable
getDoublePosition, getFloatPosition, 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.EuclideanSpace
numDimensions
-
-
-
-
Constructor Detail
-
RealPoint
protected RealPoint(double[] 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.
-
RealPoint
public RealPoint(int n)
Create a point in nDimensional space initialized to 0,0,...- Parameters:
n
- number of dimensions of the space
-
RealPoint
public RealPoint(double... 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.
-
RealPoint
public RealPoint(float... 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.
-
RealPoint
public RealPoint(RealLocalizable localizable)
Create a point using the position and dimensionality of aRealLocalizable
- 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 interfacePositionable
- Parameters:
d
- dimension
-
bck
public void bck(int d)
Description copied from interface:Positionable
Move by -1 in one dimension.- Specified by:
bck
in interfacePositionable
- 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 interfacePositionable
- Parameters:
distance
- relative offset in dimension dd
- 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 interfacePositionable
- Parameters:
distance
- relative offset in dimension dd
- dimension
-
move
public void move(Localizable localizable)
Description copied from interface:Positionable
Move the element relative to its current location using anLocalizable
as distance vector.- Specified by:
move
in interfacePositionable
- 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 interfacePositionable
- 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 interfacePositionable
- 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 givenLocalizable
- Specified by:
setPosition
in interfacePositionable
- 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 interfacePositionable
- 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 interfacePositionable
- 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 interfacePositionable
- Parameters:
position
- absolute position in dimension dd
- 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 interfacePositionable
- Parameters:
position
- absolute position in dimension dd
- dimension
-
move
public void move(float distance, int d)
Description copied from interface:RealPositionable
Move the element in one dimension for some distance.- Specified by:
move
in interfaceRealPositionable
-
move
public void move(double distance, int d)
Description copied from interface:RealPositionable
Move the element in one dimension for some distance.- Specified by:
move
in interfaceRealPositionable
-
move
public void move(RealLocalizable localizable)
Description copied from interface:RealPositionable
Move the element relative to its current location using aRealLocalizable
as distance vector.- Specified by:
move
in interfaceRealPositionable
- Parameters:
localizable
- relative offset,EuclideanSpace.numDimensions()
must be ≥EuclideanSpace.numDimensions()
-
move
public void move(float[] distance)
Description copied from interface:RealPositionable
Move the element relative to its current location using a float[] as distance vector.- Specified by:
move
in interfaceRealPositionable
- Parameters:
distance
- , length must be ≥EuclideanSpace.numDimensions()
-
move
public void move(double[] distance)
Description copied from interface:RealPositionable
Move the element relative to its current location using a float[] as distance vector.- Specified by:
move
in interfaceRealPositionable
- Parameters:
distance
- , length must be ≥EuclideanSpace.numDimensions()
-
setPosition
public void setPosition(RealLocalizable localizable)
Description copied from interface:RealPositionable
Place the element at the same location as a givenRealLocalizable
- Specified by:
setPosition
in interfaceRealPositionable
- Parameters:
localizable
- absolute position,EuclideanSpace.numDimensions()
must be ≥EuclideanSpace.numDimensions()
-
setPosition
public void setPosition(float[] position)
Description copied from interface:RealPositionable
Set the position of the element.- Specified by:
setPosition
in interfaceRealPositionable
- Parameters:
position
- absolute position, length must be ≥EuclideanSpace.numDimensions()
-
setPosition
public void setPosition(double[] position)
Description copied from interface:RealPositionable
Set the position of the element.- Specified by:
setPosition
in interfaceRealPositionable
- Parameters:
position
- absolute position, length must be ≥EuclideanSpace.numDimensions()
-
setPosition
public void setPosition(float position, int d)
Description copied from interface:RealPositionable
Set the position of the element for one dimension.- Specified by:
setPosition
in interfaceRealPositionable
-
setPosition
public void setPosition(double position, int d)
Description copied from interface:RealPositionable
Set the position of the element for one dimension.- Specified by:
setPosition
in interfaceRealPositionable
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
wrap
public static RealPoint wrap(double[] position)
Create a point that stores its coordinates in the provided position array.- Parameters:
position
- array to use for storing the position.
-
-