Package net.imglib2

Class RealPointSampleList<T>

java.lang.Object

net.imglib2.RealPointSampleList<T>

All Implemented Interfaces:

java.lang.Iterable<T>, EuclideanSpace, IterableRealInterval<T>, RealInterval, Typed<T>

public class RealPointSampleList<T>
extends java.lang.Object
implements IterableRealInterval<T>

A list of data samples at explicit real coordinates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RealPointSampleList.RealPointSampleListCursor

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.ArrayList<RealPoint>	coordinates
protected int	lastIndex
protected double[]	max
protected double[]	min
protected int	n
protected java.util.ArrayList<T>	samples

Constructor Summary

Constructors

Constructor	Description
RealPointSampleList(int n)

Method Summary

Modifier and Type	Method	Description
void	add(RealPoint position, T sample)
RealCursor<T>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
T	firstElement()	Get the first element of this IterableRealInterval.
T	getType()	Get an instance of T.
java.lang.Object	iterationOrder()	Returns the iteration order of this IterableRealInterval.
RealCursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
int	numDimensions()	Gets the space's number of dimensions.
void	realMax(double[] m)	Write the maximum of each dimension into double[].
double	realMax(int d)	Get the maximum in dimension d.
void	realMax(RealPositionable m)	Sets a RealPositionable to the maximum of this Interval
void	realMin(double[] m)	Write the minimum of each dimension into double[].
double	realMin(int d)	Get the minimum in dimension d.
void	realMin(RealPositionable m)	Sets a RealPositionable to the minimum of this Interval
long	size()	Returns the number of elements in this Function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.IterableRealInterval

iterator, localizingSpliterator, parallelStream, spliterator, stream

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Field Detail

n

protected final int n

coordinates

protected final java.util.ArrayList<RealPoint> coordinates

samples

protected final java.util.ArrayList<T> samples

lastIndex

protected int lastIndex

min

protected final double[] min

max

protected final double[] max

Constructor Detail

RealPointSampleList

public RealPointSampleList(int n)

Parameters:

n - - number of dimensions

Method Detail

add

public void add(RealPoint position,
                T sample)

cursor

public RealCursor<T> cursor()

Description copied from interface: IterableRealInterval

Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

Use this where localization is required rarely/ not for each iteration.

Specified by:

cursor in interface IterableRealInterval<T>

Returns:

fast iterating iterator

iterationOrder

public java.lang.Object iterationOrder()

Description copied from interface: IterableRealInterval

Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.

Specified by:

iterationOrder in interface IterableRealInterval<T>

Returns:

the iteration order of this IterableRealInterval.

See Also:

FlatIterationOrder

firstElement

public T firstElement()

Description copied from interface: IterableRealInterval

Get the first element of this IterableRealInterval. This is a shortcut for cursor().next().

This can be used to create a new variable of type T using firstElement().createVariable(), which is useful in generic methods to store temporary results, e.g., a running sum over pixels in the IterableRealInterval.

Specified by:

firstElement in interface IterableRealInterval<T>

Returns:

the first element in iteration order.

localizingCursor

public RealCursor<T> localizingCursor()

Description copied from interface: IterableRealInterval

Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.

Use this where localization is required often/ for each iteration.

Specified by:

localizingCursor in interface IterableRealInterval<T>

Returns:

fast localizing iterator

size

public long size()

Description copied from interface: IterableRealInterval

Returns the number of elements in this Function.

Specified by:

size in interface IterableRealInterval<T>

Returns:

number of elements

getType

public T getType()

Description copied from interface: IterableRealInterval

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.

The default implementation returns IterableRealInterval.firstElement(). Derived classes may choose different implementations for improved performance.

Specified by:

getType in interface IterableRealInterval<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T

realMax

public double realMax(int d)

Description copied from interface: RealInterval

Get the maximum in dimension d.

Specified by:

realMax in interface RealInterval

Parameters:

d - dimension

Returns:

maximum in dimension d.

realMax

public void realMax(double[] m)

Description copied from interface: RealInterval

Write the maximum of each dimension into double[].

Specified by:

realMax in interface RealInterval

realMax

public void realMax(RealPositionable m)

Description copied from interface: RealInterval

Sets a RealPositionable to the maximum of this Interval

Specified by:

realMax in interface RealInterval

realMin

public double realMin(int d)

Description copied from interface: RealInterval

Get the minimum in dimension d.

Specified by:

realMin in interface RealInterval

Parameters:

d - dimension

Returns:

minimum in dimension d.

realMin

public void realMin(double[] m)

Description copied from interface: RealInterval

Write the minimum of each dimension into double[].

Specified by:

realMin in interface RealInterval

realMin

public void realMin(RealPositionable m)

Description copied from interface: RealInterval

Sets a RealPositionable to the minimum of this Interval

Specified by:

realMin in interface RealInterval

numDimensions

public int numDimensions()

Description copied from interface: EuclideanSpace

Gets the space's number of dimensions.

Specified by:

numDimensions in interface EuclideanSpace