org.bytedeco.depthai

Class NNData

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.ADatatype

org.bytedeco.depthai.Buffer

org.bytedeco.depthai.NNData

All Implemented Interfaces:

AutoCloseable

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

NNData message. Carries tensors and their 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
NNData() Construct NNData message.
NNData(long size) Native array allocator.
NNData(Pointer p) Pointer cast constructor.
NNData(RawNNData ptr)

Method Summary

Modifier and Type	Method and Description
StringVector	getAllLayerNames()
TensorInfo	getAllLayers()
FloatPointer	getFirstLayerFp16() Convenience function to retrieve float values from first layers FP16 tensor
IntPointer	getFirstLayerInt32() Convenience function to retrieve INT32 values from first layers tensor
BytePointer	getFirstLayerUInt8() Convenience function to retrieve U8 data from first layer
boolean	getLayer(ByteBuffer name, TensorInfo tensor)
boolean	getLayer(BytePointer name, TensorInfo tensor) Retrieve layers tensor information
boolean	getLayer(String name, TensorInfo tensor)
boolean	getLayerDatatype(ByteBuffer name, IntBuffer datatype)
boolean	getLayerDatatype(BytePointer name, IntPointer datatype) Retrieve datatype of a layers tensor
boolean	getLayerDatatype(String name, int[] datatype)
FloatBuffer	getLayerFp16(ByteBuffer name)
FloatPointer	getLayerFp16(BytePointer name) Convenience function to retrieve float values from layers FP16 tensor
float[]	getLayerFp16(String name)
IntBuffer	getLayerInt32(ByteBuffer name)
IntPointer	getLayerInt32(BytePointer name) Convenience function to retrieve INT32 values from layers tensor
int[]	getLayerInt32(String name)
ByteBuffer	getLayerUInt8(ByteBuffer name)
BytePointer	getLayerUInt8(BytePointer name) Convenience function to retrieve U8 data from layer
byte[]	getLayerUInt8(String name)
NNData	getPointer(long i)
long	getSequenceNum() Retrieves image sequence number
Pointer	getTimestamp() Retrieves image timestamp related to dai::Clock::now()
Pointer	getTimestampDevice() Retrieves image timestamp directly captured from device's monotonic clock, not synchronized to host time.
boolean	hasLayer(ByteBuffer name)
boolean	hasLayer(BytePointer name) Checks if given layer exists
boolean	hasLayer(String name)
NNData	position(long position)
NNData	setLayer(ByteBuffer name, ByteBuffer data)
NNData	setLayer(ByteBuffer name, DoubleBuffer data)
NNData	setLayer(ByteBuffer name, FloatBuffer data)
NNData	setLayer(ByteBuffer name, IntVector data)
NNData	setLayer(BytePointer name, BytePointer data) Set a layer with datatype U8.
NNData	setLayer(BytePointer name, DoublePointer data) Set a layer with datatype FP16.
NNData	setLayer(BytePointer name, FloatPointer data) Set a layer with datatype FP16.
NNData	setLayer(BytePointer name, IntVector data) Set a layer with datatype U8.
NNData	setLayer(String name, byte[] data)
NNData	setLayer(String name, double[] data)
NNData	setLayer(String name, float[] data)
NNData	setLayer(String name, IntVector data)
NNData	setSequenceNum(long sequenceNum) Retrieves image sequence number
NNData	setTimestamp(Pointer timestamp) Sets image timestamp related to dai::Clock::now()
NNData	setTimestampDevice(Pointer timestamp) Sets image timestamp related to dai::Clock::now()

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

NNData

public NNData(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

NNData

public NNData(long size)

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

NNData

public NNData()

Construct NNData message.

NNData

public NNData(@SharedPtr
              RawNNData ptr)

Method Detail

position

public NNData position(long position)

Overrides:

position in class Buffer

getPointer

public NNData getPointer(long i)

Overrides:

getPointer in class Buffer

setLayer

@ByRef
public NNData setLayer(@StdString
                              BytePointer name,
                              @Cast(value="std::uint8_t*") @StdVector
                              BytePointer data)

Set a layer with datatype U8.

Parameters:

name - Name of the layer

data - Data to store

setLayer

@ByRef
public NNData setLayer(@StdString
                              ByteBuffer name,
                              @Cast(value="std::uint8_t*") @StdVector
                              ByteBuffer data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              String name,
                              @Cast(value="std::uint8_t*") @StdVector
                              byte[] data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              BytePointer name,
                              @Const @ByRef
                              IntVector data)

Set a layer with datatype U8. Integers are cast to bytes.

Parameters:

name - Name of the layer

data - Data to store

setLayer

@ByRef
public NNData setLayer(@StdString
                              ByteBuffer name,
                              @Const @ByRef
                              IntVector data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              String name,
                              @Const @ByRef
                              IntVector data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              BytePointer name,
                              @StdVector
                              FloatPointer data)

Set a layer with datatype FP16. Float values are converted to FP16.

Parameters:

name - Name of the layer

data - Data to store

setLayer

@ByRef
public NNData setLayer(@StdString
                              ByteBuffer name,
                              @StdVector
                              FloatBuffer data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              String name,
                              @StdVector
                              float[] data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              BytePointer name,
                              @StdVector
                              DoublePointer data)

Set a layer with datatype FP16. Double values are converted to FP16.

Parameters:

name - Name of the layer

data - Data to store

setLayer

@ByRef
public NNData setLayer(@StdString
                              ByteBuffer name,
                              @StdVector
                              DoubleBuffer data)

setLayer

@ByRef
public NNData setLayer(@StdString
                              String name,
                              @StdVector
                              double[] data)

getAllLayerNames

@ByVal
public StringVector getAllLayerNames()

Returns:

Names of all layers added

getAllLayers

@StdVector
public TensorInfo getAllLayers()

Returns:

All layers and their information

getLayer

@Cast(value="bool")
public boolean getLayer(@StdString
                                            BytePointer name,
                                            @ByRef
                                            TensorInfo tensor)

Retrieve layers tensor information

Parameters:

name - Name of the layer

tensor - [out] Outputs tensor information of that layer

Returns:

True if layer exists, false otherwise

getLayer

@Cast(value="bool")
public boolean getLayer(@StdString
                                            ByteBuffer name,
                                            @ByRef
                                            TensorInfo tensor)

getLayer

@Cast(value="bool")
public boolean getLayer(@StdString
                                            String name,
                                            @ByRef
                                            TensorInfo tensor)

hasLayer

@Cast(value="bool")
public boolean hasLayer(@StdString
                                            BytePointer name)

Checks if given layer exists

Parameters:

name - Name of the layer

Returns:

True if layer exists, false otherwise

hasLayer

@Cast(value="bool")
public boolean hasLayer(@StdString
                                            ByteBuffer name)

hasLayer

@Cast(value="bool")
public boolean hasLayer(@StdString
                                            String name)

getLayerDatatype

@Cast(value="bool")
public boolean getLayerDatatype(@StdString
                                                    BytePointer name,
                                                    @ByRef @Cast(value="dai::TensorInfo::DataType*")
                                                    IntPointer datatype)

Retrieve datatype of a layers tensor

Parameters:

name - Name of the layer

datatype - [out] Datatype of layers tensor

Returns:

True if layer exists, false otherwise

getLayerDatatype

@Cast(value="bool")
public boolean getLayerDatatype(@StdString
                                                    ByteBuffer name,
                                                    @ByRef @Cast(value="dai::TensorInfo::DataType*")
                                                    IntBuffer datatype)

getLayerDatatype

@Cast(value="bool")
public boolean getLayerDatatype(@StdString
                                                    String name,
                                                    @ByRef @Cast(value="dai::TensorInfo::DataType*")
                                                    int[] datatype)

getLayerUInt8

@Cast(value="std::uint8_t*")
 @StdVector
public BytePointer getLayerUInt8(@StdString
                                                                          BytePointer name)

Convenience function to retrieve U8 data from layer

Parameters:

name - Name of the layer

Returns:

U8 binary data

getLayerUInt8

@Cast(value="std::uint8_t*")
 @StdVector
public ByteBuffer getLayerUInt8(@StdString
                                                                         ByteBuffer name)

getLayerUInt8

@Cast(value="std::uint8_t*")
 @StdVector
public byte[] getLayerUInt8(@StdString
                                                                     String name)

getLayerFp16

@StdVector
public FloatPointer getLayerFp16(@StdString
                                            BytePointer name)

Convenience function to retrieve float values from layers FP16 tensor

Parameters:

name - Name of the layer

Returns:

Float data

getLayerFp16

@StdVector
public FloatBuffer getLayerFp16(@StdString
                                           ByteBuffer name)

getLayerFp16

@StdVector
public float[] getLayerFp16(@StdString
                                       String name)

getLayerInt32

@Cast(value="std::int32_t*")
 @StdVector
public IntPointer getLayerInt32(@StdString
                                                                         BytePointer name)

Convenience function to retrieve INT32 values from layers tensor

Parameters:

name - Name of the layer

Returns:

INT32 data

getLayerInt32

@Cast(value="std::int32_t*")
 @StdVector
public IntBuffer getLayerInt32(@StdString
                                                                        ByteBuffer name)

getLayerInt32

@Cast(value="std::int32_t*")
 @StdVector
public int[] getLayerInt32(@StdString
                                                                    String name)

getFirstLayerUInt8

@Cast(value="std::uint8_t*")
 @StdVector
public BytePointer getFirstLayerUInt8()

Convenience function to retrieve U8 data from first layer

Returns:

U8 binary data

getFirstLayerFp16

@StdVector
public FloatPointer getFirstLayerFp16()

Convenience function to retrieve float values from first layers FP16 tensor

Returns:

Float data

getFirstLayerInt32

@Cast(value="std::int32_t*")
 @StdVector
public IntPointer getFirstLayerInt32()

Convenience function to retrieve INT32 values from first layers tensor

Returns:

INT32 data

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 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 directly captured from device's monotonic clock, not synchronized to host time. Used mostly for debugging

getSequenceNum

@Cast(value="int64_t")
public long getSequenceNum()

Retrieves image sequence number

setTimestamp

@ByRef
public NNData setTimestamp(@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()

setTimestampDevice

@ByRef
public NNData 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()

setSequenceNum

@ByRef
public NNData setSequenceNum(@Cast(value="int64_t")
                                    long sequenceNum)

Retrieves image sequence number