Class representing a multi-dimensional array (Tensor), typically used for deep learning inference. More...

Functions
	Tensor (const TensorParameters &params={})
	Default constructor. More...

	Tensor (const Tensor &tensor)
	Copy constructor (shallow copy). More...

void	alloc (const TensorParameters &params)
	Allocates the Tensor memory. More...

std::vector< size_t >	getDims () const
	Returns the dimensions of the Tensor. More...

size_t	getElementCount () const
	Returns the total number of elements in the Tensor. More...

TensorParameters	getParameters () const
	Returns the parameters used to create or define the Tensor. More...

void	alloc (size_t width, size_t height, MAT_TYPE mat_type, MEM memory_type=MEM::CPU)
	Allocates the sl::Mat memory. More...

void	alloc (Resolution resolution, MAT_TYPE mat_type, MEM memory_type=MEM::CPU)
	Allocates the sl::Mat memory. More...

void	free (MEM memory_type=MEM::BOTH)
	Free the owned memory. More...

ERROR_CODE	updateCPUfromGPU (cudaStream_t stream=0)
	Downloads data from DEVICE (GPU) to HOST (CPU), if possible. More...

ERROR_CODE	updateGPUfromCPU (cudaStream_t stream=0, int GPU_id=0)
	Uploads data from HOST (CPU) to DEVICE (GPU), if possible. More...

ERROR_CODE	copyTo (Mat &dst, COPY_TYPE cpyType=COPY_TYPE::CPU_CPU, cudaStream_t stream=0) const
	Copies data an other sl::Mat (deep copy). More...

ERROR_CODE	setFrom (const Mat &src, COPY_TYPE cpyType=COPY_TYPE::CPU_CPU, cudaStream_t stream=0)
	Copies data from an other sl::Mat (deep copy). More...

ERROR_CODE	read (const String &filePath)
	Reads an image from a file. More...

ERROR_CODE	write (const String &filePath, sl::MEM memory_type=sl::MEM::CPU, int compression_level=-1)
	Writes the sl::Mat (only if sl::MEM::CPU is available) into a file defined by its extension. More...

template<typename T >
ERROR_CODE	setTo (const T &value, const sl::MEM memory_type=MEM::CPU, cudaStream_t stream=0)
	Fills the sl::Mat with the given value. More...

template<typename N >
ERROR_CODE	setValue (const size_t x, const size_t y, const N &value, const sl::MEM memory_type=MEM::CPU)
	Sets a value to a specific point in the matrix. More...

template<typename N >
ERROR_CODE	getValue (const size_t x, const size_t y, N *value, const MEM memory_type=MEM::CPU) const
	Get the value of a specific point in the matrix. More...

size_t	getWidth () const
	Returns the width of the matrix. More...

size_t	getHeight () const
	Returns the height of the matrix. More...

const Resolution &	getResolution () const &
	Returns the resolution (width and height) of the matrix. More...

Resolution	getResolution () &&
	Returns the resolution (width and height) of the matrix. More...

void	getResolution () const &&=delete
	Prevent method from being called by temporaries (such as rvalue) More...

size_t	getChannels () const
	Returns the number of values stored in one pixel. More...

MAT_TYPE	getDataType () const
	Returns the format of the matrix. More...

MEM	getMemoryType () const
	Returns the type of memory (CPU and/or GPU). More...

template<typename N >
N *	getPtr (const MEM memory_type=MEM::CPU) const
	Returns the CPU or GPU data pointer. More...

size_t	getStepBytes (const MEM memory_type=MEM::CPU) const
	Returns the memory step in bytes (size of one pixel row). More...

template<typename N >
size_t	getStep (const MEM memory_type=MEM::CPU) const
	Returns the memory step in number of elements (size in one pixel row). More...

size_t	getStep (MEM memory_type=MEM::CPU) const
	Returns the memory step in number of elements (size in one pixel row). More...

size_t	getPixelBytes () const
	Returns the size of one pixel in bytes. More...

size_t	getWidthBytes () const
	Returns the size of a row in bytes. More...

String	getInfos () const
	Returns the information about the sl::Mat into a sl::String. More...

bool	isInit () const
	Returns whether the sl::Mat is initialized or not. More...

bool	isMemoryOwner () const
	Returns whether the sl::Mat is the owner of the memory it accesses. More...

ERROR_CODE	clone (const Mat &src)
	Duplicates a sl::Mat by copy (deep copy). More...

ERROR_CODE	move (Mat &dst)
	Moves the data of the sl::Mat to another sl::Mat. More...

ERROR_CODE	convertColor (sl::MEM memory=sl::MEM::CPU, cudaStream_t stream=0, bool swap_RB_channels=true)
	Convert the color channels of the Mat (RGB<->BGR or RGBA<->BGRA) This methods works only on 8U_C4 or 8U_C3. More...

Static Functions
static ERROR_CODE	convertColor (Mat &mat1, Mat &mat2, bool swap_RB_channels, bool remove_alpha_channels, sl::MEM memory=sl::MEM::CPU, cudaStream_t stream=0)
	Convert the color channels of the Mat into another Mat This methods works only on 8U_C4 if remove_alpha_channels is enabled, or 8U_C4 and 8U_C3 if swap_RB_channels is enabled The inplace method sl::Mat::convertColor can be used for only swapping the Red and Blue channel efficiently. More...

static void	swap (Mat &mat1, Mat &mat2)
	Swaps the content of the provided sl::Mat (only swaps the pointers, no data copy). More...

Attributes
String	name
	Variable used in verbose mode to indicate which sl::Mat is printing informations. More...

bool	verbose = false
	Whether the sl::Mat can display informations. More...

Timestamp	timestamp = 0
	Timestamp of the last manipulation of the data of the matrix by a method/function. More...

Protected Member Functions
void	ref (const Mat &mat)

Protected Attributes
Resolution	size

size_t	channels = 0

size_t	step_gpu = 0

size_t	step_cpu = 0

size_t	pixel_bytes = 0

MAT_TYPE	data_type = MAT_TYPE::U8_C1

MEM	mem_type = MEM::CPU

std::shared_ptr< uchar1 >	ptr_cpu = NULL

std::shared_ptr< uchar1 >	ptr_gpu = NULL

bool	init = false

bool	memory_owner = false

Detailed Description

Class representing a multi-dimensional array (Tensor), typically used for deep learning inference.

Note: It inherits from Mat.

Constructor and Destructor

◆ Tensor() [1/2]

Tensor ( const TensorParameters & params = {} )

Default constructor.

Parameters

params : Parameters defining the Tensor creation and pre-processing.

◆ Tensor() [2/2]

Tensor ( const Tensor & tensor )

Copy constructor (shallow copy).

Parameters

tensor : The sl::Tensor to copy.

Functions

◆ alloc() [1/3]

void alloc ( const TensorParameters & params )

Allocates the Tensor memory.

Parameters

params : Parameters defining the Tensor creation.

◆ getDims()

std::vector<size_t> getDims ( ) const

Returns the dimensions of the Tensor.

Returns: A vector containing the size of each dimension (e.g., {Batch, Channels, Height, Width} for NCHW).

◆ getElementCount()

size_t getElementCount ( ) const

Returns the total number of elements in the Tensor.

Returns: The product of all dimensions.

◆ getParameters()

TensorParameters getParameters ( ) const

Returns the parameters used to create or define the Tensor.

Returns: The TensorParameters associated with this Tensor.

◆ ref()

void ref ( const Mat & mat )

protectedinherited

◆ alloc() [2/3]

void alloc	(	size_t	width,
		size_t	height,
		MAT_TYPE	mat_type,
		MEM	memory_type = `MEM::CPU`
	)

inherited

Allocates the sl::Mat memory.

Parameters

width	: Width of the matrix in pixels.
height	: Height of the matrix in pixels.
mat_type	: Type of the matrix (sl::MAT_TYPE::F32_C1, sl::MAT_TYPE::U8_C4, etc.).
memory_type	: Where the buffer will be stored (sl::MEM::CPU and/or sl::MEM::GPU).

Warning: It erases previously allocated memory.

◆ alloc() [3/3]

void alloc	(	Resolution	resolution,
		MAT_TYPE	mat_type,
		MEM	memory_type = `MEM::CPU`
	)

inherited

Allocates the sl::Mat memory.

Parameters

resolution	: Size of the matrix in pixels.
mat_type	: Type of the matrix (sl::MAT_TYPE::F32_C1, sl::MAT_TYPE::U8_C4, etc.).
memory_type	: Where the buffer will be stored (sl::MEM::CPU and/or sl::MEM::GPU).

Warning: It erases previously allocated memory.

◆ free()

void free ( MEM memory_type = MEM::BOTH )

inherited

Free the owned memory.

Parameters

memory_type : Specifies whether you want to free the sl::MEM::CPU and/or sl::MEM::GPU memory.

◆ updateCPUfromGPU()

ERROR_CODE updateCPUfromGPU ( cudaStream_t stream = 0 )

inherited

Downloads data from DEVICE (GPU) to HOST (CPU), if possible.

Parameters

stream : Specifies the GPU stream to be used to enable asynchronous overlapping. Default: 0 (synchronous)

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: If no CPU or GPU memory are available for this sl::Mat, some are directly allocated.; If verbose is set to true, you have information in case of failure.

◆ updateGPUfromCPU()

ERROR_CODE updateGPUfromCPU	(	cudaStream_t	stream = `0`,
		int	GPU_id = `0`
	)

inherited

Uploads data from HOST (CPU) to DEVICE (GPU), if possible.

Parameters

stream	: Specifies the GPU stream to be used to enable asynchronous overlapping. Default: 0 (synchronous)
GPU_id	: Specifies the GPU id to be used. Default: 0 (first GPU).

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: If no CPU or GPU memory are available for this sl::Mat, some are directly allocated.; If verbose is set to true, you have information in case of failure.

◆ copyTo()

ERROR_CODE copyTo	(	Mat &	dst,
		COPY_TYPE	cpyType = `COPY_TYPE::CPU_CPU`,
		cudaStream_t	stream = `0`
	)		const

inherited

Copies data an other sl::Mat (deep copy).

Parameters

dst	: sl::Mat where the data will be copied.
cpyType	: Specifies the memory that will be used for the copy.
stream	: Specifies the GPU stream to be used to enable asynchronous overlapping. Default: 0 (synchronous)

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: If the destination is not allocated or or doesn't have a compatible sl::MAT_TYPE or sl::Resolution, current memory is freed and new memory is directly allocated.

◆ setFrom()

ERROR_CODE setFrom	(	const Mat &	src,
		COPY_TYPE	cpyType = `COPY_TYPE::CPU_CPU`,
		cudaStream_t	stream = `0`
	)

inherited

Copies data from an other sl::Mat (deep copy).

Parameters

src	: sl::Mat where the data will be copied from.
cpyType	: Specifies the memory that will be used for the copy.
stream	: Specifies the GPU stream to be used to enable asynchronous overlapping. Default: 0 (synchronous)

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: If the destination is not allocated or or doesn't have a compatible sl::MAT_TYPE or sl::Resolution, current memory is freed and new memory is directly allocated.

◆ read()

ERROR_CODE read ( const String & filePath )

inherited

Reads an image from a file.

Parameters

filePath : Path of the file to read (including the name and extension).

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: This method only support images such as JPG or PNG, and can't load float format such as PCD, PLY, etc.

◆ write()

ERROR_CODE write	(	const String &	filePath,
		sl::MEM	memory_type = `sl::MEM::CPU`,
		int	compression_level = `-1`
	)

inherited

Writes the sl::Mat (only if sl::MEM::CPU is available) into a file defined by its extension.

Parameters

filePath	: Path of the file to write in (including the name and extension).
memory_type	: Memory type (CPU or GPU) of the sl::Mat.
compression_level	: Level of compression between 0 (lowest compression == highest size == highest quality(jpg)) and 100 (highest compression == lowest size == lowest quality(jpg)).

Note: Specific/default value for compression_level = -1 : This will set the default quality for PNG(30) or JPEG(5).; compression_level is only supported for U8_Cx sl::MAT_TYPE.

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note

Supported sl::MAT_TYPE are:

sl::MAT_TYPE::F32_C1 for PNG/PFM/PGM
sl::MAT_TYPE::F32_C3 for PCD/PLY/VTK/XYZ
sl::MAT_TYPE::F32_C4 for PCD/PLY/VTK/WYZ
sl::MAT_TYPE::U8_C1 for PNG/JPG
sl::MAT_TYPE::U8_C3 for PNG/JPG
sl::MAT_TYPE::U8_C4 for PNG/JPG

◆ setTo()

ERROR_CODE setTo	(	const T &	value,
		const sl::MEM	memory_type = `MEM::CPU`,
		cudaStream_t	stream = `0`
	)

inherited

Fills the sl::Mat with the given value.

This method overwrites all the matrix.

Parameters

value	: Value to be copied all over the matrix.
memory_type	: Which buffer to fill, CPU and/or GPU.
stream	: a cuda stream to put the compute to (default 0).

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: This method is templated for sl::uchar1, sl::uchar2, sl::uchar3, sl::uchar4, sl::float1, sl::float2, sl::float3, sl::float4, sl::char4, sl::ushort1.

◆ setValue()

ERROR_CODE setValue	(	const size_t	x,
		const size_t	y,
		const N &	value,
		const sl::MEM	memory_type = `MEM::CPU`
	)

inherited

Sets a value to a specific point in the matrix.

Parameters

x	: Column of the point to change.
y	: Row of the point to change.
value	: Value to be set.
memory_type	: Which memory will be updated.

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: This method is templated for sl::uchar1, sl::uchar2, sl::uchar3, sl::uchar4, sl::float1, sl::float2, sl::float3, sl::float4, sl::char4, sl::ushort1.

Warning: Not efficient for sl::MEM::GPU, use it on sparse data.

◆ getValue()

ERROR_CODE getValue	(	const size_t	x,
		const size_t	y,
		N *	value,
		const MEM	memory_type = `MEM::CPU`
	)		const

inherited

Get the value of a specific point in the matrix.

Parameters

x	: Column of the point to get the value from.
y	: Row of the point to get the value from.
value	: Pointer to the value to be filled.
memory_type	: Which memory should be read.

Returns: sl::ERROR_CODE::SUCCESS if everything went well, sl::ERROR_CODE::FAILURE otherwise.

Note: This method is templated for sl::uchar1, sl::uchar2, sl::uchar3, sl::uchar4, sl::float1, sl::float2, sl::float3, sl::float4, sl::char4, sl::ushort1.

Warning: Not efficient for sl::MEM::GPU, use it on sparse data.

◆ getWidth()

size_t getWidth ( ) const

inlineinherited

Returns the width of the matrix.

Returns: Width of the matrix in pixels.

◆ getHeight()

size_t getHeight ( ) const

inlineinherited

Returns the height of the matrix.

Returns: Height of the matrix in pixels.

◆ getResolution() [1/3]

const Resolution& getResolution ( ) const &

inlineinherited

Returns the resolution (width and height) of the matrix.

Returns: Resolution of the matrix in pixels.

◆ getResolution() [2/3]

Resolution getResolution ( ) &&

inlineinherited

Returns the resolution (width and height) of the matrix.

Returns: Resolution of the matrix in pixels.

◆ getResolution() [3/3]

void getResolution ( ) const &&

deleteinherited

Prevent method from being called by temporaries (such as rvalue)

◆ getChannels()

size_t getChannels ( ) const

inlineinherited

Returns the number of values stored in one pixel.

Returns: Number of values in a pixel.

◆ getDataType()

MAT_TYPE getDataType ( ) const

inlineinherited

Returns the format of the matrix.

Returns: Format of the current sl::Mat.

◆ getMemoryType()

MEM getMemoryType ( ) const

inlineinherited

Returns the type of memory (CPU and/or GPU).

Returns: Type of allocated memory.

◆ getPtr()

N* getPtr ( const MEM memory_type = MEM::CPU ) const

inherited

Returns the CPU or GPU data pointer.

Parameters

memory_type : Specifies whether you want sl::MEM::CPU or sl::MEM::GPU.

Returns: The pointer of the Mat data.

◆ getStepBytes()

size_t getStepBytes ( const MEM memory_type = MEM::CPU ) const

inherited

Returns the memory step in bytes (size of one pixel row).

Parameters

memory_type : Specifies whether you want sl::MEM::CPU or sl::MEM::GPU step.

Returns: The step in bytes of the specified memory.

◆ getStep() [1/2]

size_t getStep ( const MEM memory_type = MEM::CPU ) const

inlineinherited

Returns the memory step in number of elements (size in one pixel row).

Parameters

memory_type : Specifies whether you want sl::MEM::CPU or sl::MEM::GPU step.

Returns: The step in number of elements.

◆ getStep() [2/2]

size_t getStep ( MEM memory_type = MEM::CPU ) const

inlineinherited

Returns the memory step in number of elements (size in one pixel row).

Parameters

memory_type : Specifies whether you want sl::MEM::CPU or sl::MEM::GPU step.

Returns: The step in number of elements.

◆ getPixelBytes()

size_t getPixelBytes ( ) const

inlineinherited

Returns the size of one pixel in bytes.

Returns: Size of a pixel in bytes.

◆ getWidthBytes()

size_t getWidthBytes ( ) const

inlineinherited

Returns the size of a row in bytes.

Returns: Size of a row in bytes.

◆ getInfos()

String getInfos ( ) const

inherited

Returns the information about the sl::Mat into a sl::String.

Returns: String containing the sl::Mat information.

◆ isInit()

bool isInit ( ) const

inlineinherited

Returns whether the sl::Mat is initialized or not.

Returns: True if current sl::Mat has been allocated (by the constructor or therefore).

◆ isMemoryOwner()

bool isMemoryOwner ( ) const

inlineinherited

Returns whether the sl::Mat is the owner of the memory it accesses.

If not, the memory won't be freed if the sl::Mat is destroyed.

Returns: True if the sl::Mat is owning its memory, else false.

◆ clone()

ERROR_CODE clone ( const Mat & src )

inherited

Duplicates a sl::Mat by copy (deep copy).

Parameters

src	: Reference of the sl::Mat to copy.

This method copies the data array(s) and it marks the new sl::Mat as the memory owner.

◆ move()

ERROR_CODE move ( Mat & dst )

inherited

Moves the data of the sl::Mat to another sl::Mat.

This method gives the attribute of the current s::Mat to the specified one. (No copy.)

Parameters

dst	: Reference to the sl::Mat to move to.

Note: : The current sl::Mat is then no more usable since its loose its attributes.

◆ convertColor() [1/2]

ERROR_CODE convertColor	(	sl::MEM	memory = `sl::MEM::CPU`,
		cudaStream_t	stream = `0`,
		bool	swap_RB_channels = `true`
	)

inherited

Convert the color channels of the Mat (RGB<->BGR or RGBA<->BGRA) This methods works only on 8U_C4 or 8U_C3.

◆ convertColor() [2/2]

static ERROR_CODE convertColor	(	Mat &	mat1,
		Mat &	mat2,
		bool	swap_RB_channels,
		bool	remove_alpha_channels,
		sl::MEM	memory = `sl::MEM::CPU`,
		cudaStream_t	stream = `0`
	)

staticinherited

Convert the color channels of the Mat into another Mat This methods works only on 8U_C4 if remove_alpha_channels is enabled, or 8U_C4 and 8U_C3 if swap_RB_channels is enabled The inplace method sl::Mat::convertColor can be used for only swapping the Red and Blue channel efficiently.

◆ swap()

static void swap	(	Mat &	mat1,
		Mat &	mat2
	)

staticinherited

Swaps the content of the provided sl::Mat (only swaps the pointers, no data copy).

This method swaps the pointers of the given sl::Mat.

Parameters

mat1	: First matrix to swap.
mat2	: Second matrix to swap.

Variables

◆ size

Resolution size

protectedinherited

◆ channels

size_t channels = 0

protectedinherited

◆ step_gpu

size_t step_gpu = 0

protectedinherited

◆ step_cpu

size_t step_cpu = 0

protectedinherited

◆ pixel_bytes

size_t pixel_bytes = 0

protectedinherited

◆ data_type

MAT_TYPE data_type = MAT_TYPE::U8_C1

protectedinherited

◆ mem_type

MEM mem_type = MEM::CPU

protectedinherited

◆ ptr_cpu

std::shared_ptr<uchar1> ptr_cpu = NULL

protectedinherited

◆ ptr_gpu

std::shared_ptr<uchar1> ptr_gpu = NULL

protectedinherited

◆ init

bool init = false

protectedinherited

◆ memory_owner

bool memory_owner = false

protectedinherited

◆ name

String name

inherited

Variable used in verbose mode to indicate which sl::Mat is printing informations.

Default set to "n/a" to avoid empty string if not filled.

◆ verbose

bool verbose = false

inherited

Whether the sl::Mat can display informations.

◆ timestamp

Timestamp timestamp = 0

inherited

Timestamp of the last manipulation of the data of the matrix by a method/function.

Functions

Static Functions

Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor and Destructor

◆ Tensor() [1/2]

◆ Tensor() [2/2]

Functions

◆ alloc() [1/3]

◆ getDims()

◆ getElementCount()

◆ getParameters()

◆ ref()

◆ alloc() [2/3]

◆ alloc() [3/3]

◆ free()

◆ updateCPUfromGPU()

◆ updateGPUfromCPU()

◆ copyTo()

◆ setFrom()

◆ read()

◆ write()

◆ setTo()

◆ setValue()

◆ getValue()

◆ getWidth()

◆ getHeight()

◆ getResolution() [1/3]

◆ getResolution() [2/3]

◆ getResolution() [3/3]

◆ getChannels()

◆ getDataType()

◆ getMemoryType()

◆ getPtr()

◆ getStepBytes()

◆ getStep() [1/2]

◆ getStep() [2/2]

◆ getPixelBytes()

◆ getWidthBytes()

◆ getInfos()

◆ isInit()

◆ isMemoryOwner()

◆ clone()

◆ move()

◆ convertColor() [1/2]

◆ convertColor() [2/2]

◆ swap()

Variables

◆ size

◆ channels

◆ step_gpu

◆ step_cpu

◆ pixel_bytes

◆ data_type

◆ mem_type

◆ ptr_cpu

◆ ptr_gpu

◆ init

◆ memory_owner

◆ name

◆ verbose

◆ timestamp