io.scif.img

Class ImageRegion

java.lang.Object

io.scif.img.ImageRegion

public class ImageRegion
extends Object

A list of dimensional ranges. Each range is associated with a particular AxisType, and is used to restrict the indices that are read in the corresponding planes.

NB: Subregions must be continuous in the Axes.X and Axes.Y dimensions. Discontinuous tiles require multiple openings.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
ImageRegion(net.imagej.axis.AxisType[] axes, Range... ranges)
ImageRegion(net.imagej.axis.AxisType[] axes, String[] ranges)
ImageRegion(Map<net.imagej.axis.AxisType,Range> ranges)

Method Summary

Modifier and Type	Method and Description
void	addRange(net.imagej.axis.AxisType axis, String range)
Range	getRange(net.imagej.axis.AxisType axisType)
boolean	hasRange(net.imagej.axis.AxisType axisType)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRegion

public ImageRegion(net.imagej.axis.AxisType[] axes,
                   String[] ranges)

ImageRegion

public ImageRegion(net.imagej.axis.AxisType[] axes,
                   Range... ranges)

ImageRegion

public ImageRegion(Map<net.imagej.axis.AxisType,Range> ranges)

Method Detail

addRange

public void addRange(net.imagej.axis.AxisType axis,
                     String range)

Parameters:

range - Dimensional range to add to this SubRegion

getRange

public Range getRange(net.imagej.axis.AxisType axisType)

Returns:

A list of indices for the specified dimension

hasRange

public boolean hasRange(net.imagej.axis.AxisType axisType)

Returns:

True if this SubRegion contains a range for the specified AxisType

size

public int size()

Returns:

Number of ranges in this SubRegion