icy.image

Class ImageDataIterator

java.lang.Object

icy.image.ImageDataIterator

All Implemented Interfaces:

DataIterator

public class ImageDataIterator
extends java.lang.Object
implements DataIterator

Image data iterator.
This class permit to use simple iterator to read / write IcyBufferedImage data
as double in XYC ([C[Y[X]]]) dimension order .
Whatever is the internal DataType data is returned and set as double.
If the image size or type is modified during iteration the iterator becomes invalid and can causes exception to happen.

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
ImageDataIterator(IcyBufferedImage image) Deprecated. Use ImageDataIterator(IcyBufferedImage, int) instead. The ImageDataIterator iterate only on single channel data.
ImageDataIterator(IcyBufferedImage image, BooleanMask2D maskXY) Deprecated. Use ImageDataIterator(IcyBufferedImage, BooleanMask2D, int) instead
ImageDataIterator(IcyBufferedImage image, BooleanMask2D maskXY, int channel) Create a new ImageData iterator to iterate data through the specified BooleanMask2D and C dimension.
ImageDataIterator(IcyBufferedImage image, int c) Create a new ImageData iterator to iterate data of specified channel.
ImageDataIterator(IcyBufferedImage image, int startX, int endX, int startY, int endY, int c) Deprecated. Use ImageDataIterator(IcyBufferedImage, Rectangle, int) instead.
ImageDataIterator(IcyBufferedImage image, int startX, int endX, int startY, int endY, int startC, int endC) Deprecated. Use ImageDataIterator(IcyBufferedImage, Rectangle, int) instead.
ImageDataIterator(IcyBufferedImage image, java.awt.Rectangle boundsXY, int channel) Create a new ImageData iterator to iterate data through the specified XY region and channel.
ImageDataIterator(IcyBufferedImage image, ROI roi) Deprecated. Use ImageDataIterator(IcyBufferedImage, BooleanMask2D, int) instead. You can use the ROI.getBooleanMask2D(int, int, int, boolean) method to retrieve the boolean mask from the ROI.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	done() Returns true if the iterator has no more elements.
void	flush()
double	get() Returns the current element in the iteration.
int	getC() Returns C position (fixed)
int	getMaxX()
int	getMaxY()
int	getMinX()
int	getMinY()
int	getPositionC() Deprecated. Use getC() instead
int	getPositionX() Deprecated. Use getX() instead
int	getPositionY() Deprecated. Use getY() instead
int	getX() Returns current X position.
int	getY() Returns current Y position.
void	next() Pass to the next element.
void	reset() Reset iterator to initial position.
void	set(double value) Sets the current element in the iteration and pass to the next.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDataIterator

public ImageDataIterator(IcyBufferedImage image,
                 java.awt.Rectangle boundsXY,
                 int channel)

Create a new ImageData iterator to iterate data through the specified XY region and channel.

Parameters:

image - Image we want to iterate data from

boundsXY - XY region to iterate (inclusive).

channel - channel (C position) we want to iterate data

ImageDataIterator

@Deprecated
public ImageDataIterator(IcyBufferedImage image,
                            int startX,
                            int endX,
                            int startY,
                            int endY,
                            int startC,
                            int endC)

Deprecated. Use ImageDataIterator(IcyBufferedImage, Rectangle, int) instead.

ImageDataIterator

@Deprecated
public ImageDataIterator(IcyBufferedImage image,
                            int startX,
                            int endX,
                            int startY,
                            int endY,
                            int c)

Deprecated. Use ImageDataIterator(IcyBufferedImage, Rectangle, int) instead.

ImageDataIterator

public ImageDataIterator(IcyBufferedImage image,
                 int c)

Create a new ImageData iterator to iterate data of specified channel.

Parameters:

image - Image we want to iterate data from

c - C position (channel) we want to iterate data

ImageDataIterator

@Deprecated
public ImageDataIterator(IcyBufferedImage image)

Deprecated. Use ImageDataIterator(IcyBufferedImage, int) instead.
The ImageDataIterator iterate only on single channel data.

ImageDataIterator

public ImageDataIterator(IcyBufferedImage image,
                 BooleanMask2D maskXY,
                 int channel)

Create a new ImageData iterator to iterate data through the specified BooleanMask2D and C dimension.

Parameters:

image - Image we want to iterate data from

maskXY - BooleanMask2D defining the XY region to iterate

channel - channel (C position) we want to iterate data

ImageDataIterator

@Deprecated
public ImageDataIterator(IcyBufferedImage image,
                            BooleanMask2D maskXY)

Deprecated. Use ImageDataIterator(IcyBufferedImage, BooleanMask2D, int) instead

ImageDataIterator

@Deprecated
public ImageDataIterator(IcyBufferedImage image,
                            ROI roi)

Deprecated. Use ImageDataIterator(IcyBufferedImage, BooleanMask2D, int) instead. You can use the ROI.getBooleanMask2D(int, int, int, boolean) method to retrieve the boolean mask from the ROI.

Method Detail

getMinX

public int getMinX()

getMaxX

public int getMaxX()

getMinY

public int getMinY()

getMaxY

public int getMaxY()

reset

public void reset()

Description copied from interface: DataIterator

Reset iterator to initial position.

Specified by:

reset in interface DataIterator

next

public void next()

Description copied from interface: DataIterator

Pass to the next element.

Specified by:

next in interface DataIterator

done

public boolean done()

Description copied from interface: DataIterator

Returns true if the iterator has no more elements.

Specified by:

done in interface DataIterator

get

public double get()

Description copied from interface: DataIterator

Returns the current element in the iteration.

Specified by:

get in interface DataIterator

Returns:

the current element in the iteration.

set

public void set(double value)

Description copied from interface: DataIterator

Sets the current element in the iteration and pass to the next.

Specified by:

set in interface DataIterator

getX

public int getX()

Returns current X position.

getY

public int getY()

Returns current Y position.

getC

public int getC()

Returns C position (fixed)

getPositionX

@Deprecated
public int getPositionX()

Deprecated. Use getX() instead

getPositionY

@Deprecated
public int getPositionY()

Deprecated. Use getY() instead

getPositionC

@Deprecated
public int getPositionC()

Deprecated. Use getC() instead

flush

public void flush()