Package org.datavec.image.loader

Class BaseImageLoader

java.lang.Object

org.datavec.image.loader.BaseImageLoader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ImageLoader, LFWLoader, NativeImageLoader

public abstract class BaseImageLoader
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseImageLoader.MultiPageMode

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	ALLOWED_FORMATS
protected boolean	centerCropIfNeeded
protected long	channels
protected long	height
protected ImageTransform	imageTransform
protected BaseImageLoader.MultiPageMode	multiPageMode
protected Random	rng
protected long	width

Constructor Summary

Constructors

Constructor	Description
BaseImageLoader()

Method Summary

Modifier and Type	Method	Description
abstract Image	asImageMatrix(File f)	As per asMatrix(File) but as an Image
abstract Image	asImageMatrix(File f, boolean nchw)	As per asMatrix(File, boolean) but as an Image
abstract Image	asImageMatrix(InputStream inputStream)	As per asMatrix(InputStream) but as an Image
abstract Image	asImageMatrix(InputStream inputStream, boolean nchw)	As per asMatrix(InputStream, boolean) but as an Image
abstract INDArray	asMatrix(File f)	As per asMatrix(File, boolean) but NCHW/channels_first format
abstract INDArray	asMatrix(File f, boolean nchw)	Load an image from a file to an INDArray
abstract INDArray	asMatrix(InputStream inputStream)
abstract INDArray	asMatrix(InputStream inputStream, boolean nchw)	Load an image file from an input stream to an INDArray
abstract INDArray	asRowVector(File f)
abstract INDArray	asRowVector(InputStream inputStream)
static void	downloadAndUntar(Map urlMap, File fullDir)
String[]	getAllowedFormats()

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWED_FORMATS

public static final String[] ALLOWED_FORMATS

rng

protected Random rng

height

protected long height

width

protected long width

channels

protected long channels

centerCropIfNeeded

protected boolean centerCropIfNeeded

imageTransform

protected ImageTransform imageTransform

multiPageMode

protected BaseImageLoader.MultiPageMode multiPageMode

Constructor Detail

BaseImageLoader

public BaseImageLoader()

Method Detail

getAllowedFormats

public String[] getAllowedFormats()

asRowVector

public abstract INDArray asRowVector(File f)
                              throws IOException

Throws:

IOException

asRowVector

public abstract INDArray asRowVector(InputStream inputStream)
                              throws IOException

Throws:

IOException

asMatrix

public abstract INDArray asMatrix(File f)
                           throws IOException

As per asMatrix(File, boolean) but NCHW/channels_first format

Throws:

IOException

asMatrix

public abstract INDArray asMatrix(File f,
                                  boolean nchw)
                           throws IOException

Load an image from a file to an INDArray

Parameters:

f - File to load the image from

nchw - If true: return image in NCHW/channels_first [1, channels, height width] format; if false, return in NHWC/channels_last [1, height, width, channels] format

Returns:

Image file as as INDArray

Throws:

IOException

asMatrix

public abstract INDArray asMatrix(InputStream inputStream)
                           throws IOException

Throws:

IOException

asMatrix

public abstract INDArray asMatrix(InputStream inputStream,
                                  boolean nchw)
                           throws IOException

Load an image file from an input stream to an INDArray

Parameters:

inputStream - Input stream to load the image from

nchw - If true: return image in NCHW/channels_first [1, channels, height width] format; if false, return in NHWC/channels_last [1, height, width, channels] format

Returns:

Image file stream as as INDArray

Throws:

IOException

asImageMatrix

public abstract Image asImageMatrix(File f)
                             throws IOException

As per asMatrix(File) but as an Image

Throws:

IOException

asImageMatrix

public abstract Image asImageMatrix(File f,
                                    boolean nchw)
                             throws IOException

As per asMatrix(File, boolean) but as an Image

Throws:

IOException

asImageMatrix

public abstract Image asImageMatrix(InputStream inputStream)
                             throws IOException

As per asMatrix(InputStream) but as an Image

Throws:

IOException

asImageMatrix

public abstract Image asImageMatrix(InputStream inputStream,
                                    boolean nchw)
                             throws IOException

As per asMatrix(InputStream, boolean) but as an Image

Throws:

IOException

downloadAndUntar

public static void downloadAndUntar(Map urlMap,
                                    File fullDir)