Package net.imglib2.img.planar
Class PlanarRandomAccess<T extends NativeType<T>>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractLocalizableInt
-
- net.imglib2.img.planar.PlanarRandomAccess<T>
-
- Type Parameters:
T
-
- All Implemented Interfaces:
EuclideanSpace
,PlanarImg.PlanarContainerSampler
,Localizable
,Positionable
,RandomAccess<T>
,RealLocalizable
,Sampler<T>
- Direct Known Subclasses:
PlanarRandomAccess1D
public class PlanarRandomAccess<T extends NativeType<T>> extends AbstractLocalizableInt implements RandomAccess<T>, PlanarImg.PlanarContainerSampler
RandomAccess
on aPlanarImg
.- Author:
- Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch
-
-
Field Summary
Fields Modifier and Type Field Description protected int
sliceIndex
protected int[]
sliceSteps
protected T
type
protected int
width
-
Fields inherited from class net.imglib2.AbstractLocalizableInt
position
-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Modifier Constructor Description PlanarRandomAccess(PlanarImg<T,?> container)
protected
PlanarRandomAccess(PlanarRandomAccess<T> randomAccess)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bck(int d)
Move by -1 in one dimension.PlanarRandomAccess<T>
copy()
PlanarRandomAccess<T>
copyRandomAccess()
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 theSampler
points at.int
getCurrentSliceIndex()
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
setPosition(int[] pos)
Set the position of the element.void
setPosition(int pos, int d)
Set the position of the element for one dimension.void
setPosition(long[] pos)
Set the position of the element.void
setPosition(long pos, 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
-
Methods inherited from class net.imglib2.AbstractLocalizableInt
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize
-
Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
-
Methods inherited from interface net.imglib2.Localizable
getIntPosition, getLongPosition, localize, localize
-
Methods inherited from interface net.imglib2.RealLocalizable
getDoublePosition, getFloatPosition, localize, localize
-
-
-
-
Field Detail
-
sliceSteps
protected final int[] sliceSteps
-
width
protected final int width
-
type
protected final T extends NativeType<T> type
-
sliceIndex
protected int sliceIndex
-
-
Constructor Detail
-
PlanarRandomAccess
protected PlanarRandomAccess(PlanarRandomAccess<T> randomAccess)
-
-
Method Detail
-
getCurrentSliceIndex
public int getCurrentSliceIndex()
- Specified by:
getCurrentSliceIndex
in interfacePlanarImg.PlanarContainerSampler
- Returns:
- the index of the slice the sampler is currently accessing.
-
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 theSampler
points at.- Specified by:
get
in interfaceSampler<T extends NativeType<T>>
-
copy
public PlanarRandomAccess<T> copy()
- Specified by:
copy
in interfaceSampler<T extends NativeType<T>>
- Returns:
- - A new
Sampler
in the same state accessing the same values. It does NOT copy T, just the state of theSampler
. 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 anArrayCursor
for example)
-
copyRandomAccess
public PlanarRandomAccess<T> copyRandomAccess()
- Specified by:
copyRandomAccess
in interfaceRandomAccess<T extends NativeType<T>>
-
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(int pos, int d)
Description copied from interface:Positionable
Set the position of the element for one dimension.- Specified by:
setPosition
in interfacePositionable
- Parameters:
pos
- absolute position in dimension dd
- dimension
-
setPosition
public void setPosition(long pos, int d)
Description copied from interface:Positionable
Set the position of the element for one dimension.- Specified by:
setPosition
in interfacePositionable
- Parameters:
pos
- absolute position in dimension dd
- dimension
-
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[] pos)
Description copied from interface:Positionable
Set the position of the element.- Specified by:
setPosition
in interfacePositionable
- Parameters:
pos
- absolute position, length must be ≥EuclideanSpace.numDimensions()
-
setPosition
public void setPosition(long[] pos)
Description copied from interface:Positionable
Set the position of the element.- Specified by:
setPosition
in interfacePositionable
- Parameters:
pos
- absolute position, length must be ≥EuclideanSpace.numDimensions()
-
-