org.canova.image.recordreader

Class BaseImageRecordReader

java.lang.Object

org.canova.image.recordreader.BaseImageRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, org.canova.api.conf.Configurable, org.canova.api.records.reader.RecordReader

Direct Known Subclasses:

ImageNameRecordReader, ImageNetRecordReader, ImageRecordReader

public abstract class BaseImageRecordReader
extends Object
implements org.canova.api.records.reader.RecordReader

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 org.canova.api.conf.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 org.canova.api.split.InputSplit	inputSplit
protected Iterator<File>	iter
List<String>	labels
protected String	pattern
protected int	patternPosition
protected Collection<org.canova.api.writable.Writable>	record
protected int	width
static String	WIDTH

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor and Description
BaseImageRecordReader()
BaseImageRecordReader(int height, int width, int channels, boolean appendLabel)
BaseImageRecordReader(int height, int width, int channels, boolean appendLabel, List<String> labels)
BaseImageRecordReader(int height, int width, int channels, boolean appendLabel, List<String> labels, String pattern, int patternPosition)
BaseImageRecordReader(int height, int width, int channels, boolean appendLabel, String pattern, int patternPosition)
BaseImageRecordReader(int height, int width, int channels, List<String> labels)

Method Summary

Modifier and Type	Method and Description
protected void	accumulateLabel(String path) Accumulate the label from the path
void	close()
protected boolean	containsFormat(String format)
org.canova.api.conf.Configuration	getConf()
File	getCurrentFile()
String	getLabel(String path) Get the label from the given path
List<String>	getLabels()
boolean	hasNext()
void	initialize(org.canova.api.conf.Configuration conf, org.canova.api.split.InputSplit split)
void	initialize(org.canova.api.split.InputSplit split)
Collection<org.canova.api.writable.Writable>	next()
int	numLabels()
Collection<org.canova.api.writable.Writable>	record(URI uri, DataInputStream dataInputStream)
void	reset()
void	setConf(org.canova.api.conf.Configuration conf)
void	setCurrentFile(File currentFile)

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 org.canova.api.conf.Configuration conf

currentFile

protected File currentFile

labels

public List<String> labels

appendLabel

protected boolean appendLabel

record

protected Collection<org.canova.api.writable.Writable> record

hitImage

protected boolean hitImage

height

protected int height

width

protected int width

channels

protected int channels

cropImage

protected boolean cropImage

imageLoader

protected BaseImageLoader imageLoader

inputSplit

protected org.canova.api.split.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,
                             List<String> labels)

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             boolean appendLabel)

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             boolean appendLabel,
                             List<String> labels)

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             boolean appendLabel,
                             String pattern,
                             int patternPosition)

BaseImageRecordReader

public BaseImageRecordReader(int height,
                             int width,
                             int channels,
                             boolean appendLabel,
                             List<String> labels,
                             String pattern,
                             int patternPosition)

Method Detail

containsFormat

protected boolean containsFormat(String format)

initialize

public void initialize(org.canova.api.split.InputSplit split)
                throws IOException

Specified by:

initialize in interface org.canova.api.records.reader.RecordReader

Throws:

IOException

initialize

public void initialize(org.canova.api.conf.Configuration conf,
                       org.canova.api.split.InputSplit split)
                throws IOException,
                       InterruptedException

Specified by:

initialize in interface org.canova.api.records.reader.RecordReader

Throws:

IOException

InterruptedException

next

public Collection<org.canova.api.writable.Writable> next()

Specified by:

next in interface org.canova.api.records.reader.RecordReader

hasNext

public boolean hasNext()

Specified by:

hasNext in interface org.canova.api.records.reader.RecordReader

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

setConf

public void setConf(org.canova.api.conf.Configuration conf)

Specified by:

setConf in interface org.canova.api.conf.Configurable

getConf

public org.canova.api.conf.Configuration getConf()

Specified by:

getConf in interface org.canova.api.conf.Configurable

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()

setCurrentFile

public void setCurrentFile(File currentFile)

getLabels

public List<String> getLabels()

Specified by:

getLabels in interface org.canova.api.records.reader.RecordReader

reset

public void reset()

Specified by:

reset in interface org.canova.api.records.reader.RecordReader

numLabels

public int numLabels()

record

public Collection<org.canova.api.writable.Writable> record(URI uri,
                                                           DataInputStream dataInputStream)
                                                    throws IOException

Specified by:

record in interface org.canova.api.records.reader.RecordReader

Throws:

IOException