com.emphysic.myriad.core.data.io

Class Dataset

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IODataset

public class Dataset
extends java.lang.Object
implements java.io.Serializable

Dataset-the fundamental data type in Myriad. Consists of a 1D double array and associated functions to treat as a two-dimensional entity.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double[]	data The array that backs the contents of the dataset.
protected int	height The height of a 2D dataset.
protected int	width The width of a 2D dataset.

Constructor Summary

Constructors

Constructor and Description
Dataset() Create a new uninitialized Dataset.
Dataset(Dataset orig) Create a new Dataset from an original.
Dataset(double[] data) Create a new 1D Dataset of width data.length and height 1.
Dataset(double[] data, int width, int height) Create a new 2D Dataset from an input array.
Dataset(int width, int height) Create a new initialized but empty Dataset

Method Summary

Modifier and Type	Method and Description
double	get(int x, int y) Retrieves the value of the data at a given point.
double[]	getData() Retrieve the underlying array
int	getHeight() Retrieves the current height of this Dataset.
int	getSize() Returns the current size of this Dataset.
int	getWidth() Retrieves the current width of this Dataset.
void	prettyPrint() Convenience method for printing this Dataset to standard output
void	prettyPrint(java.io.PrintStream out) Convenience method for printing this Dataset to a PrintStream
void	set(int x, int y, double value) Sets the value of a point.
void	setData(Dataset dataSet) Sets this Dataset's data to a copy of the specified's data.
void	setData(double[] data, int width, int height) Sets this Dataset's data to a copy of the specified data.
void	write(java.io.File outputFile) Writes this Dataset to a space-delimited text file.
void	write(java.lang.String outputFileName) Writes this Dataset to a space-delimited text file.

Methods inherited from class java.lang.Object

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

Field Detail

width

protected int width

The width of a 2D dataset. For 1D data set one of @link #width or @link #height to 1.

height

protected int height

The height of a 2D dataset. For 1D data set one of @link #width or @link #height to 1.

data

protected double[] data

The array that backs the contents of the dataset.

Constructor Detail

Dataset

public Dataset(int width,
               int height)

Create a new initialized but empty Dataset

Parameters:

width - width of the data

height - height of the data

Dataset

public Dataset(double[] data)

Create a new 1D Dataset of width data.length and height 1.

Parameters:

data - array to copy

Dataset

public Dataset(double[] data,
               int width,
               int height)

Create a new 2D Dataset from an input array.

Parameters:

data - array to copy

width - width of data

height - height of data

Dataset

public Dataset()

Create a new uninitialized Dataset. Primarily for (de)serialization.

Dataset

public Dataset(Dataset orig)

Create a new Dataset from an original. Array contents are copied.

Parameters:

orig - original to copy

Method Detail

getData

public double[] getData()

Retrieve the underlying array

Returns:

this Dataset's 1D data.

setData

public void setData(Dataset dataSet)

Sets this Dataset's data to a copy of the specified's data. Width and height parameters are also updated.

Parameters:

dataSet - dataset to copy

setData

public void setData(double[] data,
                    int width,
                    int height)

Sets this Dataset's data to a copy of the specified data.

Parameters:

data - array to copy

width - new width of the Dataset

height - new height of the Dataset

get

public double get(int x,
                  int y)

Retrieves the value of the data at a given point.

Parameters:

x - X-coordinate of the point

y - Y-coordinate of the point

Returns:

the value of the data at point (x, y)

set

public void set(int x,
                int y,
                double value)

Sets the value of a point.

Parameters:

x - X-coordinate of the point

y - Y-coordinate of the point

value - new value for the point (x, y)

getWidth

public int getWidth()

Retrieves the current width of this Dataset.

Returns:

width

getHeight

public int getHeight()

Retrieves the current height of this Dataset.

Returns:

height

getSize

public int getSize()

Returns the current size of this Dataset. Equivalent to width * height.

Returns:

size

prettyPrint

public void prettyPrint(java.io.PrintStream out)

Convenience method for printing this Dataset to a PrintStream

Parameters:

out - stream

prettyPrint

public void prettyPrint()

Convenience method for printing this Dataset to standard output

write

public void write(java.io.File outputFile)
           throws java.io.IOException

Writes this Dataset to a space-delimited text file.

Parameters:

outputFile - name of the output file

Throws:

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

write

public void write(java.lang.String outputFileName)
           throws java.io.IOException

Writes this Dataset to a space-delimited text file.

Parameters:

outputFileName - filename of the output file

Throws:

java.io.IOException - if an error occurs