org.canova.image.recordreader

Class ImageRecordReader

java.lang.Object

org.canova.image.recordreader.BaseImageRecordReader

org.canova.image.recordreader.ImageRecordReader

All Implemented Interfaces:

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

public class ImageRecordReader
extends BaseImageRecordReader

Image record reader. Reads a local file system and parses images of a given height and width. Also appends the label if specified (one of k encoding based on the directory structure where each subdir of the root is an indexed label)

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields inherited from class org.canova.image.recordreader.BaseImageRecordReader

appendLabel, channels, CHANNELS, conf, CROP_IMAGE, cropImage, currentFile, fileNameMap, height, HEIGHT, hitImage, IMAGE_LOADER, imageLoader, inputSplit, iter, labels, pattern, patternPosition, record, width, WIDTH

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getLabel(String path) Get the label from the given path

Methods inherited from class org.canova.image.recordreader.BaseImageRecordReader

accumulateLabel, close, containsFormat, getConf, getCurrentFile, getLabels, hasNext, initialize, initialize, next, numLabels, record, reset, setConf, setCurrentFile

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRecordReader

public ImageRecordReader()

ImageRecordReader

public ImageRecordReader(int height,
                         int width,
                         int channels,
                         List<String> labels)

ImageRecordReader

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

ImageRecordReader

public ImageRecordReader(int height,
                         int width,
                         int channels)

ImageRecordReader

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

ImageRecordReader

public ImageRecordReader(int height,
                         int width,
                         List<String> labels)

ImageRecordReader

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

ImageRecordReader

public ImageRecordReader(int height,
                         int width)

ImageRecordReader

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

ImageRecordReader

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

Method Detail

getLabel

public String getLabel(String path)

Description copied from class: BaseImageRecordReader

Get the label from the given path

Overrides:

getLabel in class BaseImageRecordReader

Parameters:

path - the path to get the label from

Returns:

the label for the given path