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
int	getColorTemperature() Retrieves white-balance color temperature of the light source, in kelvins
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.
Pointer	getExposureTime() Retrieves exposure time
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
int	getLensPosition() Retrieves lens position, range 0..255.
ImgFrame	getPointer(long i)
int	getSensitivity() Retrieves sensitivity, as an ISO value
long	getSequenceNum() Retrieves image sequence number
Pointer	getTimestamp() Retrieves image timestamp (end of exposure) related to dai::Clock::now()
Pointer	getTimestamp(depthai.CameraExposureOffset offset) Retrieves image timestamp (at the specified offset of exposure) related to dai::Clock::now()
Pointer	getTimestamp(int offset)
Pointer	getTimestampDevice() Retrieves image timestamp (end of exposure) directly captured from device's monotonic clock, not synchronized to host time.
Pointer	getTimestampDevice(depthai.CameraExposureOffset offset) Retrieves image timestamp (at the specified offset of exposure) directly captured from device's monotonic clock, not synchronized to host time.
Pointer	getTimestampDevice(int offset)
RawImgFrame.Type	getType() Retrieves image type
int	getWidth() Retrieves image width in pixels
ImgFrame	position(long position)
ImgFrame	setCategory(int category)
ImgFrame	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
ImgFrame	setHeight(int height) Specifies frame height
ImgFrame	setInstanceNum(int instance) Instance number relates to the origin of the frame (which camera)
ImgFrame	setSequenceNum(long seq) Specifies sequence number
ImgFrame	setSize(int width, int height) Specifies frame size
ImgFrame	setSize(Pointer size) Specifies frame size
ImgFrame	setTimestamp(Pointer timestamp) Retrieves image timestamp related to dai::Clock::now()
ImgFrame	setTimestampDevice(Pointer timestamp) Sets image timestamp related to dai::Clock::now()
ImgFrame	setType(int type)
ImgFrame	setType(RawImgFrame.Type type) Specifies frame type, RGB, BGR, ...
ImgFrame	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, serialize

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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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 (end of exposure) related to dai::Clock::now()

getTimestampDevice

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

Retrieves image timestamp (end of exposure) directly captured from device's monotonic clock, not synchronized to host time. Used when monotonicity is required.

getTimestamp

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

Retrieves image timestamp (at the specified offset of exposure) related to dai::Clock::now()

getTimestamp

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

getTimestampDevice

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

Retrieves image timestamp (at the specified offset of exposure) directly captured from device's monotonic clock, not synchronized to host time. Used when monotonicity is required.

getTimestampDevice

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

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="int64_t")
public long 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

getExposureTime

@ByVal
 @Cast(value="std::chrono::microseconds*")
public Pointer getExposureTime()

Retrieves exposure time

getSensitivity

public int getSensitivity()

Retrieves sensitivity, as an ISO value

getColorTemperature

public int getColorTemperature()

Retrieves white-balance color temperature of the light source, in kelvins

getLensPosition

public int getLensPosition()

Retrieves lens position, range 0..255. Returns -1 if not available

setTimestamp

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

Retrieves image timestamp related to dai::Clock::now()

setTimestampDevice

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

Sets image timestamp related to dai::Clock::now()

setInstanceNum

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

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

Parameters:

instance - Instance number

setCategory

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

Parameters:

category - Image category

setSequenceNum

@ByRef
public ImgFrame setSequenceNum(@Cast(value="int64_t")
                                      long seq)

Specifies sequence number

Parameters:

seq - Sequence number

setWidth

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

Specifies frame width

Parameters:

width - frame width

setHeight

@ByRef
public ImgFrame setHeight(@Cast(value="unsigned int")
                                 int height)

Specifies frame height

Parameters:

height - frame height

setSize

@ByRef
public ImgFrame setSize(@Cast(value="unsigned int")
                               int width,
                               @Cast(value="unsigned int")
                               int height)

Specifies frame size

Parameters:

height - frame height

width - frame width

setSize

@ByRef
public ImgFrame setSize(@ByVal @Cast(value="std::tuple<unsigned int,unsigned int>*")
                               Pointer size)

Specifies frame size

Parameters:

size - frame size

setType

@ByRef
public ImgFrame setType(RawImgFrame.Type type)

Specifies frame type, RGB, BGR, ...

Parameters:

type - Type of image

setType

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

setFrame

@ByRef
public ImgFrame 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