org.bytedeco.depthai

Class ImgFrame

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.ADatatype

org.bytedeco.depthai.Buffer

org.bytedeco.depthai.ImgFrame

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class ImgFrame
extends Buffer

ImgFrame message. Carries image data and metadata.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ImgFrame() Construct ImgFrame message.
ImgFrame(long size) Native array allocator.
ImgFrame(Pointer p) Pointer cast constructor.
ImgFrame(RawImgFrame ptr)

Method Summary

Modifier and Type	Method and Description
int	getCategory() Retrieves image category
org.bytedeco.opencv.opencv_core.Mat	getCvFrame() \note This API only available if OpenCV support is enabled Retrieves cv::Mat suitable for use in common opencv functions.
org.bytedeco.opencv.opencv_core.Mat	getFrame()
org.bytedeco.opencv.opencv_core.Mat	getFrame(boolean copy) \note This API only available if OpenCV support is enabled Retrieves data as cv::Mat with specified width, height and type
int	getHeight() Retrieves image height in pixels
int	getInstanceNum() Retrieves instance number
ImgFrame	getPointer(long i)
int	getSequenceNum() Retrieves image sequence number
Pointer	getTimestamp() Retrieves image timestamp related to steady_clock / time.monotonic
Pointer	getTimestampDevice() Retrieves image timestamp directly captured from device's monotonic clock, not synchronized to host time.
RawImgFrame.Type	getType() Retrieves image type
int	getWidth() Retrieves image width in pixels
ImgFrame	position(long position)
void	setCategory(int category)
void	setFrame(org.bytedeco.opencv.opencv_core.Mat frame) \note This API only available if OpenCV support is enabled Copies cv::Mat data to ImgFrame buffer
void	setHeight(int arg0) Specifies frame height
void	setInstanceNum(int instance) Instance number relates to the origin of the frame (which camera)
void	setSequenceNum(int seq) Specifies sequence number
void	setTimestamp(Pointer timestamp) Specifies current timestamp, related to steady_clock / time.monotonic
void	setType(int type)
void	setType(RawImgFrame.Type type) Specifies frame type, RGB, BGR, ...
void	setWidth(int width) Specifies frame width

Methods inherited from class org.bytedeco.depthai.Buffer

getData, setData, setData, setData

Methods inherited from class org.bytedeco.depthai.ADatatype

getRaw

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImgFrame

public ImgFrame(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ImgFrame

public ImgFrame(long size)

Native array allocator. Access with Pointer.position(long).

ImgFrame

public ImgFrame()

Construct ImgFrame message. Timestamp is set to now

ImgFrame

public ImgFrame(@SharedPtr
                RawImgFrame ptr)

Method Detail

position

public ImgFrame position(long position)

Overrides:

position in class Buffer

getPointer

public ImgFrame getPointer(long i)

Overrides:

getPointer in class Buffer

getTimestamp

@ByVal
 @Cast(value="std::chrono::time_point<std::chrono::steady_clock,std::chrono::steady_clock::duration>*")
public Pointer getTimestamp()

Retrieves image timestamp related to steady_clock / time.monotonic

getTimestampDevice

@ByVal
 @Cast(value="std::chrono::time_point<std::chrono::steady_clock,std::chrono::steady_clock::duration>*")
public Pointer getTimestampDevice()

Retrieves image timestamp directly captured from device's monotonic clock, not synchronized to host time. Used mostly for debugging

getInstanceNum

@Cast(value="unsigned int")
public int getInstanceNum()

Retrieves instance number

getCategory

@Cast(value="unsigned int")
public int getCategory()

Retrieves image category

getSequenceNum

@Cast(value="unsigned int")
public int getSequenceNum()

Retrieves image sequence number

getWidth

@Cast(value="unsigned int")
public int getWidth()

Retrieves image width in pixels

getHeight

@Cast(value="unsigned int")
public int getHeight()

Retrieves image height in pixels

getType

public RawImgFrame.Type getType()

Retrieves image type

setTimestamp

public void setTimestamp(@ByVal @Cast(value="std::chrono::time_point<std::chrono::steady_clock,std::chrono::steady_clock::duration>*")
                         Pointer timestamp)

Specifies current timestamp, related to steady_clock / time.monotonic

setInstanceNum

public void setInstanceNum(@Cast(value="unsigned int")
                           int instance)

Instance number relates to the origin of the frame (which camera)

Parameters:

instance - Instance number

setCategory

public void setCategory(@Cast(value="unsigned int")
                        int category)

Parameters:

category - Image category

setSequenceNum

public void setSequenceNum(@Cast(value="unsigned int")
                           int seq)

Specifies sequence number

Parameters:

seq - Sequence number

setWidth

public void setWidth(@Cast(value="unsigned int")
                     int width)

Specifies frame width

Parameters:

width - frame width

setHeight

public void setHeight(@Cast(value="unsigned int")
                      int arg0)

Specifies frame height

Parameters:

width - frame height

setType

public void setType(RawImgFrame.Type type)

Specifies frame type, RGB, BGR, ...

Parameters:

type - Type of image

setType

public void setType(@Cast(value="dai::RawImgFrame::Type")
                    int type)

setFrame

public void setFrame(@ByVal
                     org.bytedeco.opencv.opencv_core.Mat frame)

\note This API only available if OpenCV support is enabled Copies cv::Mat data to ImgFrame buffer

Parameters:

frame - Input cv::Mat frame from which to copy the data

getFrame

@ByVal
public org.bytedeco.opencv.opencv_core.Mat getFrame(@Cast(value="bool")
                                                           boolean copy)

\note This API only available if OpenCV support is enabled Retrieves data as cv::Mat with specified width, height and type

Parameters:

copy - If false only a reference to data is made, otherwise a copy

Returns:

cv::Mat with corresponding to ImgFrame parameters

getFrame

@ByVal
public org.bytedeco.opencv.opencv_core.Mat getFrame()

getCvFrame

@ByVal
public org.bytedeco.opencv.opencv_core.Mat getCvFrame()

\note This API only available if OpenCV support is enabled Retrieves cv::Mat suitable for use in common opencv functions. ImgFrame is converted to color BGR interleaved or grayscale depending on type. A copy is always made

Returns:

cv::Mat for use in opencv functions