icy.roi

Class ROIIterator

java.lang.Object

icy.roi.ROIIterator

All Implemented Interfaces:

Position5DIterator

public class ROIIterator
extends java.lang.Object
implements Position5DIterator

ROI iterator.
This class permit to use simple iterator to navigate each point of specified ROI in XYCZT ([T[Z[C[Y[X]]]]]) dimension order.
If the ROI is modified during iteration the iterator becomes invalid and exception can happen.

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
ROIIterator(ROI roi, boolean inclusive) Create a new ROI iterator to iterate through each point of the specified ROI.
ROIIterator(ROI roi, Rectangle5D region, boolean inclusive) Create a new ROI iterator to iterate through each point of the specified ROI.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	done() Returns true if the iterator has no more elements.
Point5D	get()
int	getC()
int	getMaxC()
int	getMaxT()
int	getMaxZ()
int	getMinC()
int	getMinT()
int	getMinZ()
int	getT()
int	getX()
int	getY()
int	getZ()
void	next() Pass to the next element.
void	reset() Reset iterator to initial position.

Methods inherited from class java.lang.Object

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

Constructor Detail

ROIIterator

public ROIIterator(ROI roi,
           Rectangle5D region,
           boolean inclusive)

Create a new ROI iterator to iterate through each point of the specified ROI.

Parameters:

roi - ROI defining the region to iterate.

region - A 5D region to limit the ROI region area to iterate for.
Keep it to null to iterate all over the ROI.

inclusive - If true then all partially contained (intersected) pixels in the ROI are included.

ROIIterator

public ROIIterator(ROI roi,
           boolean inclusive)

Create a new ROI iterator to iterate through each point of the specified ROI.

Parameters:

roi - ROI defining the region to iterate.

inclusive - If true then all partially contained (intersected) pixels in the ROI are included.

Method Detail

getMinZ

public int getMinZ()

getMaxZ

public int getMaxZ()

getMinT

public int getMinT()

getMaxT

public int getMaxT()

getMinC

public int getMinC()

getMaxC

public int getMaxC()

reset

public void reset()

Description copied from interface: Position5DIterator

Reset iterator to initial position.

Specified by:

reset in interface Position5DIterator

next

public void next()

Description copied from interface: Position5DIterator

Pass to the next element.

Specified by:

next in interface Position5DIterator

done

public boolean done()

Description copied from interface: Position5DIterator

Returns true if the iterator has no more elements.

Specified by:

done in interface Position5DIterator

get

public Point5D get()

Specified by:

get in interface Position5DIterator

Returns:

the current position of the iterator

getX

public int getX()

Specified by:

getX in interface Position5DIterator

Returns:

the current position X of the iterator

getY

public int getY()

Specified by:

getY in interface Position5DIterator

Returns:

the current position Y of the iterator

getC

public int getC()

Specified by:

getC in interface Position5DIterator

Returns:

the current position C of the iterator

getZ

public int getZ()

Specified by:

getZ in interface Position5DIterator

Returns:

the current position Z of the iterator

getT

public int getT()

Specified by:

getT in interface Position5DIterator

Returns:

the current position T of the iterator