org.openimaj.tools.clusterquantiser.samplebatch

Class SampleBatch

java.lang.Object

org.openimaj.tools.clusterquantiser.samplebatch.SampleBatch

All Implemented Interfaces:

ReadableBinary, ReadWriteableBinary, WriteableBinary

public class SampleBatch
extends Object
implements ReadWriteableBinary

A batch of samples

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	HEADER Header for SampleBatch files

Constructor Summary

Constructors

Constructor and Description
SampleBatch() Default constructor
SampleBatch(FileType type, File sampleSource, int startIndex, int endIndex) Default constructor
SampleBatch(FileType type, File sampleSource, int startIndex, int endIndex, int[] relativeIndexList) Default constructor

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
boolean	equals(Object o)
int	getEndIndex()
int[]	getRelativeIndexList()
int	getStartIndex()
byte[][]	getStoredSamples()
byte[][]	getStoredSamples(int[] indices) Get the stored samples
byte[][]	getStoredSamples(int interestedStart, int interestedEnd) Get the stored samples
void	readBinary(DataInput in) Read internal state from in.
static List<SampleBatch>	readSampleBatches(File sampleBatchOut) Read batches from a file
String	toString()
void	writeBinary(DataOutput out) Write the content of this as binary to out.
static void	writeSampleBatches(List<SampleBatch> sampleBatches, File sampleBatchOut) Write batches to a file

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

public static final byte[] HEADER

Header for SampleBatch files

Constructor Detail

SampleBatch

public SampleBatch()

Default constructor

SampleBatch

public SampleBatch(FileType type,
                   File sampleSource,
                   int startIndex,
                   int endIndex,
                   int[] relativeIndexList)

Default constructor

Parameters:

type -

sampleSource -

startIndex -

endIndex -

relativeIndexList -

SampleBatch

public SampleBatch(FileType type,
                   File sampleSource,
                   int startIndex,
                   int endIndex)

Default constructor

Parameters:

type -

sampleSource -

startIndex -

endIndex -

Method Detail

getStoredSamples

public byte[][] getStoredSamples()
                          throws IOException

Returns:

the stored samples

Throws:

IOException

getStoredSamples

public byte[][] getStoredSamples(int[] indices)
                          throws IOException

Get the stored samples

Parameters:

indices -

Returns:

the stored samples

Throws:

IOException

getStoredSamples

public byte[][] getStoredSamples(int interestedStart,
                                 int interestedEnd)
                          throws IOException

Get the stored samples

Parameters:

interestedStart -

interestedEnd -

Returns:

the stored samples

Throws:

IOException

getStartIndex

public int getStartIndex()

Returns:

the start index of the batch

getEndIndex

public int getEndIndex()

Returns:

the end index of the batch

writeSampleBatches

public static void writeSampleBatches(List<SampleBatch> sampleBatches,
                                      File sampleBatchOut)

Write batches to a file

Parameters:

sampleBatches -

sampleBatchOut -

readSampleBatches

public static List<SampleBatch> readSampleBatches(File sampleBatchOut)

Read batches from a file

Parameters:

sampleBatchOut -

Returns:

batches

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getRelativeIndexList

public int[] getRelativeIndexList()

Returns:

list of relative indices

toString

public String toString()

Overrides:

toString in class Object

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header