ai.djl.modality.cv

Interface Image

public interface Image

Image is a container of an image in DJL. The storage type of the image depends on the platform you are running on.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Image.Flag Flag indicates the color channel options for images.

Method Summary

Modifier and Type	Method and Description
int	getHeight() Gets the height of the image.
int	getWidth() Gets the width of the image.
java.lang.Object	getWrappedImage() Gets the wrapped image.
void	save(java.io.OutputStream os, java.lang.String type) Save the image to file.
default NDArray	toNDArray(NDManager manager) Converts image to a RGB NDArray.
NDArray	toNDArray(NDManager manager, Image.Flag flag) Converts image to a NDArray.

Method Detail

getWidth

int getWidth()

Gets the width of the image.

Returns:

pixels representing width

getHeight

int getHeight()

Gets the height of the image.

Returns:

pixels representing height

getWrappedImage

java.lang.Object getWrappedImage()

Gets the wrapped image.

Returns:

the wrapped image object

toNDArray

default NDArray toNDArray(NDManager manager)

Converts image to a RGB NDArray.

Parameters:

manager - a NDManager to create the new NDArray with

Returns:

NDArray

toNDArray

NDArray toNDArray(NDManager manager,
                  Image.Flag flag)

Converts image to a NDArray.

Parameters:

manager - a NDManager to create the new NDArray with

flag - the color mode

Returns:

NDArray

save

void save(java.io.OutputStream os,
          java.lang.String type)
   throws java.io.IOException

Save the image to file.

Parameters:

os - OutputStream to save the image.

type - type of the image, such as "png", "jpeg"

Throws:

java.io.IOException - image cannot be saved through output stream