org.datavec.image.recordreader

Class BaseImageRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

org.datavec.image.recordreader.BaseImageRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Configurable, RecordReader

Direct Known Subclasses:

ImageRecordReader

public abstract class BaseImageRecordReader
extends BaseRecordReader

Base class for the image record reader

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendLabel
protected int	channels
static String	CHANNELS
protected Configuration	conf
static String	CROP_IMAGE
protected boolean	cropImage
protected File	currentFile
protected Map<String,String>	fileNameMap
protected int	height
static String	HEIGHT
protected boolean	hitImage
static String	IMAGE_LOADER
protected BaseImageLoader	imageLoader
protected ImageTransform	imageTransform
protected InputSplit	inputSplit
protected Iterator<File>	iter
protected PathLabelGenerator	labelGenerator
protected List<String>	labels
protected String	pattern
protected int	patternPosition
protected List<Writable>	record
protected int	width
static String	WIDTH
protected boolean	writeLabel

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
BaseImageRecordReader()
BaseImageRecordReader(int height, int width, int channels, PathLabelGenerator labelGenerator)
BaseImageRecordReader(int height, int width, int channels, PathLabelGenerator labelGenerator, ImageTransform imageTransform)

Method Summary

Modifier and Type	Method and Description
protected void	accumulateLabel(String path) Accumulate the label from the path
boolean	batchesSupported()
void	close()
protected boolean	containsFormat(String format)
Configuration	getConf()
File	getCurrentFile() Returns the file loaded last by next().
String	getLabel(String path) Get the label from the given path
List<String>	getLabels()
boolean	hasNext()
void	initialize(Configuration conf, InputSplit split)
void	initialize(Configuration conf, InputSplit split, ImageTransform imageTransform) Called once at initialization.
void	initialize(InputSplit split)
void	initialize(InputSplit split, ImageTransform imageTransform) Called once at initialization.
List<Record>	loadFromMetaData(List<RecordMetaData> recordMetaDatas)
Record	loadFromMetaData(RecordMetaData recordMetaData)
List<Writable>	next()
List<Writable>	next(int num)
Record	nextRecord()
int	numLabels() Returns getLabels().size().
List<Writable>	record(URI uri, DataInputStream dataInputStream)
void	reset()
void	setConf(Configuration conf)
void	setCurrentFile(File currentFile) Sets manually the file returned by getCurrentFile().
void	setLabels(List<String> labels)

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

Field Detail

iter

protected Iterator<File> iter

conf

protected Configuration conf

currentFile

protected File currentFile

labelGenerator

protected PathLabelGenerator labelGenerator

labels

protected List<String> labels

appendLabel

protected boolean appendLabel

writeLabel

protected boolean writeLabel

record

protected List<Writable> record

hitImage

protected boolean hitImage

height

protected int height

width

protected int width

channels

protected int channels

cropImage

protected boolean cropImage

imageTransform

protected ImageTransform imageTransform

imageLoader

protected BaseImageLoader imageLoader

inputSplit

protected InputSplit inputSplit

fileNameMap

protected Map<String,String> fileNameMap

pattern

protected String pattern

patternPosition

protected int patternPosition

HEIGHT

public static final String HEIGHT

WIDTH

public static final String WIDTH

CHANNELS

public static final String CHANNELS

CROP_IMAGE

public static final String CROP_IMAGE

IMAGE_LOADER

public static final String IMAGE_LOADER

Constructor Detail

BaseImageRecordReader

public BaseImageRecordReader()

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             PathLabelGenerator labelGenerator)

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             PathLabelGenerator labelGenerator,
                             ImageTransform imageTransform)

Method Detail

containsFormat

protected boolean containsFormat(String format)

initialize

public void initialize(InputSplit split)
                throws IOException

Throws:

IOException

initialize

public void initialize(Configuration conf,
                       InputSplit split)
                throws IOException,
                       InterruptedException

Throws:

IOException

InterruptedException

initialize

public void initialize(InputSplit split,
                       ImageTransform imageTransform)
                throws IOException

Called once at initialization.

Parameters:

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

imageTransform - the image transform to use to transform images while loading them

Throws:

IOException

initialize

public void initialize(Configuration conf,
                       InputSplit split,
                       ImageTransform imageTransform)
                throws IOException,
                       InterruptedException

Called once at initialization.

Parameters:

conf - a configuration for initialization

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

imageTransform - the image transform to use to transform images while loading them

Throws:

IOException

InterruptedException

next

public List<Writable> next()

hasNext

public boolean hasNext()

batchesSupported

public boolean batchesSupported()

Specified by:

batchesSupported in interface RecordReader

Overrides:

batchesSupported in class BaseRecordReader

next

public List<Writable> next(int num)

Specified by:

next in interface RecordReader

Overrides:

next in class BaseRecordReader

close

public void close()
           throws IOException

Throws:

IOException

setConf

public void setConf(Configuration conf)

getConf

public Configuration getConf()

getLabel

public String getLabel(String path)

Get the label from the given path

Parameters:

path - the path to get the label from

Returns:

the label for the given path

accumulateLabel

protected void accumulateLabel(String path)

Accumulate the label from the path

Parameters:

path - the path to get the label from

getCurrentFile

public File getCurrentFile()

Returns the file loaded last by next().

setCurrentFile

public void setCurrentFile(File currentFile)

Sets manually the file returned by getCurrentFile().

getLabels

public List<String> getLabels()

setLabels

public void setLabels(List<String> labels)

reset

public void reset()

numLabels

public int numLabels()

Returns getLabels().size().

record

public List<Writable> record(URI uri,
                             DataInputStream dataInputStream)
                      throws IOException

Throws:

IOException

nextRecord

public Record nextRecord()

loadFromMetaData

public Record loadFromMetaData(RecordMetaData recordMetaData)
                        throws IOException

Throws:

IOException

loadFromMetaData

public List<Record> loadFromMetaData(List<RecordMetaData> recordMetaDatas)
                              throws IOException

Throws:

IOException