Public Member Functions | Public Attributes | List of all members
crl::multisense::compressed_image::Header Class Reference

#include <MultiSenseTypes.hh>

Inheritance diagram for crl::multisense::compressed_image::Header:
Inheritance graph
[legend]

Public Member Functions

 Header ()
 
virtual bool inMask (DataSource mask)
 
- Public Member Functions inherited from crl::multisense::HeaderBase
virtual ~HeaderBase ()
 

Public Attributes

uint32_t bitsPerPixel
 
ImageCompressionCodec codec
 
uint32_t exposure
 
int64_t frameId
 
float framesPerSecond
 
float gain
 
uint32_t height
 
const void * imageDataP
 
uint32_t imageLength
 
DataSource source
 
uint32_t timeMicroSeconds
 
uint32_t timeSeconds
 
uint32_t width
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Header()

crl::multisense::compressed_image::Header::Header ( )
inline

Default Constructor

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

Member Function Documentation

◆ inMask()

virtual bool crl::multisense::compressed_image::Header::inMask ( DataSource  mask)
inlinevirtual

Member function used to determine if the data contained in the header is contained in a specific image mask

Reimplemented from crl::multisense::HeaderBase.

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

Member Data Documentation

◆ bitsPerPixel

uint32_t crl::multisense::compressed_image::Header::bitsPerPixel

Bits per pixel in the image

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

◆ codec

ImageCompressionCodec crl::multisense::compressed_image::Header::codec

Compression codec

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

◆ exposure

uint32_t crl::multisense::compressed_image::Header::exposure

The image exposure time in microseconds

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

◆ frameId

int64_t crl::multisense::compressed_image::Header::frameId

Unique ID used to describe an image. FrameIds increase sequentially from the device

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

◆ framesPerSecond

float crl::multisense::compressed_image::Header::framesPerSecond

The number of frames per second currently streaming from the device

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

◆ gain

float crl::multisense::compressed_image::Header::gain

The imager gain the image was captured with

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

◆ height

uint32_t crl::multisense::compressed_image::Header::height

Height of the image

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

◆ imageDataP

const void* crl::multisense::compressed_image::Header::imageDataP

A pointer to the compressed image data

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

◆ imageLength

uint32_t crl::multisense::compressed_image::Header::imageLength

The length of the image data stored in imageDataP

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

◆ source

DataSource crl::multisense::compressed_image::Header::source

DataSource corresponding to imageDataP

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

◆ timeMicroSeconds

uint32_t crl::multisense::compressed_image::Header::timeMicroSeconds

The time microseconds value corresponding to when the image was captured

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

◆ timeSeconds

uint32_t crl::multisense::compressed_image::Header::timeSeconds

The time seconds value corresponding to when the image was captured

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

◆ width

uint32_t crl::multisense::compressed_image::Header::width

Width of the image

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


The documentation for this class was generated from the following file:


multisense_lib
Author(s):
autogenerated on Thu Apr 17 2025 02:49:09