net.imagej

Class Extents

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractInterval

net.imagej.Extents

All Implemented Interfaces:

Dimensions, EuclideanSpace, Interval, RealInterval

public class Extents
extends AbstractInterval

This class wraps a pair of min and max dimensions encoded as long[]'s. It facilitates the creation of Position indexes for iterating within the Extents.

Author:

Barry DeZonia

Field Summary

Fields inherited from class net.imglib2.AbstractInterval

max, min

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor and Description
Extents(long[] dims) Constructor that takes a dimensional extent and sets min to a zero origin and each max dim i to dims[i]-1.
Extents(long[] min, long[] max) Constructor that takes min and max extents.

Method Summary

Modifier and Type	Method and Description
Position	createPosition() Returns a Position object that can be used to iterate these Extents.
long	numElements() Returns the total number of elements spanned by the parent Extents.
String	toString()

Methods inherited from class net.imglib2.AbstractInterval

dimension, dimensions, max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class net.imglib2.AbstractEuclideanSpace

numDimensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Constructor Detail

Extents

public Extents(long[] dims)

Constructor that takes a dimensional extent and sets min to a zero origin and each max dim i to dims[i]-1.

Extents

public Extents(long[] min,
               long[] max)

Constructor that takes min and max extents. No checking is done that min <= max for all dim i.

Method Detail

createPosition

public Position createPosition()

Returns a Position object that can be used to iterate these Extents.

numElements

public long numElements()

Returns the total number of elements spanned by the parent Extents.

toString

public String toString()

Overrides:

toString in class Object