multisense::ImageFrame Struct Reference

A frame containing multiple images (indexed by DataSource). More...

#include <MultiSenseTypes.hh>

Collaboration diagram for multisense::ImageFrame:

Public Member Functions
void	add_image (const Image &image)
	Add an image to the frame, keyed by the image's DataSource. More...
const Image &	get_image (const DataSource &source) const
	Retrieve image by DataSource. More...
bool	has_image (const DataSource &source) const
	Check if we have an image for a given data source. More...

Public Attributes
int64_t	frame_id = 0
	The unique monotonically increasing ID for each frame populated by the MultiSense. More...
std::map< DataSource, Image >	images
	The images assocated with each source in the frame. More...
StereoCalibration	calibration
	The scaled calibration for the entire camera. More...
TimeT	frame_time {}
	The MultiSense timestamp associated with the frame. More...
TimeT	ptp_frame_time {}
	The MultiSense ptp timestamp associated with the frame. More...
ColorImageEncoding	aux_color_encoding = ColorImageEncoding::NONE
	The encoding of the aux color image(s) in the frame. More...

Detailed Description

A frame containing multiple images (indexed by DataSource).

Definition at line 300 of file MultiSenseTypes.hh.

Member Function Documentation

add_image()

void multisense::ImageFrame::add_image ( const Image &  image )

inline

Add an image to the frame, keyed by the image's DataSource.

Definition at line 305 of file MultiSenseTypes.hh.

get_image()

const Image& multisense::ImageFrame::get_image ( const DataSource &  source ) const

inline

Retrieve image by DataSource.

Throws if not found.

Definition at line 313 of file MultiSenseTypes.hh.

has_image()

bool multisense::ImageFrame::has_image ( const DataSource &  source ) const

inline

Check if we have an image for a given data source.

Definition at line 326 of file MultiSenseTypes.hh.

Member Data Documentation

aux_color_encoding

ColorImageEncoding multisense::ImageFrame::aux_color_encoding = ColorImageEncoding::NONE

The encoding of the aux color image(s) in the frame.

Definition at line 359 of file MultiSenseTypes.hh.

calibration

StereoCalibration multisense::ImageFrame::calibration

The scaled calibration for the entire camera.

Definition at line 344 of file MultiSenseTypes.hh.

frame_id

int64_t multisense::ImageFrame::frame_id = 0

The unique monotonically increasing ID for each frame populated by the MultiSense.

Definition at line 334 of file MultiSenseTypes.hh.

frame_time

TimeT multisense::ImageFrame::frame_time {}

The MultiSense timestamp associated with the frame.

Definition at line 349 of file MultiSenseTypes.hh.

images

std::map<DataSource, Image> multisense::ImageFrame::images

The images assocated with each source in the frame.

Definition at line 339 of file MultiSenseTypes.hh.

ptp_frame_time

TimeT multisense::ImageFrame::ptp_frame_time {}

The MultiSense ptp timestamp associated with the frame.

Definition at line 354 of file MultiSenseTypes.hh.

---

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

• /home/malvarado/crl/LibMultiSense/source/LibMultiSense/include/MultiSense/MultiSenseTypes.hh