Time-of-Flight Library(ToF) 3.13.3
 
chronoptics::tof::CsfReader Class Reference

DEPRECATED, use CSFCamera. More...

#include <csf_reader.hpp>

+ Inheritance diagram for chronoptics::tof::CsfReader:

Public Member Functions

 CsfReader (tof_csf_reader_t ptr=nullptr)
 Construct from pointer.
 
 CsfReader (StringView file_location)
 Open a csf file for reading.
 
Data read_frame ()
 Read the next data frame from disk.
 
Data read_frame_into_pointer (uint8_t *pointer, size_t capacity, user_pointer_destructed_fn &callback)
 Read the next data frame from disk into the supplied pointer.
 
Data read_frame_into_pointer (uint8_t *pointer, size_t capacity, tof_user_pointer_destructed_t callback, void *callback_user_data)
 Read the next data frame from disk into the supplied pointer.
 
size_t number_of_frames () const
 Get the total number of frames in the csf file.
 
Data get_header (size_t index) const
 Returns an empty Data class containing the header information for the specified frame.
 
Stream next_stream () const
 Get the stream information of the next frame.
 
size_t next_frame_size () const
 Get the size of the next frame.
 
size_t frame_index () const
 Get the current frame position.
 
void go_to_frame (size_t index)
 Go to specified frame.
 
std::vector< Streamstreams () const
 Get the streams that are in the csf file.
 
size_t stream_count (Stream &stream) const
 Get the number of frames contained in the file of the given stream.
 
void go_to_stream (Stream &stream, size_t index)
 Go to the specified stream, the next read frame call will start from here.
 
Calibration get_calibration () const
 Get calibration from the csf file.
 
CameraConfig get_camera_config () const
 Get camera config from the csf file.
 

Detailed Description

DEPRECATED, use CSFCamera.

This class reads csf files

Definition at line 16 of file csf_reader.hpp.

Constructor & Destructor Documentation

◆ CsfReader() [1/2]

chronoptics::tof::CsfReader::CsfReader ( tof_csf_reader_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 19 of file csf_reader.hpp.

◆ CsfReader() [2/2]

chronoptics::tof::CsfReader::CsfReader ( StringView  file_location)
inline

Open a csf file for reading.

Parameters
file_locationFile location of the csf file

Definition at line 26 of file csf_reader.hpp.

Member Function Documentation

◆ frame_index()

size_t chronoptics::tof::CsfReader::frame_index ( ) const
inline

Get the current frame position.

Returns
Frame index

Definition at line 108 of file csf_reader.hpp.

◆ get_calibration()

Calibration chronoptics::tof::CsfReader::get_calibration ( ) const
inline

Get calibration from the csf file.

Returns
Calibration

Definition at line 152 of file csf_reader.hpp.

◆ get_camera_config()

CameraConfig chronoptics::tof::CsfReader::get_camera_config ( ) const
inline

Get camera config from the csf file.

Returns
Camera config

Definition at line 162 of file csf_reader.hpp.

◆ get_header()

Data chronoptics::tof::CsfReader::get_header ( size_t  index) const
inline

Returns an empty Data class containing the header information for the specified frame.

Parameters
indexWhich frame to get the header from
Returns
Empty Data instance containing header information

Definition at line 81 of file csf_reader.hpp.

◆ go_to_frame()

void chronoptics::tof::CsfReader::go_to_frame ( size_t  index)
inline

Go to specified frame.

Parameters
indexThe index of the frame to jump to

Definition at line 115 of file csf_reader.hpp.

◆ go_to_stream()

void chronoptics::tof::CsfReader::go_to_stream ( Stream stream,
size_t  index 
)
inline

Go to the specified stream, the next read frame call will start from here.

Parameters
streamThe stream
indexThe frame index

Definition at line 145 of file csf_reader.hpp.

◆ next_frame_size()

size_t chronoptics::tof::CsfReader::next_frame_size ( ) const
inline

Get the size of the next frame.

Returns
Size of the next frame

Definition at line 101 of file csf_reader.hpp.

◆ next_stream()

Stream chronoptics::tof::CsfReader::next_stream ( ) const
inline

Get the stream information of the next frame.

Returns
Information on the next frame

Definition at line 91 of file csf_reader.hpp.

◆ number_of_frames()

size_t chronoptics::tof::CsfReader::number_of_frames ( ) const
inline

Get the total number of frames in the csf file.

Returns
Total number of frames in the csf file

Definition at line 72 of file csf_reader.hpp.

◆ read_frame()

Data chronoptics::tof::CsfReader::read_frame ( )
inline

Read the next data frame from disk.

Returns
A data frame

Definition at line 33 of file csf_reader.hpp.

◆ read_frame_into_pointer() [1/2]

Data chronoptics::tof::CsfReader::read_frame_into_pointer ( uint8_t *  pointer,
size_t  capacity,
tof_user_pointer_destructed_t  callback,
void *  callback_user_data 
)
inline

Read the next data frame from disk into the supplied pointer.

Parameters
pointerThe pointer to the data to write into
capacityThe amount of data the pointer can hold
callbackCallback that will be called when pointer is no longer in use
callback_user_dataUser data that will be passed back when the function pointer is called
Returns
A data frame

Definition at line 62 of file csf_reader.hpp.

◆ read_frame_into_pointer() [2/2]

Data chronoptics::tof::CsfReader::read_frame_into_pointer ( uint8_t *  pointer,
size_t  capacity,
user_pointer_destructed_fn &  callback 
)
inline

Read the next data frame from disk into the supplied pointer.

Parameters
pointerThe pointer to the data to write into
capacityThe amount of data the pointer can hold
callbackCallback that will be called when pointer is no longer in use
Returns
A data frame

Definition at line 47 of file csf_reader.hpp.

◆ stream_count()

size_t chronoptics::tof::CsfReader::stream_count ( Stream stream) const
inline

Get the number of frames contained in the file of the given stream.

Parameters
streamThe stream
Returns
Number of frames for given stream

Definition at line 137 of file csf_reader.hpp.

◆ streams()

std::vector< Stream > chronoptics::tof::CsfReader::streams ( ) const
inline

Get the streams that are in the csf file.

Returns
Streams in the csf file

Definition at line 122 of file csf_reader.hpp.