Namespaces
	apriltag

	compressed_image

	details

	ground_surface

	image

	imu

	lidar

	lighting

	pps

	secondary_app

	system

Classes
class	Channel

class	HeaderBase

struct	RemoteHeadSyncGroup

Typedefs
typedef uint32_t	CameraProfile

typedef uint64_t	DataSource

typedef uint32_t	ImageCompressionCodec

typedef int16_t	RemoteHeadChannel

typedef int32_t	Status

typedef uint32_t	TriggerSource

typedef uint32_t	VersionType

Variables
static CRL_CONSTEXPR CameraProfile	AprilTag = (1U<<5)

static CRL_CONSTEXPR CameraProfile	Detail_Disparity = (1U<<0)

static CRL_CONSTEXPR float	Exposure_Default_Gain = 1.0f

static CRL_CONSTEXPR DataSource	Exposure_Default_Source = Source_Luma_Left

static CRL_CONSTEXPR float	Exposure_Default_Target_Intensity = 0.5f

static CRL_CONSTEXPR CameraProfile	Full_Res_Aux_Cam = (1U<<4)

static CRL_CONSTEXPR CameraProfile	Ground_Surface = (1U<<3)

static CRL_CONSTEXPR ImageCompressionCodec	H264 = 0

static CRL_CONSTEXPR CameraProfile	High_Contrast = (1U<<1)

static CRL_CONSTEXPR float	ImagerGainMax = 1000.0f

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_0 = 0

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_1 = 1

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_2 = 2

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_3 = 3

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_Invalid = SHRT_MAX

static CRL_CONSTEXPR RemoteHeadChannel	Remote_Head_VPB = -1

static CRL_CONSTEXPR int	Roi_Full_Image = 0

static CRL_CONSTEXPR CameraProfile	Show_ROIs = (1U<<2)

static CRL_CONSTEXPR DataSource	Source_All = 0xffffffffffffffff

static CRL_CONSTEXPR DataSource	Source_AprilTag_Detections = (1ull<<23)

static CRL_CONSTEXPR DataSource	Source_Chroma_Aux = (1ull<<30)

static CRL_CONSTEXPR DataSource	Source_Chroma_Left = (1ull<<6)

static CRL_CONSTEXPR DataSource	Source_Chroma_Rectified_Aux = (1ull<<8)

static CRL_CONSTEXPR DataSource	Source_Chroma_Right = (1ull<<7)

static CRL_CONSTEXPR DataSource	Source_Compressed_Aux = (1ull<<14)

static CRL_CONSTEXPR DataSource	Source_Compressed_Left = (1ull<<9)

static CRL_CONSTEXPR DataSource	Source_Compressed_Rectified_Aux = (1ull<<17)

static CRL_CONSTEXPR DataSource	Source_Compressed_Rectified_Left = (1ull<<15)

static CRL_CONSTEXPR DataSource	Source_Compressed_Rectified_Right = (1ull<<16)

static CRL_CONSTEXPR DataSource	Source_Compressed_Right = (1ull<<13)

static CRL_CONSTEXPR DataSource	Source_Disparity = (1ull<<10)

static CRL_CONSTEXPR DataSource	Source_Disparity_Aux = (1ull<<31)

static CRL_CONSTEXPR DataSource	Source_Disparity_Cost = (1ull<<12)

static CRL_CONSTEXPR DataSource	Source_Disparity_Left = (1ull<<10)

static CRL_CONSTEXPR DataSource	Source_Disparity_Right = (1ull<<11)

static CRL_CONSTEXPR DataSource	Source_Ground_Surface_Class_Image = (1ull<<22)

static CRL_CONSTEXPR DataSource	Source_Ground_Surface_Spline_Data = (1ull<<20)

static CRL_CONSTEXPR DataSource	Source_Imu = (1ull<<25)

static CRL_CONSTEXPR DataSource	Source_Jpeg_Left = (1ull<<16)

static CRL_CONSTEXPR DataSource	Source_Lidar_Scan = (1ull<<24)

static CRL_CONSTEXPR DataSource	Source_Luma_Aux = (1ull<<28)

static CRL_CONSTEXPR DataSource	Source_Luma_Left = (1ull<<2)

static CRL_CONSTEXPR DataSource	Source_Luma_Rectified_Aux = (1ull<<29)

static CRL_CONSTEXPR DataSource	Source_Luma_Rectified_Left = (1ull<<4)

static CRL_CONSTEXPR DataSource	Source_Luma_Rectified_Right = (1ull<<5)

static CRL_CONSTEXPR DataSource	Source_Luma_Right = (1ull<<3)

static CRL_CONSTEXPR DataSource	Source_Pps = (1ull<<26)

static CRL_CONSTEXPR DataSource	Source_Raw_Aux = (1ull<<27)

static CRL_CONSTEXPR DataSource	Source_Raw_Left = (1ull<<0)

static CRL_CONSTEXPR DataSource	Source_Raw_Right = (1ull<<1)

static CRL_CONSTEXPR DataSource	Source_Rgb_Left = (1ull<<17)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_0 = (1ull<<18)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_1 = (1ull<<19)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_2 = (1ull<<32)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_3 = (1ull<<33)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_4 = (1ull<<34)

static CRL_CONSTEXPR DataSource	Source_Secondary_App_Data_5 = (1ull<<35)

static CRL_CONSTEXPR DataSource	Source_Unknown = 0

static CRL_CONSTEXPR Status	Status_Error = -2

static CRL_CONSTEXPR Status	Status_Exception = -6

static CRL_CONSTEXPR Status	Status_Failed = -3

static CRL_CONSTEXPR Status	Status_Ok = 0

static CRL_CONSTEXPR Status	Status_TimedOut = -1

static CRL_CONSTEXPR Status	Status_Unknown = -5

static CRL_CONSTEXPR Status	Status_Unsupported = -4

static CRL_CONSTEXPR TriggerSource	Trigger_External = 1

static CRL_CONSTEXPR TriggerSource	Trigger_External_Inverted = 2

static CRL_CONSTEXPR TriggerSource	Trigger_Internal = 0

static CRL_CONSTEXPR TriggerSource	Trigger_PTP = 3

static CRL_CONSTEXPR CameraProfile	User_Control = 0

Typedef Documentation

◆ CameraProfile

typedef uint32_t crl::multisense::CameraProfile

Camera profile typedef representing the various stereo profiles available from newer S27/S30 MultiSense variants. Camera profiles are used to augment and extend the standard set of user accessible camera controls. Multiple camera profiles can be requested at once using the bitwise OR operator.

Definition at line 173 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ DataSource

typedef uint64_t crl::multisense::DataSource

Data sources typedef representing the various data sources available from sensors in the MultiSense-S line. Variables of this type are used to query which data sources are supported by a given sensor, and to control the streaming of those datasources from the sensor. DataSource values can be combined using the bitwise OR operator to represent multiple sources.

Definition at line 115 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ ImageCompressionCodec

typedef uint32_t crl::multisense::ImageCompressionCodec

Image compression codec typedef indicating the compression scheme which was used on the compressed output streams. Compression is only supported on newer S27/S30 MultiSense variants.

Definition at line 195 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ RemoteHeadChannel

typedef int16_t crl::multisense::RemoteHeadChannel

Remote head channel defines which channel is used to communicate to a specific component in the Remote Head system. The possible components are: Remote_Head_VPB The Remote Head Vision Processor Board. Remote_Head_0 The Remote Head Camera located in position 0 Remote_Head_1 The Remote Head Camera located in position 1 Remote_Head_2 The Remote Head Camera located in position 2 Remote_Head_3 The Remote Head Camera located in position 3

Definition at line 210 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Status

typedef int32_t crl::multisense::Status

General status typedef used as a return value for get/set crl::multisense::Channel methods

Definition at line 94 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ TriggerSource

typedef uint32_t crl::multisense::TriggerSource

Definition at line 272 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ VersionType

typedef uint32_t crl::multisense::VersionType

Sensor version typedef used to store a given version number

Definition at line 88 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

Variable Documentation

◆ AprilTag

CRL_CONSTEXPR CameraProfile crl::multisense::AprilTag = (1U<<5)

static

User would like to run apriltag detector on the camera

Definition at line 189 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Detail_Disparity

CRL_CONSTEXPR CameraProfile crl::multisense::Detail_Disparity = (1U<<0)

static

User would like more detail in the disparity image

Definition at line 178 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Exposure_Default_Gain

CRL_CONSTEXPR float crl::multisense::Exposure_Default_Gain = 1.0f

static

Definition at line 165 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Exposure_Default_Source

CRL_CONSTEXPR DataSource crl::multisense::Exposure_Default_Source = Source_Luma_Left

static

Definition at line 163 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Exposure_Default_Target_Intensity

CRL_CONSTEXPR float crl::multisense::Exposure_Default_Target_Intensity = 0.5f

static

Definition at line 164 of file Legacy/include/MultiSense/MultiSenseTypes.hh.

◆ Full_Res_Aux_Cam

CRL_CONSTEXPR CameraProfile crl::multisense::Full_Res_Aux_Cam = (1U<<4)

static

User would like full resolution images from the aux camera regardless of the requested resolution of the stereo pair. Warning: This profile will be deprecated in future revisions of the software.

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