Time-of-Flight Library(ToF)  3.2.2
chronoptics::tof::MixedPixelLut Class Reference

Access the mixed pixel lookup table files. More...

#include <mixed_pixel_lut.hpp>

+ Inheritance diagram for chronoptics::tof::MixedPixelLut:

Public Member Functions

 MixedPixelLut (tof_mixed_pixel_lut_t ptr)
 Construct from pointer.
 
 MixedPixelLut ()
 Construct and empty lut file.
 
 MixedPixelLut (StringView file_location)
 Read a lut file. More...
 
void write (StringView file_location)
 Write the lut to disk. More...
 
std::vector< float > get_fmods () const
 Get the modulation frequencies. More...
 
void set_fmods (const std::vector< float > &fmods)
 Set the modulation frequencies. More...
 
MpLutCompression get_func () const
 Get the compression function. More...
 
void set_func (MpLutCompression func)
 Set the compression function. More...
 
std::vector< float > get_kai_phi () const
 Get the indexes of the LUT in the phase dimension. More...
 
void set_kai_phi (const std::vector< float > &kai_phi)
 Set the indexes of the LUT in the phase dimension. More...
 
std::vector< float > get_kai_amp () const
 Get the indexes of the LUT in the amplitude dimension. More...
 
void set_kai_amp (const std::vector< float > &kai_amp)
 Set the indexes of the LUT in the amplitude dimension. More...
 
Matrix get_zlut () const
 Get the lookup table in a single matrix. More...
 
void set_zlut (Matrix &zlut)
 Set the lookup table in a single matrix. More...
 
int16_t get_amult () const
 Get what to multiply by after characterization. More...
 
void set_amult (int16_t amult)
 Set what to multiply by after characterization. More...
 
int16_t get_ax () const
 Get the value multiplied by zlut amplitude values. More...
 
void set_ax (int16_t ax)
 Set the value multiplied by zlut amplitude values. More...
 
int16_t get_pi_value () const
 Get the fixed value of pi used. More...
 
void set_pi_value (int16_t pi_value)
 Set the fixed value of pi used. More...
 
bool has_pi_value ()
 Check if a pi value has been set. More...
 

Detailed Description

Access the mixed pixel lookup table files.

Definition at line 26 of file mixed_pixel_lut.hpp.

Constructor & Destructor Documentation

◆ MixedPixelLut()

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

Read a lut file.

Parameters
file_locationLocation of the lut file

Definition at line 42 of file mixed_pixel_lut.hpp.

Member Function Documentation

◆ get_amult()

int16_t chronoptics::tof::MixedPixelLut::get_amult ( ) const
inline

Get what to multiply by after characterization.

Returns
Amplitude multiplier

Definition at line 138 of file mixed_pixel_lut.hpp.

◆ get_ax()

int16_t chronoptics::tof::MixedPixelLut::get_ax ( ) const
inline

Get the value multiplied by zlut amplitude values.

Returns
Amplitude multiplier

Definition at line 152 of file mixed_pixel_lut.hpp.

◆ get_fmods()

std::vector<float> chronoptics::tof::MixedPixelLut::get_fmods ( ) const
inline

Get the modulation frequencies.

Returns
Modulation frequencies

Definition at line 56 of file mixed_pixel_lut.hpp.

◆ get_func()

MpLutCompression chronoptics::tof::MixedPixelLut::get_func ( ) const
inline

Get the compression function.

Returns
The compression function

Definition at line 73 of file mixed_pixel_lut.hpp.

◆ get_kai_amp()

std::vector<float> chronoptics::tof::MixedPixelLut::get_kai_amp ( ) const
inline

Get the indexes of the LUT in the amplitude dimension.

Returns
Indexes in amplitude dimension

Definition at line 104 of file mixed_pixel_lut.hpp.

◆ get_kai_phi()

std::vector<float> chronoptics::tof::MixedPixelLut::get_kai_phi ( ) const
inline

Get the indexes of the LUT in the phase dimension.

Returns
Indexes in phase dimension

Definition at line 87 of file mixed_pixel_lut.hpp.

◆ get_pi_value()

int16_t chronoptics::tof::MixedPixelLut::get_pi_value ( ) const
inline

Get the fixed value of pi used.

Returns
Pi value, this value can be undefined

Definition at line 166 of file mixed_pixel_lut.hpp.

◆ get_zlut()

Matrix chronoptics::tof::MixedPixelLut::get_zlut ( ) const
inline

Get the lookup table in a single matrix.

Returns
Matrix

Definition at line 121 of file mixed_pixel_lut.hpp.

◆ has_pi_value()

bool chronoptics::tof::MixedPixelLut::has_pi_value ( )
inline

Check if a pi value has been set.

Returns
Pi value has been set

Definition at line 180 of file mixed_pixel_lut.hpp.

◆ set_amult()

void chronoptics::tof::MixedPixelLut::set_amult ( int16_t  amult)
inline

Set what to multiply by after characterization.

Parameters
amultAmplitude multiplier

Definition at line 145 of file mixed_pixel_lut.hpp.

◆ set_ax()

void chronoptics::tof::MixedPixelLut::set_ax ( int16_t  ax)
inline

Set the value multiplied by zlut amplitude values.

Parameters
axAmplitude multiplier

Definition at line 159 of file mixed_pixel_lut.hpp.

◆ set_fmods()

void chronoptics::tof::MixedPixelLut::set_fmods ( const std::vector< float > &  fmods)
inline

Set the modulation frequencies.

Parameters
fmodsModulation frequencies

Definition at line 66 of file mixed_pixel_lut.hpp.

◆ set_func()

void chronoptics::tof::MixedPixelLut::set_func ( MpLutCompression  func)
inline

Set the compression function.

Parameters
funcThe compression function

Definition at line 80 of file mixed_pixel_lut.hpp.

◆ set_kai_amp()

void chronoptics::tof::MixedPixelLut::set_kai_amp ( const std::vector< float > &  kai_amp)
inline

Set the indexes of the LUT in the amplitude dimension.

Parameters
kai_ampIndexes in amplitude dimension

Definition at line 114 of file mixed_pixel_lut.hpp.

◆ set_kai_phi()

void chronoptics::tof::MixedPixelLut::set_kai_phi ( const std::vector< float > &  kai_phi)
inline

Set the indexes of the LUT in the phase dimension.

Parameters
kai_phiIndexes in phase dimension

Definition at line 97 of file mixed_pixel_lut.hpp.

◆ set_pi_value()

void chronoptics::tof::MixedPixelLut::set_pi_value ( int16_t  pi_value)
inline

Set the fixed value of pi used.

Parameters
pi_valuePi value, this value can be undefined

Definition at line 173 of file mixed_pixel_lut.hpp.

◆ set_zlut()

void chronoptics::tof::MixedPixelLut::set_zlut ( Matrix zlut)
inline

Set the lookup table in a single matrix.

Parameters
zlutMatrix

Definition at line 131 of file mixed_pixel_lut.hpp.

◆ write()

void chronoptics::tof::MixedPixelLut::write ( StringView  file_location)
inline

Write the lut to disk.

Parameters
file_locationLocation of where to write the lut file

Definition at line 49 of file mixed_pixel_lut.hpp.