The csf camera class contains all the logic to generate a stream of depth data from a csf file. More...

#include <csf_camera.hpp>

Inheritance diagram for chronoptics::tof::CsfCamera:

Public Member Functions
	CsfCamera (tof_csf_camera_t ptr=nullptr)
	Construct from pointer.
	CsfCamera (StringView file_location, const ProcessingConfig &processing_config)
	Construct a csf camera from a csf file.
	CsfCamera (StringView file_location)
	Construct a csf camera from a csf file with a processing config generated by default_processing from the camera config.
std::vector< Data >	get_frames_at (size_t frame_nr)
	Get frames at the specified position.
size_t	get_current_frame () const
	Get the location (count) of the current frame.
size_t	get_frame_number () const
	Get the amount of frame lists this csf file can open/generate.
size_t	get_fps () const
	Get the FPS If the FPS is greater than 0 the time between subsequent function calls to get_frames or get_frames_at will be limited to the FPS This is done by sleeping on the next call to get_frames() if the time between calls is smaller than the time duration dictated by the fps.
void	set_fps (size_t fps)
	Set the FPS If the FPS is greater than 0 the time between subsequent function calls to get_frames or get_frames_at will be limited to the FPS This is done by sleeping on the next call to get_frames() if the time between calls is smaller than the time duration dictated by the fps.
void	set_process_config (const ProcessingConfig &config)
	the processing config of the camera
Public Member Functions inherited from chronoptics::tof::Camera
	Camera (tof_camera_t ptr=nullptr)
	Construct from pointer.
void	start ()
	Start streaming of the camera.
void	stop ()
	Stop streaming of the camera.
bool	is_streaming () const
	Check whether the camera is streaming.
bool	is_connected () const
	Check whether the camera is still connected.
std::vector< Stream >	get_stream_list () const
	Get the different output streams the camera can provide.
ProcessingConfig	get_process_config () const
	the processing config of the camera
bool	has_frames () const
	Check if the camera has frames available.
std::vector< Data >	get_frames ()
	Get data frames from camera.
void	clear_buffer ()
	Clear the circular buffer used to store frames.
size_t	get_buffer_size () const
	Get the circular buffer size.
void	set_buffer_size (size_t size)
	Set the circular buffer size.
CameraConfig	get_camera_config () const
	Get the currently active camera config.
const char *	get_serial () const
	Get the serial number of the current camera.
Calibration	get_calibration () const
	Get calibration from the camera.
size_t	get_user_pointer_capacity () const
	Get the amount of user pointers that can be stored.
void	set_user_pointer_capacity (size_t capacity)
	Set the amount of user pointers that can be stored.
void	add_user_pointer (uint8_t *pointer, size_t capacity, user_pointer_destructed_fn &callback, FrameType frame_type)
	Add a pointer that will be filled with the specified data type.
void	add_user_pointer (uint8_t pointer, size_t capacity, tof_user_pointer_destructed_t callback, void callback_user_data, FrameType frame_type)
	Add a pointer that will be filled with the specified data type.
void	clear_user_pointers ()
	Clear all user pointers in memory.
uint32_t	config_index () const
	Get the currently set configuration index.
void	switch_config (uint32_t config_index)
	Switch to a different config in real time, depending on configuration and camera, this can take 100-300ms.
std::vector< FrameType >	possible_frame_types () const
	Get the frame types that this camera can output.
bool	output_frame_types_set ()
	Whether output frame types have been set.
std::vector< FrameType >	get_output_frame_types () const
	Get the frame types the camera should output.
void	set_output_frame_types (const std::vector< FrameType > &output_frame_types)
	Set the frame types the camera should output.
bool	has_multiple_configurations () const
	Check if multiple configurations are set.
std::vector< CameraConfig >	get_multiple_camera_configurations () const
	Get all the set camera configurations.
std::vector< ProcessingConfig >	get_multiple_processing_configurations () const
	Get all the set processing configurations.
std::vector< const char * >	get_multiple_names () const
	Get the name for each configuration.
std::vector< const char * >	get_multiple_descriptions () const
	Get the description for each configuration.

Detailed Description

The csf camera class contains all the logic to generate a stream of depth data from a csf file.

Definition at line 16 of file csf_camera.hpp.

Constructor & Destructor Documentation

◆ CsfCamera() [1/3]

chronoptics::tof::CsfCamera::CsfCamera ( tof_csf_camera_t ptr = nullptr )

inline

Construct from pointer.

Definition at line 19 of file csf_camera.hpp.

References chronoptics::tof::Camera::Camera().

Referenced by CsfCamera(), and CsfCamera().

◆ CsfCamera() [2/3]

chronoptics::tof::CsfCamera::CsfCamera	(	StringView	file_location,
		const ProcessingConfig &	processing_config )

inline

Construct a csf camera from a csf file.

Parameters

file_location	File location of the csf file
processing_config	A processing config

Definition at line 25 of file csf_camera.hpp.

References CsfCamera().

◆ CsfCamera() [3/3]

chronoptics::tof::CsfCamera::CsfCamera ( StringView file_location )

inline

Construct a csf camera from a csf file with a processing config generated by default_processing from the camera config.

Parameters

file_location File location of the csf file

Definition at line 31 of file csf_camera.hpp.

References CsfCamera().

Member Function Documentation

◆ get_current_frame()

size_t chronoptics::tof::CsfCamera::get_current_frame ( ) const

inline

Get the location (count) of the current frame.

Returns: The currenc frame location

Definition at line 52 of file csf_camera.hpp.

◆ get_fps()

size_t chronoptics::tof::CsfCamera::get_fps ( ) const

inline

Get the FPS If the FPS is greater than 0 the time between subsequent function calls to get_frames or get_frames_at will be limited to the FPS This is done by sleeping on the next call to get_frames() if the time between calls is smaller than the time duration dictated by the fps.

Returns: The frames per second

Definition at line 72 of file csf_camera.hpp.

◆ get_frame_number()

size_t chronoptics::tof::CsfCamera::get_frame_number ( ) const

inline

Get the amount of frame lists this csf file can open/generate.

Returns: The number of frames in the csf file

Definition at line 60 of file csf_camera.hpp.

◆ get_frames_at()

std::vector< Data > chronoptics::tof::CsfCamera::get_frames_at ( size_t frame_nr )

inline

Get frames at the specified position.

Parameters

frame_nr Which set of frames to process

Returns: Data frames

Definition at line 37 of file csf_camera.hpp.

◆ set_fps()

void chronoptics::tof::CsfCamera::set_fps ( size_t fps )

inline

Set the FPS If the FPS is greater than 0 the time between subsequent function calls to get_frames or get_frames_at will be limited to the FPS This is done by sleeping on the next call to get_frames() if the time between calls is smaller than the time duration dictated by the fps.

Parameters

fps	The frames per second

Definition at line 84 of file csf_camera.hpp.

◆ set_process_config()

void chronoptics::tof::CsfCamera::set_process_config ( const ProcessingConfig & config )

inline

the processing config of the camera

Parameters

config The processing config

Definition at line 92 of file csf_camera.hpp.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CsfCamera() [1/3]

◆ CsfCamera() [2/3]

◆ CsfCamera() [3/3]

Member Function Documentation

◆ get_current_frame()

◆ get_fps()

◆ get_frame_number()

◆ get_frames_at()

◆ set_fps()

◆ set_process_config()