org.datavec.codec.reader

Class BaseCodecRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

org.datavec.api.records.reader.impl.FileRecordReader

org.datavec.codec.reader.BaseCodecRecordReader

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, Configurable, RecordReader, SequenceRecordReader

Direct Known Subclasses:

CodecRecordReader, NativeCodecRecordReader

public abstract class BaseCodecRecordReader
extends FileRecordReader
implements SequenceRecordReader

Codec record reader for parsing videos

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cols
static java.lang.String	COLUMNS
protected double	framesPerSecond
static java.lang.String	NAME_SPACE
protected int	numFrames
protected boolean	ravel
static java.lang.String	RAVEL
protected int	rows
static java.lang.String	ROWS
static java.lang.String	START_FRAME
protected int	startFrame
static java.lang.String	TIME_SLICE
static java.lang.String	TOTAL_FRAMES
protected int	totalFrames
static java.lang.String	VIDEO_DURATION
protected double	videoLength

Fields inherited from class org.datavec.api.records.reader.impl.FileRecordReader

appendLabel, conf, currentFile, inputSplit, iter, labels

Fields inherited from class org.datavec.api.records.reader.BaseRecordReader

listeners

Fields inherited from interface org.datavec.api.records.reader.RecordReader

APPEND_LABEL, LABELS

Constructor Summary

Constructors

Constructor and Description
BaseCodecRecordReader()

Method Summary

Modifier and Type	Method and Description
Configuration	getConf() Return the configuration used by this object.
boolean	hasNext() Whether there are anymore records
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
protected abstract java.util.List<java.util.List<Writable>>	loadData(java.io.File file, java.io.InputStream inputStream)
java.util.List<SequenceRecord>	loadSequenceFromMetaData(java.util.List<RecordMetaData> recordMetaDatas) Load multiple sequence records from the given a list of RecordMetaData instances
SequenceRecord	loadSequenceFromMetaData(RecordMetaData recordMetaData) Load a single sequence record from the given RecordMetaData instance Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using SequenceRecordReader.loadSequenceFromMetaData(List)
java.util.List<Writable>	next() Get the next record
SequenceRecord	nextSequence() Similar to SequenceRecordReader.sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data
java.util.List<Writable>	record(java.net.URI uri, java.io.DataInputStream dataInputStream) Load the record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream
java.util.List<java.util.List<Writable>>	sequenceRecord() Returns a sequence record.
java.util.List<java.util.List<Writable>>	sequenceRecord(java.net.URI uri, java.io.DataInputStream dataInputStream) Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream
void	setConf(Configuration conf) Set the configuration to be used by this object.

Methods inherited from class org.datavec.api.records.reader.impl.FileRecordReader

close, doInitialize, getCurrentLabel, getLabels, initialize, loadFromMetaData, loadFromMetaData, nextRecord, reset, setLabels

Methods inherited from class org.datavec.api.records.reader.BaseRecordReader

getListeners, invokeListeners, setListeners, setListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datavec.api.records.reader.RecordReader

getLabels, getListeners, initialize, loadFromMetaData, loadFromMetaData, nextRecord, reset, setListeners, setListeners

Methods inherited from interface java.io.Closeable

close

Field Detail

startFrame

protected int startFrame

numFrames

protected int numFrames

totalFrames

protected int totalFrames

framesPerSecond

protected double framesPerSecond

videoLength

protected double videoLength

rows

protected int rows

cols

protected int cols

ravel

protected boolean ravel

NAME_SPACE

public static final java.lang.String NAME_SPACE

See Also:

Constant Field Values

ROWS

public static final java.lang.String ROWS

See Also:

Constant Field Values

COLUMNS

public static final java.lang.String COLUMNS

See Also:

Constant Field Values

START_FRAME

public static final java.lang.String START_FRAME

See Also:

Constant Field Values

TOTAL_FRAMES

public static final java.lang.String TOTAL_FRAMES

See Also:

Constant Field Values

TIME_SLICE

public static final java.lang.String TIME_SLICE

See Also:

Constant Field Values

RAVEL

public static final java.lang.String RAVEL

See Also:

Constant Field Values

VIDEO_DURATION

public static final java.lang.String VIDEO_DURATION

See Also:

Constant Field Values

Constructor Detail

BaseCodecRecordReader

public BaseCodecRecordReader()

Method Detail

sequenceRecord

public java.util.List<java.util.List<Writable>> sequenceRecord()

Description copied from interface: SequenceRecordReader

Returns a sequence record.

Specified by:

sequenceRecord in interface SequenceRecordReader

Returns:

a sequence of records

sequenceRecord

public java.util.List<java.util.List<Writable>> sequenceRecord(java.net.URI uri,
                                                               java.io.DataInputStream dataInputStream)
                                                        throws java.io.IOException

Description copied from interface: SequenceRecordReader

Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Specified by:

sequenceRecord in interface SequenceRecordReader

Throws:

java.io.IOException - if error occurs during reading from the input stream

loadData

protected abstract java.util.List<java.util.List<Writable>> loadData(java.io.File file,
                                                                     java.io.InputStream inputStream)
                                                              throws java.io.IOException

Throws:

java.io.IOException

initialize

public void initialize(Configuration conf,
                       InputSplit split)
                throws java.io.IOException,
                       java.lang.InterruptedException

Description copied from interface: RecordReader

Called once at initialization.

Specified by:

initialize in interface RecordReader

Overrides:

initialize in class FileRecordReader

Parameters:

conf - a configuration for initialization

split - the split that defines the range of records to read

Throws:

java.io.IOException

java.lang.InterruptedException

next

public java.util.List<Writable> next()

Description copied from interface: RecordReader

Get the next record

Specified by:

next in interface RecordReader

Overrides:

next in class FileRecordReader

Returns:

record

public java.util.List<Writable> record(java.net.URI uri,
                                       java.io.DataInputStream dataInputStream)
                                throws java.io.IOException

Description copied from interface: RecordReader

Load the record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Specified by:

record in interface RecordReader

Overrides:

record in class FileRecordReader

Throws:

java.io.IOException - if error occurs during reading from the input stream

hasNext

public boolean hasNext()

Description copied from interface: RecordReader

Whether there are anymore records

Specified by:

hasNext in interface RecordReader

Overrides:

hasNext in class FileRecordReader

Returns:

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Overrides:

setConf in class FileRecordReader

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

Overrides:

getConf in class FileRecordReader

nextSequence

public SequenceRecord nextSequence()

Description copied from interface: SequenceRecordReader

Similar to SequenceRecordReader.sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data

Specified by:

nextSequence in interface SequenceRecordReader

Returns:

next sequence record

loadSequenceFromMetaData

public SequenceRecord loadSequenceFromMetaData(RecordMetaData recordMetaData)
                                        throws java.io.IOException

Description copied from interface: SequenceRecordReader

Load a single sequence record from the given RecordMetaData instance
Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using SequenceRecordReader.loadSequenceFromMetaData(List)

Specified by:

loadSequenceFromMetaData in interface SequenceRecordReader

Parameters:

recordMetaData - Metadata for the sequence record that we want to load from

Returns:

Single sequence record for the given RecordMetaData instance

Throws:

java.io.IOException - If I/O error occurs during loading

loadSequenceFromMetaData

public java.util.List<SequenceRecord> loadSequenceFromMetaData(java.util.List<RecordMetaData> recordMetaDatas)
                                                        throws java.io.IOException

Description copied from interface: SequenceRecordReader

Load multiple sequence records from the given a list of RecordMetaData instances

Specified by:

loadSequenceFromMetaData in interface SequenceRecordReader

Parameters:

recordMetaDatas - Metadata for the records that we want to load from

Returns:

Multiple sequence record for the given RecordMetaData instances

Throws:

java.io.IOException - If I/O error occurs during loading