com.emphysic.myriad.core.data.io

Class ImageDataset

java.lang.Object

com.emphysic.myriad.core.data.io.Dataset

com.emphysic.myriad.core.data.io.IODataset

com.emphysic.myriad.core.data.io.ImageDataset

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DicomDataset

public class ImageDataset
extends IODataset

ImageDataset - IODatasets from image files.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.emphysic.myriad.core.data.io.IODataset

source

Fields inherited from class com.emphysic.myriad.core.data.io.Dataset

data, height, width

Constructor Summary

Constructors

Constructor and Description
ImageDataset() Empty constructor for (de)serialization.
ImageDataset(java.io.File dataSource) Creates a new ImageDataset from the specified file.
ImageDataset(java.lang.String dataFileName) Creates a new ImageDataset from the specified file.

Method Summary

Modifier and Type	Method and Description
long	getBigFileSize() Size in bytes for "big" images.
int	getCurrentFrame() Returns the current position in the image file
static double[]	getData(java.awt.image.BufferedImage image, int x, int y, int w, int h) Reads a specified region in an image and returns the RGB data.
int	getNumFrames() Returns the number of frames in the image file
static int[]	getPixelData(java.awt.image.BufferedImage img) Returns the pixel data from an image.
void	read() Retrieves the data from the image.
double[]	read(int idx) For multi-image file formats, reads the image at the specified index.
void	rewind() Resets the current frame to the first frame.
void	setBigFileSize(long bytes) Sets the threshold size in bytes for "big" images.

Methods inherited from class com.emphysic.myriad.core.data.io.Dataset

get, getData, getHeight, getSize, getWidth, prettyPrint, prettyPrint, set, setData, setData, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDataset

public ImageDataset(java.io.File dataSource)
             throws java.io.IOException

Creates a new ImageDataset from the specified file.

Parameters:

dataSource - source of data

Throws:

java.io.IOException - if an I/O error occurs.

ImageDataset

public ImageDataset(java.lang.String dataFileName)
             throws java.io.IOException

Creates a new ImageDataset from the specified file.

Parameters:

dataFileName - name of source file

Throws:

java.io.IOException - if an I/O error occurs.

ImageDataset

public ImageDataset()

Empty constructor for (de)serialization.

Method Detail

getPixelData

public static int[] getPixelData(java.awt.image.BufferedImage img)

Returns the pixel data from an image.

Parameters:

img - image to read

Returns:

pixel data

read

public void read()
          throws java.io.IOException

Retrieves the data from the image. If the input image contains multiple images e.g. GIF or multipage TIFF, reads the data from the current frame and then advances so that the data can be read iteratively:

for (int i=0; i<instance.getNumFrames(); i++) { instance.read(); // instance's data is now the contents of the current frame }

Specified by:

read in class IODataset

Throws:

java.io.IOException - if an I/O error occurs

getData

public static double[] getData(java.awt.image.BufferedImage image,
                               int x,
                               int y,
                               int w,
                               int h)

Reads a specified region in an image and returns the RGB data.

Parameters:

image - image to process

x - x-coordinate of top left corner of bounding box to read

y - y-coordinate of top left corner of bounding box to read

w - width of region

h - height of region

Returns:

1D array of RGB values

Throws:

java.lang.IndexOutOfBoundsException - if provided an invalid region

read

public double[] read(int idx)
              throws java.io.IOException

For multi-image file formats, reads the image at the specified index.

Parameters:

idx - index to read

Returns:

image at the specified index or null if the image couldn't be read

Throws:

java.io.IOException - if an I/O error occurs

java.lang.IndexOutOfBoundsException - if specified index is less than 0 or greater than the number of frames in the image

rewind

public void rewind()

Resets the current frame to the first frame.

getCurrentFrame

public int getCurrentFrame()

Returns the current position in the image file

Returns:

current frame number

getNumFrames

public int getNumFrames()
                 throws java.io.IOException

Returns the number of frames in the image file

Returns:

number of frames

Throws:

java.io.IOException - if an I/O error occurs

getBigFileSize

public long getBigFileSize()

Size in bytes for "big" images. Files bigger than this value are read with memory-mapped databuffers

Returns:

size in bytes

See Also:

. Files smaller than this value are read as conventional, .

setBigFileSize

public void setBigFileSize(long bytes)

Sets the threshold size in bytes for "big" images. Files bigger than this value are read with memory-mapped databuffers @see BigBufferedImage . Files smaller than this value are read as conventional

Parameters:

bytes - threshold filesize in bytes

See Also:

.