RealPoint (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractRealLocalizable
  - - net.imglib2.RealPoint

All Implemented Interfaces:

EuclideanSpace, Positionable, RealLocalizable, RealPositionable

Direct Known Subclasses:

AbstractRealMaskPoint, DefaultWritablePointMask, FunctionRealRandomAccessible.RealFunctionRealRandomAccess, InverseDistanceWeightingInterpolator, MaskPredicateRealRandomAccess, NearestNeighborSearchInterpolator, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealTransformRealRandomAccessible.RealTransformRealRandomAccess, RefinedPeak
```
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 and 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 a `RealLocalizable`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`boolean`	`equals(Object obj)`
`void`	`fwd(int d)` Move by 1 in one dimension.
`int`	`hashCode()`
`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(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.
`void`	`move(RealLocalizable localizable)` Move the element relative to its current location using a `RealLocalizable` 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(Localizable localizable)` Place the element at the same location as a given `Localizable`
`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(RealLocalizable localizable)` Place the element at the same location as a given `RealLocalizable`
`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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

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

- 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 a RealLocalizable
    
    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
  - 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 interface RealPositionable
  - 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 interface RealPositionable
  - move
```
public void move(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Move the element relative to its current location using a RealLocalizable as distance vector.
    
    Specified by:
    
    move in interface RealPositionable
    
    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 interface RealPositionable
  - 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 interface RealPositionable
  - setPosition
```
public void setPosition(RealLocalizable localizable)
```
    Description copied from interface: RealPositionable
    
    Place the element at the same location as a given RealLocalizable
    
    Specified by:
    
    setPosition in interface RealPositionable
    
    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 interface RealPositionable
    
    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 interface RealPositionable
    
    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 interface RealPositionable
  - 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 interface RealPositionable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class 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.

Class RealPoint

Field Summary

Fields inherited from class net.imglib2.AbstractRealLocalizable

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractRealLocalizable

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.RealLocalizable

Constructor Detail

RealPoint

RealPoint

RealPoint

RealPoint

RealPoint

Method Detail

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

toString

equals

hashCode

wrap