Package 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 Description static class
Image.Flag
Flag indicates the color channel options for images.static class
Image.Interpolation
Interpolation indicates the Interpolation options for resizinig an image.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
drawBoundingBoxes(DetectedObjects detections)
Draws the bounding boxes on the image.void
drawImage(Image overlay, boolean resize)
Draws the overlay on the image.void
drawJoints(Joints joints)
Draws all joints of a body on an image.Image
duplicate()
Gets a deep copy of the original image.java.util.List<BoundingBox>
findBoundingBoxes()
Find bounding boxes from a masked image with 0/1 or 0/255.int
getHeight()
Gets the height of the image.Image
getMask(int[][] mask)
Returns a newImage
of masked area.Image
getSubImage(int x, int y, int w, int h)
Gets the subimage defined by a specified rectangular region.int
getWidth()
Gets the width of the image.java.lang.Object
getWrappedImage()
Gets the wrapped image.Image
resize(int width, int height, boolean copy)
Creates a new resized 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 RGBNDArray
.NDArray
toNDArray(NDManager manager, Image.Flag flag)
Converts image to aNDArray
.
-
-
-
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
-
resize
Image resize(int width, int height, boolean copy)
Creates a new resized image.- Parameters:
width
- the new image's desired widthheight
- the new image's desired heightcopy
- false to return original image if size is the same- Returns:
- the new resized image.
-
getMask
Image getMask(int[][] mask)
Returns a newImage
of masked area.- Parameters:
mask
- the mask for each pixel in the image- Returns:
- the mask image.
-
getSubImage
Image getSubImage(int x, int y, int w, int h)
Gets the subimage defined by a specified rectangular region.- Parameters:
x
- the X coordinate of the upper-left corner of the specified rectangular regiony
- the Y coordinate of the upper-left corner of the specified rectangular regionw
- the width of the specified rectangular regionh
- the height of the specified rectangular region- Returns:
- subimage of this image
-
duplicate
Image duplicate()
Gets a deep copy of the original image.- Returns:
- the copy of the original image.
-
toNDArray
NDArray toNDArray(NDManager manager, Image.Flag flag)
Converts image to aNDArray
.
-
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
-
findBoundingBoxes
java.util.List<BoundingBox> findBoundingBoxes()
Find bounding boxes from a masked image with 0/1 or 0/255.- Returns:
- the List of bounding boxes of the images
-
drawBoundingBoxes
void drawBoundingBoxes(DetectedObjects detections)
Draws the bounding boxes on the image.- Parameters:
detections
- the object detection results
-
drawJoints
void drawJoints(Joints joints)
Draws all joints of a body on an image.- Parameters:
joints
- the joints of the body
-
drawImage
void drawImage(Image overlay, boolean resize)
Draws the overlay on the image.- Parameters:
overlay
- the overlay imageresize
- true to resize the overlay image to match the image
-
-