Interval (ImgLib2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

Dimensions, EuclideanSpace, RealInterval

All Known Subinterfaces:

Img<T>, IterableInterval<T>, IterableRegion<T>, Labeling<T>, MaskInterval, NativeImg<T,A>, NativeLabeling<T>, NativeLongAccessImg<T,A>, Neighborhood<T>, PositionableIterableInterval<T>, PositionableIterableRegion<T>, RandomAccessibleInterval<T>

All Known Implementing Classes:

AbstractCellImg, AbstractConvertedIterableInterval, AbstractConvertedIterableRandomAccessibleInterval, AbstractConvertedRandomAccessibleInterval, AbstractImg, AbstractInterval, AbstractIterableRegionOfInterest.AROIClippedIterableInterval, AbstractIterableRegionOfInterest.AROIIterableInterval, AbstractLabeling, AbstractListImg, AbstractLongListImg, AbstractNativeImg, AbstractNativeLabeling, AbstractNativeLongAccessImg, AbstractNeighborhood, AbstractWrappedInterval, ARGBScreenImage, ArrayImg, ArrayImgAWTScreenImage, BiConvertedIterableInterval, BiConvertedRandomAccessibleInterval, BinaryMaskRegionOfInterest.BMROIIterableInterval, Boundary, BoundingBox, Bounds.AbstractAdaptingInterval, Bounds.IntersectionInterval, Bounds.SmallestContainingInterval, Bounds.UnionInterval, BufferedRectangularNeighborhood, ByteAWTScreenImage, ByteImagePlus, CachedCellImg, Cell, CellImg, CompositeIntervalView, ConvertedIterableInterval, ConvertedRandomAccessibleInterval, DefaultBinaryCompositeMaskInterval, DefaultMaskInterval, DefaultUnaryCompositeMaskInterval, DiamondNeighborhood, DiamondNeighborhoodUnsafe, DiamondShape.NeighborhoodsIterableInterval, DiamondTipsNeighborhood, DiamondTipsNeighborhoodUnsafe, DiamondTipsShape.NeighborhoodsIterableInterval, DiscreteFrequencyDistribution, DiskCachedCellImg, DoubleAWTScreenImage, EllipseNeighborhood, EllipsoidNeighborhood, FinalInterval, FloatAWTScreenImage, FloatImagePlus, Histogram1d, HistogramNd, HorizontalLineNeighborhood, HorizontalLineNeighborhoodUnsafe, HorizontalLineShape.NeighborhoodsIterableInterval, HyperSphere, HyperSphereNeighborhood, HyperSphereNeighborhoodGPL, HyperSphereNeighborhoodUnsafe, HyperSphereShape.NeighborhoodsIterableInterval, ImagePlusImg, ImgLabeling, ImgView, IntAWTScreenImage, IntervalIterator, IntervalView, IntImagePlus, IterableLine, IterableRandomAccessibleFunction, IterableRandomAccessibleFunctionDouble, IterableRandomAccessibleInterval, IterableRandomAccessibleRegion, IterableRegionOnBooleanRAI, LabelingView, LabelRegion, LazyCellImg, LazyCellImg.LazyCells, ListImg, LocalizingIntervalIterator, LocalizingZeroMinIntervalIterator, LocalNeighborhood, LocalNeighborhood2, MaskIntervalAsRandomAccessibleInterval, NativeImgLabeling, NtreeCursor, NtreeImg, OffsetableIntervalIterator, OffsetableLocalizingIntervalIterator, PairOfPointsNeighborhood, PairOfPointsNeighborhoodUnsafe, PairOfPointsShape.NeighborhoodsIterableInterval, PeriodicLineNeighborhood, PeriodicLineNeighborhoodUnsafe, PeriodicLineShape.NeighborhoodsIterableInterval, PlanarImg, PointSampleList, PositionableInterval, PositionableWrappedIterableInterval, PositionableWrappedIterableRegion, RandomAccessibleIntervalAsMaskInterval, RandomAccessibleIntervalCursor, RandomAccessibleRegionCursor, RectangleNeighborhood, RectangleNeighborhoodGPL, RectangleNeighborhoodSkipCenter, RectangleNeighborhoodSkipCenterUnsafe, RectangleNeighborhoodUnsafe, RectangleShape.NeighborhoodsIterableInterval, SamplingIterableInterval, ShortAWTScreenImage, ShortImagePlus, SingleCellArrayImg, StackView, SubsampleIntervalView, UnsafeImg, UnsignedByteAWTScreenImage, UnsignedIntAWTScreenImage, UnsignedShortAWTScreenImage, WriteConvertedIterableInterval, WriteConvertedIterableRandomAccessibleInterval, WriteConvertedRandomAccessibleInterval, ZeroMinIntervalIterator
```
public interface Interval
extends RealInterval, Dimensions
```
{x∈Zⁿ|min_d≤ x_d≤max_d;d∈{0… n-1}}

An Interval over the discrete source domain. Note that this does not imply that for all coordinates in the Interval function values exist or can be generated. It only defines where the minimum and maximum source coordinates are. E.g. an IterableInterval has a limited number of values and a source coordinate for each. By that, minimum and maximum are defined but the Interval does not define a value for all coordinates in between.

Author:

Stephan Saalfeld, Stephan Preibisch

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default long`	`dimension(int d)` Default implementation of `Dimensions.dimension(int)`.
`long`	`max(int d)` Get the maximum in dimension d.
`default void`	`max(long[] max)` Write the maximum of each dimension into long[].
`default void`	`max(Positionable max)` Sets a `Positionable` to the maximum of this `Interval`
`default long[]`	`maxAsLongArray()` Allocates a new long array with the maximum of this Interval.
`default Point`	`maxAsPoint()` Allocates a new `Point` with the maximum of this Interval.
`long`	`min(int d)` Get the minimum in dimension d.
`default void`	`min(long[] min)` Write the minimum of each dimension into long[].
`default void`	`min(Positionable min)` Sets a `Positionable` to the minimum of this `Interval`
`default long[]`	`minAsLongArray()` Allocates a new long array with the minimum of this Interval.
`default Point`	`minAsPoint()` Allocates a new `Point` with the maximum of this Interval.
`default double`	`realMax(int d)` Default implementation of `RealInterval.realMax(int)`.
`default double`	`realMin(int d)` Default implementation of `RealInterval.realMin(int)`.

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

Methods inherited from interface net.imglib2.Dimensions
allPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Method Detail
  - min
```
long min(int d)
```
    Get the minimum in dimension d.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - min
```
default void min(long[] min)
```
    Write the minimum of each dimension into long[].
    
    Parameters:
    
    min -
  - min
```
default void min(Positionable min)
```
    Sets a Positionable to the minimum of this Interval
    
    Parameters:
    
    min -
  - max
```
long max(int d)
```
    Get the maximum in dimension d.
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - max
```
default void max(long[] max)
```
    Write the maximum of each dimension into long[].
    
    Parameters:
    
    max -
  - max
```
default void max(Positionable max)
```
    Sets a Positionable to the maximum of this Interval
    
    Parameters:
    
    max -
  - realMin
```
default double realMin(int d)
```
    Default implementation of RealInterval.realMin(int).
    
    Specified by:
    
    realMin in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    minimum in dimension d.
  - realMax
```
default double realMax(int d)
```
    Default implementation of RealInterval.realMax(int).
    
    Specified by:
    
    realMax in interface RealInterval
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    maximum in dimension d.
  - dimension
```
default long dimension(int d)
```
    Default implementation of Dimensions.dimension(int).
    
    Specified by:
    
    dimension in interface Dimensions
  - minAsLongArray
```
default long[] minAsLongArray()
```
    Allocates a new long array with the minimum of this Interval. Please note that his method allocates a new array each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated array first and reuse it with min(long[]).
    
    Returns:
    
    the min
  - minAsPoint
```
default Point minAsPoint()
```
    Allocates a new Point with the maximum of this Interval. Please note that his method allocates a new Point each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated Point first and reuse it with min(Positionable).
    
    Returns:
    
    the min
  - maxAsLongArray
```
default long[] maxAsLongArray()
```
    Allocates a new long array with the maximum of this Interval. Please note that his method allocates a new array each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated array first and reuse it with max(long[]).
    
    Returns:
    
    the max
  - maxAsPoint
```
default Point maxAsPoint()
```
    Allocates a new Point with the maximum of this Interval. Please note that his method allocates a new Point each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated Point first and reuse it with max(Positionable).
    
    Returns:
    
    the max

Interface Interval

Method Summary

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.Dimensions

Methods inherited from interface net.imglib2.EuclideanSpace

Method Detail

min

min

min

max

max

max

realMin

realMax

dimension

minAsLongArray

minAsPoint

maxAsLongArray

maxAsPoint