org.datavec.image.recordreader

Class VideoRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

org.datavec.image.recordreader.VideoRecordReader

All Implemented Interfaces:

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

public class VideoRecordReader
extends BaseRecordReader
implements SequenceRecordReader

A video is just a moving window of pictures. It should be processed as such. This iterates over a root folder and returns a

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEIGHT
static java.lang.String	IMAGE_LOADER
protected InputSplit	inputSplit
static java.lang.String	WIDTH

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

listeners

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor and Description
VideoRecordReader()
VideoRecordReader(int height, int width) Load the record reader with the given height and width
VideoRecordReader(int height, int width, boolean appendLabel)
VideoRecordReader(int height, int width, boolean appendLabel, java.util.List<java.lang.String> labels)
VideoRecordReader(int height, int width, java.util.List<java.lang.String> labels) Load the record reader with the given height and width

Method Summary

Modifier and Type	Method and Description
void	close()
Configuration	getConf() Return the configuration used by this object.
java.util.List<java.lang.String>	getLabels() List of label strings
boolean	hasNext() Whether there are anymore records
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
void	initialize(InputSplit split) Called once at initialization.
java.util.List<Record>	loadFromMetaData(java.util.List<RecordMetaData> recordMetaDatas) Load multiple records from the given a list of RecordMetaData instances
Record	loadFromMetaData(RecordMetaData recordMetaData) Load a single 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 RecordReader.loadFromMetaData(List)
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
Record	nextRecord() Similar to RecordReader.next(), but returns a Record object, that may include metadata such as the source of the data
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
void	reset() Reset record reader iterator
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.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

getListeners, setListeners, setListeners

Field Detail

HEIGHT

public static final java.lang.String HEIGHT

WIDTH

public static final java.lang.String WIDTH

IMAGE_LOADER

public static final java.lang.String IMAGE_LOADER

inputSplit

protected InputSplit inputSplit

Constructor Detail

VideoRecordReader

public VideoRecordReader()

VideoRecordReader

public VideoRecordReader(int height,
                         int width,
                         java.util.List<java.lang.String> labels)

Load the record reader with the given height and width

Parameters:

height - the height to load

width - the width load

VideoRecordReader

public VideoRecordReader(int height,
                         int width,
                         boolean appendLabel,
                         java.util.List<java.lang.String> labels)

VideoRecordReader

public VideoRecordReader(int height,
                         int width)

Load the record reader with the given height and width

Parameters:

height - the height to load

width - the width load

VideoRecordReader

public VideoRecordReader(int height,
                         int width,
                         boolean appendLabel)

Method Detail

initialize

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

Description copied from interface: RecordReader

Called once at initialization.

Specified by:

initialize in interface RecordReader

Parameters:

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

Throws:

java.io.IOException

java.lang.InterruptedException

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

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

Returns:

hasNext

public boolean hasNext()

Description copied from interface: RecordReader

Whether there are anymore records

Specified by:

hasNext in interface RecordReader

Returns:

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

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

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

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

getLabels

public java.util.List<java.lang.String> getLabels()

Description copied from interface: RecordReader

List of label strings

Specified by:

getLabels in interface RecordReader

Returns:

reset

public void reset()

Description copied from interface: RecordReader

Reset record reader iterator

Specified by:

reset in interface RecordReader

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

Throws:

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

nextRecord

public Record nextRecord()

Description copied from interface: RecordReader

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

Specified by:

nextRecord in interface RecordReader

Returns:

next record

loadFromMetaData

public Record loadFromMetaData(RecordMetaData recordMetaData)
                        throws java.io.IOException

Description copied from interface: RecordReader

Load a single 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 RecordReader.loadFromMetaData(List)

Specified by:

loadFromMetaData in interface RecordReader

Parameters:

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

Returns:

Single record for the given RecordMetaData instance

Throws:

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

loadFromMetaData

public java.util.List<Record> loadFromMetaData(java.util.List<RecordMetaData> recordMetaDatas)
                                        throws java.io.IOException

Description copied from interface: RecordReader

Load multiple records from the given a list of RecordMetaData instances

Specified by:

loadFromMetaData in interface RecordReader

Parameters:

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

Returns:

Multiple records for the given RecordMetaData instances

Throws:

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

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

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