net.imagej.sampler

Class AxisSubrange

java.lang.Object

net.imagej.sampler.AxisSubrange

public class AxisSubrange
extends Object

An AxisSubrange defines a set of position indices using various constructors. A set of position indices might look like this: 1, 3, 6, 7, 8, 25, 44. These indices are used to iterate over a subset of an image.

Author:

Barry DeZonia

Constructor Summary

Constructors

Constructor and Description
AxisSubrange(ImageDisplay display, AxisType axis, String definition, boolean originOne) Create an AxisSubrange from a String definition.
AxisSubrange(long pos) Create an AxisSubrange from a single value.
AxisSubrange(long pos1, long pos2) Create an AxisSubrange from one position to another position and everything in between.
AxisSubrange(long pos1, long pos2, long by) Create an AxisSubrange from one position to another position stepping by a given value.

Method Summary

Modifier and Type	Method and Description
String	getError()
List<Long>	getIndices()

Methods inherited from class java.lang.Object

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

Constructor Detail

AxisSubrange

public AxisSubrange(long pos)

Create an AxisSubrange from a single value.

Parameters:

pos - The single index position

AxisSubrange

public AxisSubrange(long pos1,
                    long pos2)

Create an AxisSubrange from one position to another position and everything in between. Whether position 1 is less or greater than position 2 does not matter.

Parameters:

pos1 - The first index position of the range

pos2 - The second index position of the range

AxisSubrange

public AxisSubrange(long pos1,
                    long pos2,
                    long by)

Create an AxisSubrange from one position to another position stepping by a given value. The order of the two positions does matter. The "by" step must not be 0 but can be negative.

Parameters:

pos1 - The first index position

pos2 - The second index position

by - The amount to step by between positions

AxisSubrange

public AxisSubrange(ImageDisplay display,
                    AxisType axis,
                    String definition,
                    boolean originOne)

Create an AxisSubrange from a String definition. The definition is a textual language that allows one or more positions to be defined by one or more comma separated values. Some examples:

• "1" : plane 1
• "3,5" : planes 3 and 5
• "1-10" : planes 1 through 10
• "1-10,20-30" : planes 1 through 10 and 20 through 30
• "1-10-2,20-30-3" : planes 1 through 10 by 2 and planes 20 through 30 by 3
• "1,3-5,12-60-6" : an example combining all three formats

Parameters:

display - The ImageDisplay used to set legal bounds on dimension sizes

axis - The AxisType within the ImageDisplay that defines bounds

definition - The textual description of the subrange (detailed elsewhere)

originOne - A boolean specifying whether the origin within the String language should be treated as 0 based or 1 based.

Method Detail

getError

public String getError()

getIndices

public List<Long> getIndices()