Sampler (ImgLib2 Javadocs 0-SNAPSHOT API)

All Known Subinterfaces:

BSplineCoefficientsInterpolator<T>, Cursor<T>, OutOfBounds<T>, ProjectedSampler<T>, RandomAccess<T>, RealCursor<T>, RealOutOfBounds<T>, RealRandomAccess<T>

All Known Implementing Classes:

AbstractArrayCursor, AbstractArrayLocalizingCursor, AbstractConvertedCursor, AbstractConvertedRandomAccess, AbstractConvertedRealCursor, AbstractConvertedRealRandomAccess, AbstractCursor, AbstractCursorInt, AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor, AbstractLocalizingCursor, AbstractLocalizingCursorInt, AbstractLongListImg.LongListCursor, AbstractLongListImg.LongListLocalizingCursor, AbstractLongListImg.LongListRandomAccess, AbstractNeighborhoodCursor, AbstractOutOfBoundsMirror, AbstractOutOfBoundsValue, AbstractRegionOfInterest.AROIRandomAccess, AbstractUnsafeCursor, AbstractUnsafeLocalizingCursor, AffineRandomAccessible.AffineRandomAccess, AffineRealRandomAccessible.AffineRealRandomAccess, ArrayCursor, ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor, ArrayRandomAccess, ArraySubIntervalCursor, BiConvertedCursor, BiConvertedRandomAccess, BiConvertedRealCursor, BiConvertedRealRandomAccess, BinaryMaskRegionOfInterest.BMROIIterableInterval.BMROICursor, BoundaryRandomAccess4, BoundaryRandomAccess8, BresenhamLine, BSplineCoefficientsInterpolatorEven, BSplineCoefficientsInterpolatorOdd, BSplineInterpolator, BufferedRectangularNeighborhoodCursor, CellCursor, CellLocalizingCursor, CellRandomAccess, CircleCursor, ClampingNLinearInterpolatorRealType, ClampingNLinearInterpolatorVolatileARGB, ClampingNLinearInterpolatorVolatileRealType, CompositeView.CompositeRandomAccess, ConvertedCursor, ConvertedRandomAccess, ConvertedRealCursor, ConvertedRealRandomAccess, DiamondNeighborhood.LocalCursor, DiamondNeighborhoodCursor, DiamondNeighborhoodLocalizableSampler, DiamondNeighborhoodRandomAccess, DiamondTipsNeighborhood.LocalCursor, DiamondTipsNeighborhoodCursor, DiamondTipsNeighborhoodLocalizableSampler, DiamondTipsNeighborhoodRandomAccess, EllipseCursor, EllipseCursor, EllipsoidCursor, FloorInterpolator, FullSourceMapMixedRandomAccess, FullSourceMapSlicingRandomAccess, FunctionCursor, FunctionCursorDouble, FunctionCursorDoubleIncompatibleOrder, FunctionCursorIncompatibleOrder, FunctionRandomAccess, FunctionRandomAccessDouble, FunctionRandomAccessible.FunctionRandomAccess, FunctionRealRandomAccessible.RealFunctionRealRandomAccess, HorizontalLineNeighborhood.LocalCursor, HorizontalLineNeighborhoodCursor, HorizontalLineNeighborhoodLocalizableSampler, HorizontalLineNeighborhoodRandomAccess, HyperSlice.HyperSliceRandomAccess, HyperSlicesView.HyperSlicesViewRandomAccess, HyperSphereCursor, HyperSphereNeighborhood.LocalCursor, HyperSphereNeighborhoodCursor, HypersphereNeighborhoodLocalizableSampler, HyperSphereNeighborhoodRandomAccess, IntervalSampler, InverseDistanceWeightingInterpolator, IterationCodeCursor, IterationCodeListCursor, KDTree.KDTreeCursor, KDTree.SamplerNode, KDTree.ValueNode, KDTreeNode, KDTreeRadiusSource, LabelingConvertedCursor, LabelingConvertedRandomAccess, LabelingOutOfBoundsRandomAccess, LabelRegionCursor, LabelRegionRandomAccess, LanczosInterpolator, LinearRealRandomAccessibleStackInterpolator, ListCursor, ListLocalizingCursor, ListRandomAccess, LocalNeighborhoodCursor, LocalNeighborhoodCursor, LocalNeighborhoodCursor2, MaskPredicateRandomAccess, MaskPredicateRealRandomAccess, MixedRandomAccess, NearestNeighborInterpolator, NearestNeighborRealRandomAccessibleStackInterpolator, NearestNeighborSearchInterpolator, NLinearInterpolator, NLinearInterpolator1D, NLinearInterpolator2D, NLinearInterpolator3D, NLinearInterpolatorARGB, NtreeCursor, NtreeRandomAccess, OutOfBoundsBorder, OutOfBoundsConstantValue, OutOfBoundsMirrorDoubleBoundary, OutOfBoundsMirrorExpWindowing, OutOfBoundsMirrorSingleBoundary, OutOfBoundsPeriodic, OutOfBoundsRandomValue, PairOfPointsNeighborhood.LocalCursor, PairOfPointsNeighborhoodCursor, PairOfPointsNeighborhoodLocalizableSampler, PairOfPointsNeighborhoodRandomAccess, PeriodicLineNeighborhood.LocalCursor, PeriodicLineNeighborhoodCursor, PeriodicLineNeighborhoodLocalizableSampler, PeriodicLineNeighborhoodRandomAccess, PlanarCursor, PlanarCursor1D, PlanarCursor2D, PlanarLocalizingCursor, PlanarLocalizingCursor1D, PlanarLocalizingCursor2D, PlanarPlaneSubsetCursor, PlanarPlaneSubsetLocalizingCursor, PlanarRandomAccess, PlanarRandomAccess1D, PointSampleList.PointSampleListCursor, PositionRandomAccessible.PositionRandomAccess, PositionRandomAccessible.PositionRandomAccess, RandomAccessibleIntervalCursor, RandomAccessibleOnRealRandomAccessible.RandomAccessOnRealRandomAccessible, RandomAccessiblePair.RandomAccess, RandomAccessibleRegionCursor, RealOutOfBoundsRealRandomAccess, RealPointSampleList.RealPointSampleListCursor, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealPositionRealRandomAccessible.RealPositionRealRandomAccess, RealTransformRandomAccessible.RealTransformRandomAccess, RealTransformRealRandomAccessible.RealTransformRealRandomAccess, RectangleCursor, RectangleNeighborhood.LocalCursor, RectangleNeighborhoodCursor, RectangleNeighborhoodLocalizableSampler, RectangleNeighborhoodRandomAccess, RectangleNeighborhoodSkipCenter.LocalCursor, SamplingCursor, SamplingLineIterator, ScaleAsFunctionOfPosition.ScaledRandomAccess, SelectiveSampler, SlicingCursor, SlicingRandomAccess, StackingRealRandomAccessible.StackingRealRandomAccess, StackView.DefaultRA, StackView.MoveAllSlicesRA, SubsampleView.SubsampleRandomAccess, TransformRandomAccess, TranslationRandomAccess, UnsafeCursor, UnsafeLocalizingCursor, UnsafeLocalizingSubIntervalCursor, UnsafeRandomAccess, UnsafeSubIntervalCursor, WriteConvertedCursor, WriteConvertedRandomAccess, WriteConvertedRealCursor
```
public interface Sampler<T>
```
The Sampler interface provides access to a value whose type is specified by the generic parameter T. This T may point to an actual Object as stored in a Collection, a proxy Object that allows reading and writing pixel data of an image (e.g. all NativeTypes), or a proxy Object whose content is generated otherwise and may only be readable (e.g. ShapeList2D).

Author:

Tobias Pietzsch, Stephan Preibisch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Sampler<T>`	`copy()`
`T`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.

- Method Detail
  - get
```
T get()
```
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
  - copy
```
Sampler<T> copy()
```
    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)

Interface Sampler<T>

Method Summary

Method Detail

get

copy