This class reads csf files.
More...
#include <csf_reader.hpp>
This class reads csf files.
Definition at line 16 of file csf_reader.hpp.
◆ CsfReader()
chronoptics::tof::CsfReader::CsfReader |
( |
StringView |
file_location | ) |
|
|
inline |
Open a csf file for reading.
- Parameters
-
file_location | File location of the csf file |
Definition at line 26 of file csf_reader.hpp.
◆ 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_camera_config()
CameraConfig chronoptics::tof::CsfReader::get_camera_config |
( |
| ) |
const |
|
inline |
◆ 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
-
index | Which 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
-
index | The 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
-
stream | The stream |
index | The 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
-
pointer | The pointer to the data to write into |
capacity | The amount of data the pointer can hold |
callback | Callback that will be called when pointer is no longer in use |
callback_user_data | User 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
-
pointer | The pointer to the data to write into |
capacity | The amount of data the pointer can hold |
callback | Callback 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
-
- 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.