org.openimaj.data

Class ByteArrayBackedDataSource

java.lang.Object

org.openimaj.data.ByteArrayBackedDataSource

All Implemented Interfaces:

Iterable<byte[]>, DataSource<byte[]>

public class ByteArrayBackedDataSource
extends Object
implements DataSource<byte[]>

A DataSource backed by a 2D array of bytes.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[][]	data
protected Random	rng

Constructor Summary

Constructors

Constructor and Description
ByteArrayBackedDataSource(byte[][] data) Construct with data
ByteArrayBackedDataSource(byte[][] data, Random rng) Construct with data and a random generator for random sampling

Method Summary

Modifier and Type	Method and Description
byte[][]	createTemporaryArray(int size) Create a temporary array suitable for use with the DataSource.getRandomRows(Object[]) and DataSource.getData(int, int, Object[]) methods.
byte[]	getData(int row) Get the data for a given row
void	getData(int startRow, int stopRow, byte[][] output) Get data between given rows.
void	getRandomRows(byte[][] output)
Iterator<byte[]>	iterator()
int	numDimensions()
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

data

protected byte[][] data

rng

protected Random rng

Constructor Detail

ByteArrayBackedDataSource

public ByteArrayBackedDataSource(byte[][] data)

Construct with data

Parameters:

data - the data

ByteArrayBackedDataSource

public ByteArrayBackedDataSource(byte[][] data,
                                 Random rng)

Construct with data and a random generator for random sampling

Parameters:

data - the data

rng - the random generator

Method Detail

getData

public final void getData(int startRow,
                          int stopRow,
                          byte[][] output)

Description copied from interface: DataSource

Get data between given rows. startRow must be > 0, stopRow must be smaller than DataSource.size(). data is guaranteed to have (stopRow - startRow) valid entries

Specified by:

getData in interface DataSource<byte[]>

Parameters:

startRow - where to start (inclusive)

stopRow - where to stop (exclusive)

output - the array to fill

getRandomRows

public final void getRandomRows(byte[][] output)

Specified by:

getRandomRows in interface DataSource<byte[]>

Parameters:

output - a random set of data. This array is guaranteed to be filled.

numDimensions

public int numDimensions()

Specified by:

numDimensions in interface DataSource<byte[]>

Returns:

Number of dimensions of each data point

size

public int size()

Specified by:

size in interface DataSource<byte[]>

Returns:

the number of data points

getData

public byte[] getData(int row)

Description copied from interface: DataSource

Get the data for a given row

Specified by:

getData in interface DataSource<byte[]>

Parameters:

row - the row number

Returns:

the data for the row

iterator

public Iterator<byte[]> iterator()

Specified by:

iterator in interface Iterable<byte[]>

createTemporaryArray

public byte[][] createTemporaryArray(int size)

Description copied from interface: DataSource

Create a temporary array suitable for use with the DataSource.getRandomRows(Object[]) and DataSource.getData(int, int, Object[]) methods.

Specified by:

createTemporaryArray in interface DataSource<byte[]>

Parameters:

size - the size of the array

Returns:

the array