Represents a single image plus metadata. More...

#include <MultiSenseTypes.hh>

Public Types
enum	PixelFormat : uint8_t { PixelFormat::UNKNOWN, PixelFormat::MONO8, PixelFormat::BGR8, PixelFormat::MONO16, PixelFormat::FLOAT32, PixelFormat::JPEG, PixelFormat::H264 }
	Pixel formats. More...

Public Member Functions
template<typename T >
std::optional< T >	at (int w, int h) const
	Get a pixel at a certain width/height location in the image. NOTE: This check is slower since it checks to make sure the request is safe. It should not be called repeatedly at high frequency. More...

Public Attributes
CameraCalibration	calibration {}
	The scaled calibration associated with the image. More...

TimeT	camera_timestamp {}
	The timestamp associated with the image based on the camera's clock. Starts at 0 on boot. More...

PixelFormat	format = PixelFormat::UNKNOWN
	The format of the image data stored in the raw_data stored in the raw_data buffer. More...

int	height = -1
	Height of the image in pixels. More...

size_t	image_data_length = 0
	The length of the image data after the image_data_offset has been applied. More...

int64_t	image_data_offset = 0
	An offset into the raw_data pointer where the image data starts. More...

TimeT	ptp_timestamp {}
	The timestamp associated with the image based using the camera's clock which is potentially PTP synchronized with a remote PTP master. More...

std::shared_ptr< const std::vector< uint8_t > >	raw_data = nullptr
	A pointer to the raw image data sent from the camera. More...

DataSource	source = DataSource::UNKNOWN
	The camera data source which this image corresponds to. More...

int	width = -1
	Width of the image in pixels. More...

Detailed Description

Represents a single image plus metadata.

Definition at line 187 of file LibMultiSense/include/MultiSense/MultiSenseTypes.hh.

Member Enumeration Documentation

◆ PixelFormat

enum multisense::Image::PixelFormat : uint8_t

strong

Pixel formats.

Enumerator
UNKNOWN
MONO8
BGR8
MONO16
FLOAT32
JPEG
H264

Definition at line 192 of file LibMultiSense/include/MultiSense/MultiSenseTypes.hh.

Member Function Documentation

◆ at()

template<typename T >

std::optional<T> multisense::Image::at	(	int	w,
		int	h
	)		const

inline

Get a pixel at a certain width/height location in the image. NOTE: This check is slower since it checks to make sure the request is safe. It should not be called repeatedly at high frequency.

Definition at line 261 of file LibMultiSense/include/MultiSense/MultiSenseTypes.hh.