LibMultiSense
LibMultiSense Documentation
crl::multisense::compressed_image::Header Class Reference

#include <MultiSenseTypes.hh>

Inheritance diagram for crl::multisense::compressed_image::Header:
Collaboration diagram for crl::multisense::compressed_image::Header:

Public Member Functions

 Header ()
 Default Constructor. More...
 
virtual bool inMask (DataSource mask)
 Member function used to determine if the data contained in the header is contained in a specific image mask. More...
 
- Public Member Functions inherited from crl::multisense::HeaderBase
virtual ~HeaderBase ()
 

Public Attributes

DataSource source
 DataSource corresponding to imageDataP. More...
 
uint32_t bitsPerPixel
 Bits per pixel in the image. More...
 
ImageCompressionCodec codec
 Compression codec. More...
 
uint32_t width
 Width of the image. More...
 
uint32_t height
 Height of the image. More...
 
int64_t frameId
 Unique ID used to describe an image. More...
 
uint32_t timeSeconds
 The time seconds value corresponding to when the image was captured. More...
 
uint32_t timeMicroSeconds
 The time microseconds value corresponding to when the image was captured. More...
 
uint32_t exposure
 The image exposure time in microseconds. More...
 
float gain
 The imager gain the image was captured with. More...
 
float framesPerSecond
 The number of frames per second currently streaming from the device. More...
 
uint32_t imageLength
 The length of the image data stored in imageDataP. More...
 
const void * imageDataP
 A pointer to the compressed image data. More...
 
uint32_t headId
 The active remote head if any. More...
 

Detailed Description

Definition at line 2443 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ Header()

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

Default Constructor.

Definition at line 2478 of file 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 2485 of file MultiSenseTypes.hh.

Member Data Documentation

◆ bitsPerPixel

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

Bits per pixel in the image.

Definition at line 2449 of file MultiSenseTypes.hh.

◆ codec

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

Compression codec.

Definition at line 2451 of file MultiSenseTypes.hh.

◆ exposure

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

The image exposure time in microseconds.

Definition at line 2464 of file MultiSenseTypes.hh.

◆ frameId

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

Unique ID used to describe an image.

FrameIds increase sequentally from the device

Definition at line 2457 of file MultiSenseTypes.hh.

◆ framesPerSecond

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

The number of frames per second currently streaming from the device.

Definition at line 2468 of file MultiSenseTypes.hh.

◆ gain

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

The imager gain the image was captured with.

Definition at line 2466 of file MultiSenseTypes.hh.

◆ headId

uint32_t crl::multisense::compressed_image::Header::headId

The active remote head if any.

Definition at line 2474 of file MultiSenseTypes.hh.

◆ height

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

Height of the image.

Definition at line 2455 of file MultiSenseTypes.hh.

◆ imageDataP

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

A pointer to the compressed image data.

Definition at line 2472 of file MultiSenseTypes.hh.

◆ imageLength

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

The length of the image data stored in imageDataP.

Definition at line 2470 of file MultiSenseTypes.hh.

◆ source

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

DataSource corresponding to imageDataP.

Definition at line 2447 of file 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 2461 of file 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 2459 of file MultiSenseTypes.hh.

◆ width

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

Width of the image.

Definition at line 2453 of file MultiSenseTypes.hh.


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