Package net.imglib2

Class PointSample<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractLocalizable

net.imglib2.PointSample<T>

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>, Typed<T>

public class PointSample<T>
extends AbstractLocalizable
implements RandomAccess<T>

A simple default implementation of RandomAccess that can be used to combine a real location and a sample instance, e.g. as output of a FunctionRandomAccessible.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<T>	sampleSupplier

Fields inherited from class net.imglib2.AbstractLocalizable

position

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor	Description
	PointSample(java.util.function.Supplier<T> sampleSupplier, int n)	Create a point in nDimensional space initialized to 0,0,...
	PointSample(java.util.function.Supplier<T> sampleSupplier, int... position)	Create a point at a definite location in a space of the dimensionality of the position.
	PointSample(java.util.function.Supplier<T> sampleSupplier, long... position)	Create a point at a definite location in a space of the dimensionality of the position.
protected	PointSample(java.util.function.Supplier<T> sampleSupplier, long[] position, boolean copy)	Protected constructor that can re-use the passed position array.
	PointSample(java.util.function.Supplier<T> sampleSupplier, 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.
PointSample<T>	copy()
boolean	equals(java.lang.Object obj)
void	fwd(int d)	Move by 1 in one dimension.
T	get()	Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
T	getType()	Get an instance of T.
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 <T> PointSample<T>	wrap(T sample, long[] position)	Create a PointSample that carries the provided sample and stores its coordinates in the provided position array.
static <T> PointSample<T>	wrapSupplier(java.util.function.Supplier<T> sampleSupplier, long[] position)	Create a PointSample that carries the provided sample and 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

getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RandomAccess

copyRandomAccess, setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.RealLocalizable

localize, localize, positionAsDoubleArray, positionAsRealPoint

Field Detail

sampleSupplier

protected final java.util.function.Supplier<T> sampleSupplier

Constructor Detail

PointSample

protected PointSample(java.util.function.Supplier<T> sampleSupplier,
                      long[] position,
                      boolean copy)

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

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

position - array used to store the position.

copy - flag indicating whether position array should be duplicated.

PointSample

public PointSample(java.util.function.Supplier<T> sampleSupplier,
                   int n)

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

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

n - number of dimensions of the space

PointSample

public PointSample(java.util.function.Supplier<T> sampleSupplier,
                   long... position)

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

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

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

PointSample

public PointSample(java.util.function.Supplier<T> sampleSupplier,
                   int... position)

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

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

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

PointSample

public PointSample(java.util.function.Supplier<T> sampleSupplier,
                   Localizable localizable)

Create a point using the position and dimensionality of a Localizable

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

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 <T> PointSample<T> wrap(T sample,
                                      long[] position)

Create a PointSample that carries the provided sample and stores its coordinates in the provided position array.

Parameters:

sample - the re-usable sample instance that is used by this PointSample (like Type)

position - array to use for storing the position.

wrapSupplier

public static <T> PointSample<T> wrapSupplier(java.util.function.Supplier<T> sampleSupplier,
                                              long[] position)

Create a PointSample that carries the provided sample and stores its coordinates in the provided position array.

Parameters:

sampleSupplier - a supplier to create the sample instance (can be () -> t) for instances that are re-used (like Type).

position - array to use for storing the position.

get

public T get()

Description copied from interface: Sampler

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

Specified by:

get in interface Sampler<T>

getType

public T getType()

Description copied from interface: Typed

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

Specified by:

getType in interface Sampler<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T

copy

public PointSample<T> copy()

Specified by:

copy in interface RandomAccess<T>

Specified by:

copy in interface Sampler<T>

Returns:

- A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)