Package org.datavec.image.loader

Class NativeImageLoader

java.lang.Object

org.datavec.image.loader.BaseImageLoader

org.datavec.image.loader.NativeImageLoader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AndroidNativeImageLoader, CifarLoader, Java2DNativeImageLoader

public class NativeImageLoader
extends BaseImageLoader

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.datavec.image.loader.BaseImageLoader

BaseImageLoader.MultiPageMode

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	ALLOWED_FORMATS
protected org.bytedeco.javacv.OpenCVFrameConverter.ToMat	converter

Fields inherited from class org.datavec.image.loader.BaseImageLoader

centerCropIfNeeded, channels, height, imageTransform, multiPageMode, rng, width

Constructor Summary

Constructors

Modifier	Constructor	Description
	NativeImageLoader()	Loads images with no scaling or conversion.
	NativeImageLoader(long height, long width)	Instantiate an image with the given height and width
	NativeImageLoader(long height, long width, long channels)	Instantiate an image with the given height and width
	NativeImageLoader(long height, long width, long channels, boolean centerCropIfNeeded)	Instantiate an image with the given height and width
	NativeImageLoader(long height, long width, long channels, BaseImageLoader.MultiPageMode mode)	Instantiate an image with the given height and width
	NativeImageLoader(long height, long width, long channels, ImageTransform imageTransform)	Instantiate an image with the given height and width
protected	NativeImageLoader(NativeImageLoader other)

Method Summary

Modifier and Type	Method	Description
org.bytedeco.javacv.Frame	asFrame(INDArray array)	Returns asFrame(array, -1).
org.bytedeco.javacv.Frame	asFrame(INDArray array, int dataType)	Converts an INDArray to a JavaCV Frame.
Image	asImageMatrix(File f)	As per BaseImageLoader.asMatrix(File) but as an Image
Image	asImageMatrix(File f, boolean nchw)	As per BaseImageLoader.asMatrix(File, boolean) but as an Image
Image	asImageMatrix(InputStream is)	As per BaseImageLoader.asMatrix(InputStream) but as an Image
Image	asImageMatrix(InputStream inputStream, boolean nchw)	As per BaseImageLoader.asMatrix(InputStream, boolean) but as an Image
Image	asImageMatrix(String filename)
org.bytedeco.opencv.opencv_core.Mat	asMat(INDArray array)	Returns asMat(array, -1).
org.bytedeco.opencv.opencv_core.Mat	asMat(INDArray array, int dataType)	Converts an INDArray to an OpenCV Mat.
INDArray	asMatrix(File f)	As per BaseImageLoader.asMatrix(File, boolean) but NCHW/channels_first format
INDArray	asMatrix(File f, boolean nchw)	Load an image from a file to an INDArray
INDArray	asMatrix(InputStream is)
INDArray	asMatrix(InputStream inputStream, boolean nchw)	Load an image file from an input stream to an INDArray
INDArray	asMatrix(Object image)	Calls AndroidNativeImageLoader.asMatrix(android.graphics.Bitmap) or Java2DNativeImageLoader.asMatrix(java.awt.image.BufferedImage).
INDArray	asMatrix(String filename)
INDArray	asMatrix(org.bytedeco.javacv.Frame image)
INDArray	asMatrix(org.bytedeco.opencv.opencv_core.Mat image)
INDArray	asMatrix(ImageWritable writable)	Convert ImageWritable to INDArray
INDArray	asMatrix(org.opencv.core.Mat image)
void	asMatrixView(File f, INDArray view)
void	asMatrixView(InputStream is, INDArray view)
void	asMatrixView(String filename, INDArray view)
void	asMatrixView(org.bytedeco.opencv.opencv_core.Mat image, INDArray view)
void	asMatrixView(org.opencv.core.Mat image, INDArray view)
INDArray	asRowVector(File f)	Convert a file to a row vector
INDArray	asRowVector(InputStream is)
INDArray	asRowVector(Object image)	Returns asMatrix(image).ravel().
INDArray	asRowVector(String filename)
INDArray	asRowVector(org.bytedeco.javacv.Frame image)
INDArray	asRowVector(org.bytedeco.opencv.opencv_core.Mat image)
INDArray	asRowVector(org.opencv.core.Mat image)
ImageWritable	asWritable(File f)	Convert a file to a INDArray
ImageWritable	asWritable(String filename)
protected org.bytedeco.opencv.opencv_core.Mat	centerCropIfNeeded(org.bytedeco.opencv.opencv_core.Mat img)
protected void	fillNDArray(org.bytedeco.opencv.opencv_core.Mat image, INDArray ret)
String[]	getAllowedFormats()
protected org.bytedeco.opencv.opencv_core.Mat	scalingIfNeed(org.bytedeco.opencv.opencv_core.Mat image)
protected org.bytedeco.opencv.opencv_core.Mat	scalingIfNeed(org.bytedeco.opencv.opencv_core.Mat image, long dstHeight, long dstWidth)
protected INDArray	transformImage(org.bytedeco.opencv.opencv_core.Mat image, INDArray ret)
protected INDArray	transformImage(org.opencv.core.Mat image, INDArray ret)

Methods inherited from class org.datavec.image.loader.BaseImageLoader

downloadAndUntar

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

converter

protected org.bytedeco.javacv.OpenCVFrameConverter.ToMat converter

Constructor Detail

NativeImageLoader

public NativeImageLoader()

Loads images with no scaling or conversion.

NativeImageLoader

public NativeImageLoader(long height,
                         long width)

Instantiate an image with the given height and width

Parameters:

height - the height to load

width - the width to load

NativeImageLoader

public NativeImageLoader(long height,
                         long width,
                         long channels)

Instantiate an image with the given height and width

Parameters:

height - the height to load

width - the width to load

channels - the number of channels for the image*

NativeImageLoader

public NativeImageLoader(long height,
                         long width,
                         long channels,
                         boolean centerCropIfNeeded)

Instantiate an image with the given height and width

Parameters:

height - the height to load

width - the width to load

channels - the number of channels for the image*

centerCropIfNeeded - to crop before rescaling and converting

NativeImageLoader

public NativeImageLoader(long height,
                         long width,
                         long channels,
                         ImageTransform imageTransform)

Instantiate an image with the given height and width

Parameters:

height - the height to load

width - the width to load

channels - the number of channels for the image*

imageTransform - to use before rescaling and converting

NativeImageLoader

public NativeImageLoader(long height,
                         long width,
                         long channels,
                         BaseImageLoader.MultiPageMode mode)

Instantiate an image with the given height and width

Parameters:

height - the height to load

width - the width to load

channels - the number of channels for the image*

mode - how to load multipage image

NativeImageLoader

protected NativeImageLoader(NativeImageLoader other)

Method Detail

getAllowedFormats

public String[] getAllowedFormats()

Overrides:

getAllowedFormats in class BaseImageLoader

asRowVector

public INDArray asRowVector(String filename)
                     throws IOException

Throws:

IOException

asRowVector

public INDArray asRowVector(File f)
                     throws IOException

Convert a file to a row vector

Specified by:

asRowVector in class BaseImageLoader

Parameters:

f - the image to convert

Returns:

the flattened image

Throws:

IOException

asRowVector

public INDArray asRowVector(InputStream is)
                     throws IOException

Specified by:

asRowVector in class BaseImageLoader

Throws:

IOException

asRowVector

public INDArray asRowVector(Object image)
                     throws IOException

Returns asMatrix(image).ravel().

Throws:

IOException

See Also:

asMatrix(Object)

asRowVector

public INDArray asRowVector(org.bytedeco.javacv.Frame image)
                     throws IOException

Throws:

IOException

asRowVector

public INDArray asRowVector(org.bytedeco.opencv.opencv_core.Mat image)
                     throws IOException

Throws:

IOException

asRowVector

public INDArray asRowVector(org.opencv.core.Mat image)
                     throws IOException

Throws:

IOException

asMatrix

public INDArray asMatrix(String filename)
                  throws IOException

Throws:

IOException

asMatrix

public INDArray asMatrix(File f)
                  throws IOException

Description copied from class: BaseImageLoader

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

Specified by:

asMatrix in class BaseImageLoader

Throws:

IOException

asMatrix

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

Description copied from class: BaseImageLoader

Load an image from a file to an INDArray

Specified by:

asMatrix in class BaseImageLoader

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 INDArray asMatrix(InputStream is)
                  throws IOException

Specified by:

asMatrix in class BaseImageLoader

Throws:

IOException

asMatrix

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

Description copied from class: BaseImageLoader

Load an image file from an input stream to an INDArray

Specified by:

asMatrix in class BaseImageLoader

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 Image asImageMatrix(String filename)
                    throws IOException

Throws:

IOException

asImageMatrix

public Image asImageMatrix(File f)
                    throws IOException

Description copied from class: BaseImageLoader

As per BaseImageLoader.asMatrix(File) but as an Image

Specified by:

asImageMatrix in class BaseImageLoader

Throws:

IOException

asImageMatrix

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

Description copied from class: BaseImageLoader

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

Specified by:

asImageMatrix in class BaseImageLoader

Throws:

IOException

asImageMatrix

public Image asImageMatrix(InputStream is)
                    throws IOException

Description copied from class: BaseImageLoader

As per BaseImageLoader.asMatrix(InputStream) but as an Image

Specified by:

asImageMatrix in class BaseImageLoader

Throws:

IOException

asImageMatrix

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

Description copied from class: BaseImageLoader

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

Specified by:

asImageMatrix in class BaseImageLoader

Throws:

IOException

asMatrix

public INDArray asMatrix(Object image)
                  throws IOException

Calls AndroidNativeImageLoader.asMatrix(android.graphics.Bitmap) or Java2DNativeImageLoader.asMatrix(java.awt.image.BufferedImage).

Parameters:

image - as a Bitmap or BufferedImage

Returns:

the matrix or null for unsupported object classes

Throws:

IOException

fillNDArray

protected void fillNDArray(org.bytedeco.opencv.opencv_core.Mat image,
                           INDArray ret)

asMatrixView

public void asMatrixView(InputStream is,
                         INDArray view)
                  throws IOException

Throws:

IOException

asMatrixView

public void asMatrixView(String filename,
                         INDArray view)
                  throws IOException

Throws:

IOException

asMatrixView

public void asMatrixView(File f,
                         INDArray view)
                  throws IOException

Throws:

IOException

asMatrixView

public void asMatrixView(org.bytedeco.opencv.opencv_core.Mat image,
                         INDArray view)
                  throws IOException

Throws:

IOException

asMatrixView

public void asMatrixView(org.opencv.core.Mat image,
                         INDArray view)
                  throws IOException

Throws:

IOException

asMatrix

public INDArray asMatrix(org.bytedeco.javacv.Frame image)
                  throws IOException

Throws:

IOException

asMatrix

public INDArray asMatrix(org.opencv.core.Mat image)
                  throws IOException

Throws:

IOException

asMatrix

public INDArray asMatrix(org.bytedeco.opencv.opencv_core.Mat image)
                  throws IOException

Throws:

IOException

transformImage

protected INDArray transformImage(org.opencv.core.Mat image,
                                  INDArray ret)
                           throws IOException

Throws:

IOException

transformImage

protected INDArray transformImage(org.bytedeco.opencv.opencv_core.Mat image,
                                  INDArray ret)
                           throws IOException

Throws:

IOException

centerCropIfNeeded

protected org.bytedeco.opencv.opencv_core.Mat centerCropIfNeeded(org.bytedeco.opencv.opencv_core.Mat img)

scalingIfNeed

protected org.bytedeco.opencv.opencv_core.Mat scalingIfNeed(org.bytedeco.opencv.opencv_core.Mat image)

scalingIfNeed

protected org.bytedeco.opencv.opencv_core.Mat scalingIfNeed(org.bytedeco.opencv.opencv_core.Mat image,
                                                            long dstHeight,
                                                            long dstWidth)

asWritable

public ImageWritable asWritable(String filename)
                         throws IOException

Throws:

IOException

asWritable

public ImageWritable asWritable(File f)
                         throws IOException

Convert a file to a INDArray

Parameters:

f - the image to convert

Returns:

INDArray

Throws:

IOException

asMatrix

public INDArray asMatrix(ImageWritable writable)
                  throws IOException

Convert ImageWritable to INDArray

Parameters:

writable - ImageWritable to convert

Returns:

INDArray

Throws:

IOException

asFrame

public org.bytedeco.javacv.Frame asFrame(INDArray array)

Returns asFrame(array, -1).

asFrame

public org.bytedeco.javacv.Frame asFrame(INDArray array,
                                         int dataType)

Converts an INDArray to a JavaCV Frame. Only intended for images with rank 3.

Parameters:

array - to convert

dataType - from JavaCV (DEPTH_FLOAT, DEPTH_UBYTE, etc), or -1 to use same type as the INDArray

Returns:

data copied to a Frame

asMat

public org.bytedeco.opencv.opencv_core.Mat asMat(INDArray array)

Returns asMat(array, -1).

asMat

public org.bytedeco.opencv.opencv_core.Mat asMat(INDArray array,
                                                 int dataType)

Converts an INDArray to an OpenCV Mat. Only intended for images with rank 3.

Parameters:

array - to convert

dataType - from OpenCV (CV_32F, CV_8U, etc), or -1 to use same type as the INDArray

Returns:

data copied to a Mat