Class IntervalSampler<T>

java.lang.Object

net.imglib2.display.projector.sampler.IntervalSampler<T>

Type Parameters:

T -

All Implemented Interfaces:

ProjectedSampler<T>, Iterator, Sampler<T>, Typed<T>

public class IntervalSampler<T>
extends Object
implements ProjectedSampler<T>

allows stepwise access to a preselected projected dimension.

Field Summary

Fields

Modifier and Type	Field	Description
private final long	m_endPosition
private final int	m_projectionDimension
private RandomAccess<T>	m_source
private final long	m_startPosition

Constructor Summary

Constructors

Constructor	Description
IntervalSampler(int projectionDimension, long startPosition, long endPosition)

Method Summary

Modifier and Type	Method	Description
Sampler<T>	copy()
void	fwd()	Move forward.
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.
boolean	hasNext()	Returns true if another step forward is possible.
void	reset()	Reset the Iterator, that is put it to where it would be if newly created.
void	setRandomAccess(RandomAccess<T> srcAccess)

Methods inherited from class Object

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

Methods inherited from interface Iterator

jumpFwd

Field Details

m_projectionDimension

private final int m_projectionDimension

m_startPosition

private final long m_startPosition

m_endPosition

private final long m_endPosition

m_source

private RandomAccess<T> m_source

Constructor Details

IntervalSampler

public IntervalSampler(int projectionDimension,
 long startPosition,
 long endPosition)

Method Details

fwd

public void fwd()

Description copied from interface: Iterator

Move forward.

Specified by:

fwd in interface Iterator

reset

public void reset()

Description copied from interface: Iterator

Reset the Iterator, that is put it to where it would be if newly created.

Specified by:

reset in interface Iterator

hasNext

public boolean hasNext()

Description copied from interface: Iterator

Returns true if another step forward is possible.

Specified by:

hasNext in interface Iterator

Returns:

true, if there is another step forward is possible, otherwise false

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 Sampler<T> copy()

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)

setRandomAccess

public void setRandomAccess(RandomAccess<T> srcAccess)

Specified by:

setRandomAccess in interface ProjectedSampler<T>

Parameters:

srcAccess - sets the random access from which the sampler takes the values of the projected dimension