Processing that can be done. More...

#include <processing_config.hpp>

Inheritance diagram for chronoptics::tof::ProcessingConfig:

Public Member Functions
	ProcessingConfig (tof_processing_config_t ptr)
	Construct from pointer.

	ProcessingConfig ()
	Create default processing config.

	ProcessingConfig (StringView file_location)
	Load processing config from disk.

void	write (StringView file_location) const
	Write processing config to disk.

bool	get_gpu () const
	Get whether processing on the gpu is enabled.

void	set_gpu (bool gpu)
	Set whether processing on the gpu is enabled.

bool	get_calibration_enabled () const
	Get whether the calibration is applied.

void	set_calibration_enabled (bool enabled)
	Set whether the calibration is applied.

bool	get_phase_unwrapping_enabled () const
	Get whether phase unwrapping is enabled.

void	set_phase_unwrapping_enabled (bool enabled)
	Set whether phase unwrapping is enabled.

double	get_phase_unwrapping_max_offset () const
	Get The maximum distance between ideal location and actual.

void	set_phase_unwrapping_max_offset (double max_offset)
	Set The maximum distance between ideal location and actual.

bool	get_mpi_detect_enabled () const
	Get wether mpi detect is enabled.

void	set_mpi_detect_enabled (bool enabled)
	Set wether mpi detect is enabled.

float	get_mpi_detect_aratio () const
	Get The amplitude ratio value.

void	set_mpi_detect_aratio (float aratio)
	Set The amplitude ratio value.

float	get_mpi_detect_phi_diff () const
	Get the phase difference ratio.

void	set_mpi_detect_phi_diff (float phi_diff)
	Set the phase difference ratio.

bool	get_mixed_pixel_enabled () const
	Get wether mixed pixel is enabled.

void	set_mixed_pixel_enabled (bool enabled)
	Set wether mixed pixel is enabled.

const char *	get_mixed_pixel_lut_file () const
	Get location of the mixed pixel look up table file.

void	set_mixed_pixel_lut_file (StringView file_location)
	Set location of the mixed pixel look up table file.

double	get_mixed_pixel_amp_min () const
	Get minimum amplitude that pixel needs to have to apply mixed pixel to it.

void	set_mixed_pixel_amp_min (double amp_min)
	Set minimum amplitude that pixel needs to have to apply mixed pixel to it.

MpSortMode	get_mixed_pixel_sort_mode () const
	Get what output is selected.

void	set_mixed_pixel_sort_mode (MpSortMode sort_mode)
	Set what output is selected.

double	get_mixed_pixel_aratio () const
	Get the amplitude ratio for detecting MPI.

void	set_mixed_pixel_aratio (double aratio)
	Set the amplitude ratio for detecting MPI.

double	get_mixed_pixel_phi_diff () const
	Get the phase difference for detecting MPI.

void	set_mixed_pixel_phi_diff (double phi_diff)
	Set the phase difference for detecting MPI.

double	get_mixed_pixel_aggressor_threshold () const
	Get the threshold to classify a pixel as an aggressor.

void	set_mixed_pixel_aggressor_threshold (double threshold)
	Set the threshold to classify a pixel as an aggressor.

int32_t	get_mixed_pixel_min_aggressor_size () const
	Get the minimum amount of bright pixels before a bright spot is classified as an aggressor.

void	set_mixed_pixel_min_aggressor_size (int32_t size)
	Set the minimum amount of bright pixels before a bright spot is classified as an aggressor.

double	get_mixed_pixel_max_error_3f () const
	Get the maximum error when using three modulation frequencies.

void	set_mixed_pixel_max_error_3f (double max_error_3f)
	Set the maximum error when using three modulation frequencies.

double	get_mixed_pixel_adaptive_amp_max () const
	Get the maximum amplitude for adaptive sorting.

void	set_mixed_pixel_adaptive_amp_max (double adaptive_amp_max)
	Set the maximum amplitude for adaptive sorting.

double	get_mixed_pixel_adaptive_amp_min () const
	Get the minimum amplitude for adaptive sorting.

void	set_mixed_pixel_adaptive_amp_min (double adaptive_amp_min)
	Set the minimum amplitude for adaptive sorting.

double	get_mixed_pixel_aratio_min () const
	Get the minimum return amplitude ratio for adaptive sorting.

void	set_mixed_pixel_aratio_min (double aratio_min)
	Set the minimum return amplitude ratio for adaptive sorting.

double	get_mixed_pixel_aggressor_phi_offset () const
	Get The maximum phase difference before a return is not classified as aggressor.

void	set_mixed_pixel_aggressor_phi_offset (double aggressor_phi_offset)
	Set The maximum phase difference before a return is not classified as aggressor.

bool	get_hdr_enabled () const
	Get whether hdr is enabled.

void	set_hdr_enabled (bool enabled)
	Set whether hdr is enabled.

bool	get_average_enabled () const
	Get whether averaging is enabled.

void	set_average_enabled (bool enabled)
	Set whether averaging is enabled.

size_t	get_average_nframes () const
	Get the number of frames to average together.

void	set_average_nframes (size_t nframes)
	Set the number of frames to average together.

bool	get_temporal_enabled () const
	Get whether the temporal filter is enabled.

void	set_temporal_enabled (bool enabled)
	Set whether the temporal filter is enabled.

double	get_temporal_sigma () const
	Get the number of standard deviations before resetting the running average.

void	set_temporal_sigma (double sigma)
	Set the number of standard deviations before resetting the running average.

size_t	get_temporal_nframes () const
	Get the maximum number of frames to average together.

void	set_temporal_nframes (size_t nframes)
	Set the maximum number of frames to average together.

bool	get_gaussian_enabled () const
	Get whether the gaussian blur is enabled.

void	set_gaussian_enabled (bool enabled)
	Set whether the gaussian blur is enabled.

size_t	get_gaussian_size () const
	Get the gaussian region size.

void	set_gaussian_size (size_t size)
	Set the gaussian region size.

double	get_gaussian_sigma () const
	Get the gaussian sigma.

void	set_gaussian_sigma (double sigma)
	Set the gaussian sigma.

bool	get_median_enabled () const
	Get whether the median filter is enabled.

void	set_median_enabled (bool enabled)
	Set whether the median filter is enabled.

size_t	get_median_size () const
	Get the median region size.

void	set_median_size (size_t size)
	Set the median region size.

bool	get_bilateral_enabled () const
	Get whether the bilateral filter is enabled.

void	set_bilateral_enabled (bool enabled)
	Set whether the bilateral filter is enabled.

size_t	get_bilateral_size () const
	Get the bilateral region size.

void	set_bilateral_size (size_t size)
	Set the bilateral region size.

double	get_bilateral_sigma () const
	Get the bilateral standard deviation.

void	set_bilateral_sigma (double sigma)
	Set the bilateral standard deviation.

bool	get_local_means_enabled () const
	Get Whether the local means filter is enabled.

void	set_local_means_enabled (bool enabled)
	Set Whether the local means filter is enabled.

size_t	get_local_means_size () const
	Get The local means region size.

void	set_local_means_size (size_t size)
	Set The local means region size.

double	get_local_means_sigma () const
	Get The local means standard deviation for how close values are.

void	set_local_means_sigma (double sigma)
	Set The local means standard deviation for how close values are.

bool	get_flying_enabled () const
	Get whether flying pixel filter is enabled.

void	set_flying_enabled (bool enabled)
	Set whether flying pixel filter is enabled.

FlyingShape	get_flying_shape () const
	Get the shape of which surrounding pixels are checked.

void	set_flying_shape (FlyingShape shape)
	Set the shape of which surrounding pixels are checked.

size_t	get_flying_distance () const
	Get the maximum distance allowed between surrounding pixels.

void	set_flying_distance (size_t distance)
	Set the maximum distance allowed between surrounding pixels.

size_t	get_flying_edges () const
	Get the number of edges allowed to be larger than maximum distance.

void	set_flying_edges (size_t edges)
	Set the number of edges allowed to be larger than maximum distance.

bool	get_amp_threshold_enabled () const
	Get whether the amplitude threshold filter is enabled.

void	set_amp_threshold_enabled (bool enabled)
	Set whether the amplitude threshold filter is enabled.

double	get_amp_threshold_min () const
	Get the minimum amplitude allowed.

void	set_amp_threshold_min (double min)
	Set the minimum amplitude allowed.

double	get_amp_threshold_max () const
	Get the maximum amplitude allowed.

void	set_amp_threshold_max (double max)
	Set the maximum amplitude allowed.

bool	get_dist_threshold_enabled () const
	Get whether the distance threshold filter is enabled.

void	set_dist_threshold_enabled (bool enabled)
	Set whether the distance threshold filter is enabled.

double	get_dist_threshold_min () const
	Get the minimum distance allowed.

void	set_dist_threshold_min (double min)
	Set the minimum distance allowed.

double	get_dist_threshold_max () const
	Get the maximum distance allowed.

void	set_dist_threshold_max (double max)
	Set the maximum distance allowed.

float	get_radial_scale () const
	Get how much to scale the radial value by.

void	set_radial_scale (float scale)
	Set how much to scale the radial value by.

float	get_radial_add () const
	Get how much to add to the radial value.

void	set_radial_add (float addition)
	Set how much to add to the radial value.

float	get_intensity_scale () const
	Get how much to scale the intensity value by.

void	set_intensity_scale (float scale)
	Set how much to scale the intensity value by.

float	get_intensity_add () const
	Get how much to add to the intensity value.

void	set_intensity_add (float addition)
	Set how much to add to the intensity value.

double	get_char_add () const
	Get the characterization addition component.

void	set_char_add (double addition)
	Set the characterization addition component.

double	get_char_mult () const
	Get the characterization multiplication component.

void	set_char_mult (double multiplication)
	Set the characterization multiplication component.

bool	get_binning_enabled () const
	Get whether software binning is enabled.

void	set_binning_enabled (bool enabled)
	Set whether software binning is enabled.

size_t	get_binning_size () const
	Get the size of the area to bin, 2 would bin a 2x2 area.

void	set_binning_size (size_t size)
	Set the size of the area to bin, 2 would bin a 2x2 area.

BinningMode	get_binning_mode () const
	Get the binning mode to use.

void	set_binning_mode (BinningMode mode)
	Set the binning mode to use.

float	get_binning_sigma () const
	Get The maximum standard deviation to use, only used in the smart binning mode.

void	set_binning_sigma (float sigma)
	Set The maximum standard deviation to use, only used in the smart binning mode.

XyzDimension	get_xyz_dimension () const
	Get the dimension of the xyz output.

void	set_xyz_dimension (XyzDimension dimension)
	Set the dimension of the xyz output.

bool	get_rigid_transformation_enabled () const
	Get whether rigid transformation is enabled.

void	set_rigid_transformation_enabled (bool enabled)
	Set whether rigid transformation is enabled.

std::array< float, 16 >	get_rigid_transformation_matrix () const
	Get the rigid transformation 4x4 matrix.

void	set_rigid_transformation_matrix (const std::array< float, 16 > &matrix)
	Set the rigid transformation 4x4 matrix.

Detailed Description

Processing that can be done.

Definition at line 47 of file processing_config.hpp.

Constructor & Destructor Documentation

◆ ProcessingConfig() [1/3]

chronoptics::tof::ProcessingConfig::ProcessingConfig ( tof_processing_config_t ptr )

inline

Construct from pointer.

Definition at line 50 of file processing_config.hpp.

◆ ProcessingConfig() [2/3]

chronoptics::tof::ProcessingConfig::ProcessingConfig ( )

inline

Create default processing config.

Definition at line 56 of file processing_config.hpp.

◆ ProcessingConfig() [3/3]

chronoptics::tof::ProcessingConfig::ProcessingConfig ( StringView file_location )

inline

Load processing config from disk.

Parameters

file_location Location of processing config

Definition at line 63 of file processing_config.hpp.

Member Function Documentation

◆ get_amp_threshold_enabled()

bool chronoptics::tof::ProcessingConfig::get_amp_threshold_enabled ( ) const

inline

Get whether the amplitude threshold filter is enabled.

This filter filters out pixels outside of the specified values

Returns: Enabled

Definition at line 676 of file processing_config.hpp.

◆ get_amp_threshold_max()

double chronoptics::tof::ProcessingConfig::get_amp_threshold_max ( ) const

inline

Get the maximum amplitude allowed.

Returns: Maximum value

Definition at line 705 of file processing_config.hpp.

◆ get_amp_threshold_min()

double chronoptics::tof::ProcessingConfig::get_amp_threshold_min ( ) const

inline

Get the minimum amplitude allowed.

Returns: Minimum value

Definition at line 691 of file processing_config.hpp.

◆ get_average_enabled()

bool chronoptics::tof::ProcessingConfig::get_average_enabled ( ) const

inline

Get whether averaging is enabled.

The average process allows you to average multiple frames together at the cost of frame rate

Returns: Enabled

Definition at line 380 of file processing_config.hpp.

◆ get_average_nframes()

size_t chronoptics::tof::ProcessingConfig::get_average_nframes ( ) const

inline

Get the number of frames to average together.

Returns: Number of frames

Definition at line 395 of file processing_config.hpp.

◆ get_bilateral_enabled()

bool chronoptics::tof::ProcessingConfig::get_bilateral_enabled ( ) const

inline

Get whether the bilateral filter is enabled.

This filter averages the current pixel with neighboring ones if they're within the specified standard deviation

Returns: Enabled

Definition at line 531 of file processing_config.hpp.

◆ get_bilateral_sigma()

double chronoptics::tof::ProcessingConfig::get_bilateral_sigma ( ) const

inline

Get the bilateral standard deviation.

Returns: The standard deviation

Definition at line 561 of file processing_config.hpp.

◆ get_bilateral_size()

size_t chronoptics::tof::ProcessingConfig::get_bilateral_size ( ) const

inline

Get the bilateral region size.

Returns: Region size, 3x3 and 5x5 are supported

Definition at line 547 of file processing_config.hpp.

◆ get_binning_enabled()

bool chronoptics::tof::ProcessingConfig::get_binning_enabled ( ) const

inline

Get whether software binning is enabled.

Returns: Enabled

Definition at line 851 of file processing_config.hpp.

◆ get_binning_mode()

BinningMode chronoptics::tof::ProcessingConfig::get_binning_mode ( ) const

inline

Get the binning mode to use.

Returns: The binning mode

Definition at line 879 of file processing_config.hpp.

◆ get_binning_sigma()

float chronoptics::tof::ProcessingConfig::get_binning_sigma ( ) const

inline

Get The maximum standard deviation to use, only used in the smart binning mode.

Returns: The standard deviation

Definition at line 894 of file processing_config.hpp.

◆ get_binning_size()

size_t chronoptics::tof::ProcessingConfig::get_binning_size ( ) const

inline

Get the size of the area to bin, 2 would bin a 2x2 area.

Returns: The bin size

Definition at line 865 of file processing_config.hpp.

◆ get_calibration_enabled()

bool chronoptics::tof::ProcessingConfig::get_calibration_enabled ( ) const

inline

Get whether the calibration is applied.

Returns: Enabled

Definition at line 91 of file processing_config.hpp.

◆ get_char_add()

double chronoptics::tof::ProcessingConfig::get_char_add ( ) const

inline

Get the characterization addition component.

The characterization function computes the sigma for the temporal and bilateral filter

Returns: addition

Definition at line 820 of file processing_config.hpp.

◆ get_char_mult()

double chronoptics::tof::ProcessingConfig::get_char_mult ( ) const

inline

Get the characterization multiplication component.

The characterization function computes the sigma for the temporal and bilateral filter

Returns: Multiplication

Definition at line 836 of file processing_config.hpp.

◆ get_dist_threshold_enabled()

bool chronoptics::tof::ProcessingConfig::get_dist_threshold_enabled ( ) const

inline

Get whether the distance threshold filter is enabled.

This filter filters out pixels outside of the specified values

Returns: Enabled

Definition at line 720 of file processing_config.hpp.

◆ get_dist_threshold_max()

double chronoptics::tof::ProcessingConfig::get_dist_threshold_max ( ) const

inline

Get the maximum distance allowed.

Returns: Maximum value

Definition at line 749 of file processing_config.hpp.

◆ get_dist_threshold_min()

double chronoptics::tof::ProcessingConfig::get_dist_threshold_min ( ) const

inline

Get the minimum distance allowed.

Returns: Minimum value

Definition at line 735 of file processing_config.hpp.

◆ get_flying_distance()

size_t chronoptics::tof::ProcessingConfig::get_flying_distance ( ) const

inline

Get the maximum distance allowed between surrounding pixels.

Returns: Maximum distance

Definition at line 647 of file processing_config.hpp.

◆ get_flying_edges()

size_t chronoptics::tof::ProcessingConfig::get_flying_edges ( ) const

inline

Get the number of edges allowed to be larger than maximum distance.

Returns: Maximum edges

Definition at line 661 of file processing_config.hpp.

◆ get_flying_enabled()

bool chronoptics::tof::ProcessingConfig::get_flying_enabled ( ) const

inline

Get whether flying pixel filter is enabled.

The flying pixel filters out pixels when more than x edges are farther than x size away

Returns: Enabled

Definition at line 618 of file processing_config.hpp.

◆ get_flying_shape()

FlyingShape chronoptics::tof::ProcessingConfig::get_flying_shape ( ) const

inline

Get the shape of which surrounding pixels are checked.

Returns: The shape

Definition at line 633 of file processing_config.hpp.

◆ get_gaussian_enabled()

bool chronoptics::tof::ProcessingConfig::get_gaussian_enabled ( ) const

inline

Get whether the gaussian blur is enabled.

This is a standard gaussian blur applied over the depth image

Returns: Enabled

Definition at line 456 of file processing_config.hpp.

◆ get_gaussian_sigma()

double chronoptics::tof::ProcessingConfig::get_gaussian_sigma ( ) const

inline

Get the gaussian sigma.

Returns: The standard deviation

Definition at line 485 of file processing_config.hpp.

◆ get_gaussian_size()

size_t chronoptics::tof::ProcessingConfig::get_gaussian_size ( ) const

inline

Get the gaussian region size.

Returns: Region size, 3x3 and 5x5 are supported

Definition at line 471 of file processing_config.hpp.

◆ get_gpu()

bool chronoptics::tof::ProcessingConfig::get_gpu ( ) const

inline

Get whether processing on the gpu is enabled.

Returns: Enabled

Definition at line 77 of file processing_config.hpp.

◆ get_hdr_enabled()

bool chronoptics::tof::ProcessingConfig::get_hdr_enabled ( ) const

inline

Get whether hdr is enabled.

High dynamic range allows you to separate depth with high intensity difference. This is mostly useful when the sensor is being saturated.

Returns: Enabled

Definition at line 363 of file processing_config.hpp.

◆ get_intensity_add()

float chronoptics::tof::ProcessingConfig::get_intensity_add ( ) const

inline

Get how much to add to the intensity value.

Returns: Intensity addition

Definition at line 805 of file processing_config.hpp.

◆ get_intensity_scale()

float chronoptics::tof::ProcessingConfig::get_intensity_scale ( ) const

inline

Get how much to scale the intensity value by.

Returns: Intensity scale

Definition at line 791 of file processing_config.hpp.

◆ get_local_means_enabled()

bool chronoptics::tof::ProcessingConfig::get_local_means_enabled ( ) const

inline

Get Whether the local means filter is enabled.

Returns: Enabled

Definition at line 575 of file processing_config.hpp.

◆ get_local_means_sigma()

double chronoptics::tof::ProcessingConfig::get_local_means_sigma ( ) const

inline

Get The local means standard deviation for how close values are.

Returns: The stand deviation

Definition at line 603 of file processing_config.hpp.

◆ get_local_means_size()

size_t chronoptics::tof::ProcessingConfig::get_local_means_size ( ) const

inline

Get The local means region size.

Returns: Region size

Definition at line 589 of file processing_config.hpp.

◆ get_median_enabled()

bool chronoptics::tof::ProcessingConfig::get_median_enabled ( ) const

inline

Get whether the median filter is enabled.

This is a standard median filter applied over the depth image

Returns: Enabled

Definition at line 500 of file processing_config.hpp.

◆ get_median_size()

size_t chronoptics::tof::ProcessingConfig::get_median_size ( ) const

inline

Get the median region size.

Returns: Region size, 3x3 and 5x5 are supported

Definition at line 515 of file processing_config.hpp.

◆ get_mixed_pixel_adaptive_amp_max()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_adaptive_amp_max ( ) const

inline

Get the maximum amplitude for adaptive sorting.

Returns: Maximum amplitude

Definition at line 303 of file processing_config.hpp.

◆ get_mixed_pixel_adaptive_amp_min()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_adaptive_amp_min ( ) const

inline

Get the minimum amplitude for adaptive sorting.

Returns: Minimum amplitude

Definition at line 317 of file processing_config.hpp.

◆ get_mixed_pixel_aggressor_phi_offset()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_aggressor_phi_offset ( ) const

inline

Get The maximum phase difference before a return is not classified as aggressor.

Returns: Phase offset before not a aggressor return

Definition at line 346 of file processing_config.hpp.

◆ get_mixed_pixel_aggressor_threshold()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_aggressor_threshold ( ) const

inline

Get the threshold to classify a pixel as an aggressor.

Returns: Aggressor threshold

Definition at line 259 of file processing_config.hpp.

◆ get_mixed_pixel_amp_min()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_amp_min ( ) const

inline

Get minimum amplitude that pixel needs to have to apply mixed pixel to it.

Returns: Minimum amplitude

Definition at line 203 of file processing_config.hpp.

◆ get_mixed_pixel_aratio()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_aratio ( ) const

inline

Get the amplitude ratio for detecting MPI.

Returns: Amplitude ratio

Definition at line 231 of file processing_config.hpp.

◆ get_mixed_pixel_aratio_min()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_aratio_min ( ) const

inline

Get the minimum return amplitude ratio for adaptive sorting.

Returns: Minimum return ratio

Definition at line 331 of file processing_config.hpp.

◆ get_mixed_pixel_enabled()

bool chronoptics::tof::ProcessingConfig::get_mixed_pixel_enabled ( ) const

inline

Get wether mixed pixel is enabled.

Returns: Enabled

Definition at line 175 of file processing_config.hpp.

◆ get_mixed_pixel_lut_file()

const char * chronoptics::tof::ProcessingConfig::get_mixed_pixel_lut_file ( ) const

inline

Get location of the mixed pixel look up table file.

Returns: File location

Definition at line 189 of file processing_config.hpp.

◆ get_mixed_pixel_max_error_3f()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_max_error_3f ( ) const

inline

Get the maximum error when using three modulation frequencies.

Returns: The error

Definition at line 289 of file processing_config.hpp.

◆ get_mixed_pixel_min_aggressor_size()

int32_t chronoptics::tof::ProcessingConfig::get_mixed_pixel_min_aggressor_size ( ) const

inline

Get the minimum amount of bright pixels before a bright spot is classified as an aggressor.

Returns: Minimum aggressor size

Definition at line 274 of file processing_config.hpp.

◆ get_mixed_pixel_phi_diff()

double chronoptics::tof::ProcessingConfig::get_mixed_pixel_phi_diff ( ) const

inline

Get the phase difference for detecting MPI.

Returns: Phase difference

Definition at line 245 of file processing_config.hpp.

◆ get_mixed_pixel_sort_mode()

MpSortMode chronoptics::tof::ProcessingConfig::get_mixed_pixel_sort_mode ( ) const

inline

Get what output is selected.

Returns: Sort mode

Definition at line 217 of file processing_config.hpp.

◆ get_mpi_detect_aratio()

float chronoptics::tof::ProcessingConfig::get_mpi_detect_aratio ( ) const

inline

Get The amplitude ratio value.

Returns: The maximum ratio

Definition at line 147 of file processing_config.hpp.

◆ get_mpi_detect_enabled()

bool chronoptics::tof::ProcessingConfig::get_mpi_detect_enabled ( ) const

inline

Get wether mpi detect is enabled.

Returns: Enabled

Definition at line 133 of file processing_config.hpp.

◆ get_mpi_detect_phi_diff()

float chronoptics::tof::ProcessingConfig::get_mpi_detect_phi_diff ( ) const

inline

Get the phase difference ratio.

Returns: The maximum phase difference

Definition at line 161 of file processing_config.hpp.

◆ get_phase_unwrapping_enabled()

bool chronoptics::tof::ProcessingConfig::get_phase_unwrapping_enabled ( ) const

inline

Get whether phase unwrapping is enabled.

Returns: Enabled

Definition at line 105 of file processing_config.hpp.

◆ get_phase_unwrapping_max_offset()

double chronoptics::tof::ProcessingConfig::get_phase_unwrapping_max_offset ( ) const

inline

Get The maximum distance between ideal location and actual.

Returns: Max offset, range [0, 1]

Definition at line 119 of file processing_config.hpp.

◆ get_radial_add()

float chronoptics::tof::ProcessingConfig::get_radial_add ( ) const

inline

Get how much to add to the radial value.

Returns: Radial addition

Definition at line 777 of file processing_config.hpp.

◆ get_radial_scale()

float chronoptics::tof::ProcessingConfig::get_radial_scale ( ) const

inline

Get how much to scale the radial value by.

Returns: Radial scale

Definition at line 763 of file processing_config.hpp.

◆ get_rigid_transformation_enabled()

bool chronoptics::tof::ProcessingConfig::get_rigid_transformation_enabled ( ) const

inline

Get whether rigid transformation is enabled.

Returns: Enabled

Definition at line 923 of file processing_config.hpp.

◆ get_rigid_transformation_matrix()

std::array< float, 16 > chronoptics::tof::ProcessingConfig::get_rigid_transformation_matrix ( ) const

inline

Get the rigid transformation 4x4 matrix.

Returns: 4x4 transformation matrix

Definition at line 937 of file processing_config.hpp.

◆ get_temporal_enabled()

bool chronoptics::tof::ProcessingConfig::get_temporal_enabled ( ) const

inline

Get whether the temporal filter is enabled.

The temporal filter is a running average as long as the values are within sigma standard deviations of each other

Returns: Enabled

Definition at line 411 of file processing_config.hpp.

◆ get_temporal_nframes()

size_t chronoptics::tof::ProcessingConfig::get_temporal_nframes ( ) const

inline

Get the maximum number of frames to average together.

Returns: Number of frames

Definition at line 441 of file processing_config.hpp.

◆ get_temporal_sigma()

double chronoptics::tof::ProcessingConfig::get_temporal_sigma ( ) const

inline

Get the number of standard deviations before resetting the running average.

Returns: The standard deviation

Definition at line 427 of file processing_config.hpp.

◆ get_xyz_dimension()

XyzDimension chronoptics::tof::ProcessingConfig::get_xyz_dimension ( ) const

inline

Get the dimension of the xyz output.

Returns: The dimension

Definition at line 909 of file processing_config.hpp.

◆ set_amp_threshold_enabled()

void chronoptics::tof::ProcessingConfig::set_amp_threshold_enabled ( bool enabled )

inline

Set whether the amplitude threshold filter is enabled.

This filter filters out pixels outside of the specified values

Parameters

enabled Enabled

Definition at line 684 of file processing_config.hpp.

◆ set_amp_threshold_max()

void chronoptics::tof::ProcessingConfig::set_amp_threshold_max ( double max )

inline

Set the maximum amplitude allowed.

Parameters

max	Maximum value

Definition at line 712 of file processing_config.hpp.

◆ set_amp_threshold_min()

void chronoptics::tof::ProcessingConfig::set_amp_threshold_min ( double min )

inline

Set the minimum amplitude allowed.

Parameters

min	Minimum value

Definition at line 698 of file processing_config.hpp.

◆ set_average_enabled()

void chronoptics::tof::ProcessingConfig::set_average_enabled ( bool enabled )

inline

Set whether averaging is enabled.

The average process allows you to average multiple frames together at the cost of frame rate

Parameters

enabled Enabled

Definition at line 388 of file processing_config.hpp.

◆ set_average_nframes()

void chronoptics::tof::ProcessingConfig::set_average_nframes ( size_t nframes )

inline

Set the number of frames to average together.

Parameters

nframes Number of frames

Definition at line 402 of file processing_config.hpp.

◆ set_bilateral_enabled()

void chronoptics::tof::ProcessingConfig::set_bilateral_enabled ( bool enabled )

inline

Set whether the bilateral filter is enabled.

This filter averages the current pixel with neighboring ones if they're within the specified standard deviation

Parameters

enabled Enabled

Definition at line 540 of file processing_config.hpp.

◆ set_bilateral_sigma()

void chronoptics::tof::ProcessingConfig::set_bilateral_sigma ( double sigma )

inline

Set the bilateral standard deviation.

Parameters

sigma The standard deviation

Definition at line 568 of file processing_config.hpp.

◆ set_bilateral_size()

void chronoptics::tof::ProcessingConfig::set_bilateral_size ( size_t size )

inline

Set the bilateral region size.

Parameters

size	Region size, 3x3 and 5x5 are supported

Definition at line 554 of file processing_config.hpp.

◆ set_binning_enabled()

void chronoptics::tof::ProcessingConfig::set_binning_enabled ( bool enabled )

inline

Set whether software binning is enabled.

Parameters

enabled Enabled

Definition at line 858 of file processing_config.hpp.

◆ set_binning_mode()

void chronoptics::tof::ProcessingConfig::set_binning_mode ( BinningMode mode )

inline

Set the binning mode to use.

Parameters

mode	The binning mode

Definition at line 886 of file processing_config.hpp.

◆ set_binning_sigma()

void chronoptics::tof::ProcessingConfig::set_binning_sigma ( float sigma )

inline

Set The maximum standard deviation to use, only used in the smart binning mode.

Parameters

sigma The standard deviation

Definition at line 902 of file processing_config.hpp.

◆ set_binning_size()

void chronoptics::tof::ProcessingConfig::set_binning_size ( size_t size )

inline

Set the size of the area to bin, 2 would bin a 2x2 area.

Parameters

size	The bin size

Definition at line 872 of file processing_config.hpp.

◆ set_calibration_enabled()

void chronoptics::tof::ProcessingConfig::set_calibration_enabled ( bool enabled )

inline

Set whether the calibration is applied.

Parameters

enabled Enabled

Definition at line 98 of file processing_config.hpp.

◆ set_char_add()

void chronoptics::tof::ProcessingConfig::set_char_add ( double addition )

inline

Set the characterization addition component.

The characterization function computes the sigma for the temporal and bilateral filter

Parameters

addition addition

Definition at line 828 of file processing_config.hpp.

◆ set_char_mult()

void chronoptics::tof::ProcessingConfig::set_char_mult ( double multiplication )

inline

Set the characterization multiplication component.

The characterization function computes the sigma for the temporal and bilateral filter

Parameters

multiplication Multiplication

Definition at line 844 of file processing_config.hpp.

◆ set_dist_threshold_enabled()

void chronoptics::tof::ProcessingConfig::set_dist_threshold_enabled ( bool enabled )

inline

Set whether the distance threshold filter is enabled.

This filter filters out pixels outside of the specified values

Parameters

enabled Enabled

Definition at line 728 of file processing_config.hpp.

◆ set_dist_threshold_max()

void chronoptics::tof::ProcessingConfig::set_dist_threshold_max ( double max )

inline

Set the maximum distance allowed.

Parameters

max	Maximum value

Definition at line 756 of file processing_config.hpp.

◆ set_dist_threshold_min()

void chronoptics::tof::ProcessingConfig::set_dist_threshold_min ( double min )

inline

Set the minimum distance allowed.

Parameters

min	Minimum value

Definition at line 742 of file processing_config.hpp.

◆ set_flying_distance()

void chronoptics::tof::ProcessingConfig::set_flying_distance ( size_t distance )

inline

Set the maximum distance allowed between surrounding pixels.

Parameters

distance Maximum distance

Definition at line 654 of file processing_config.hpp.

◆ set_flying_edges()

void chronoptics::tof::ProcessingConfig::set_flying_edges ( size_t edges )

inline

Set the number of edges allowed to be larger than maximum distance.

Parameters

edges Maximum edges

Definition at line 668 of file processing_config.hpp.

◆ set_flying_enabled()

void chronoptics::tof::ProcessingConfig::set_flying_enabled ( bool enabled )

inline

Set whether flying pixel filter is enabled.

The flying pixel filters out pixels when more than x edges are farther than x size away

Parameters

enabled Enabled

Definition at line 626 of file processing_config.hpp.

◆ set_flying_shape()

void chronoptics::tof::ProcessingConfig::set_flying_shape ( FlyingShape shape )

inline

Set the shape of which surrounding pixels are checked.

Parameters

shape The shape

Definition at line 640 of file processing_config.hpp.

◆ set_gaussian_enabled()

void chronoptics::tof::ProcessingConfig::set_gaussian_enabled ( bool enabled )

inline

Set whether the gaussian blur is enabled.

This is a standard gaussian blur applied over the depth image

Parameters

enabled Enabled

Definition at line 464 of file processing_config.hpp.

◆ set_gaussian_sigma()

void chronoptics::tof::ProcessingConfig::set_gaussian_sigma ( double sigma )

inline

Set the gaussian sigma.

Parameters

sigma The standard deviation

Definition at line 492 of file processing_config.hpp.

◆ set_gaussian_size()

void chronoptics::tof::ProcessingConfig::set_gaussian_size ( size_t size )

inline

Set the gaussian region size.

Parameters

size	Region size, 3x3 and 5x5 are supported

Definition at line 478 of file processing_config.hpp.

◆ set_gpu()

void chronoptics::tof::ProcessingConfig::set_gpu ( bool gpu )

inline

Set whether processing on the gpu is enabled.

Parameters

gpu Enabled

Definition at line 84 of file processing_config.hpp.

◆ set_hdr_enabled()

void chronoptics::tof::ProcessingConfig::set_hdr_enabled ( bool enabled )

inline

Set whether hdr is enabled.

High dynamic range allows you to separate depth with high intensity difference. This is mostly useful when the sensor is being saturated.

Parameters

enabled Enabled

Definition at line 372 of file processing_config.hpp.

◆ set_intensity_add()

void chronoptics::tof::ProcessingConfig::set_intensity_add ( float addition )

inline

Set how much to add to the intensity value.

Parameters

addition Intensity addition

Definition at line 812 of file processing_config.hpp.

◆ set_intensity_scale()

void chronoptics::tof::ProcessingConfig::set_intensity_scale ( float scale )

inline

Set how much to scale the intensity value by.

Parameters

scale Intensity scale

Definition at line 798 of file processing_config.hpp.

◆ set_local_means_enabled()

void chronoptics::tof::ProcessingConfig::set_local_means_enabled ( bool enabled )

inline

Set Whether the local means filter is enabled.

Parameters

enabled Enabled

Definition at line 582 of file processing_config.hpp.

◆ set_local_means_sigma()

void chronoptics::tof::ProcessingConfig::set_local_means_sigma ( double sigma )

inline

Set The local means standard deviation for how close values are.

Parameters

sigma The stand deviation

Definition at line 610 of file processing_config.hpp.

◆ set_local_means_size()

void chronoptics::tof::ProcessingConfig::set_local_means_size ( size_t size )

inline

Set The local means region size.

Parameters

size	Region size

Definition at line 596 of file processing_config.hpp.

◆ set_median_enabled()

void chronoptics::tof::ProcessingConfig::set_median_enabled ( bool enabled )

inline

Set whether the median filter is enabled.

This is a standard median filter applied over the depth image

Parameters

enabled Enabled

Definition at line 508 of file processing_config.hpp.

◆ set_median_size()

void chronoptics::tof::ProcessingConfig::set_median_size ( size_t size )

inline

Set the median region size.

Parameters

size	Region size, 3x3 and 5x5 are supported

Definition at line 522 of file processing_config.hpp.

◆ set_mixed_pixel_adaptive_amp_max()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_adaptive_amp_max ( double adaptive_amp_max )

inline

Set the maximum amplitude for adaptive sorting.

Parameters

adaptive_amp_max Maximum amplitude

Definition at line 310 of file processing_config.hpp.

◆ set_mixed_pixel_adaptive_amp_min()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_adaptive_amp_min ( double adaptive_amp_min )

inline

Set the minimum amplitude for adaptive sorting.

Parameters

adaptive_amp_min Minimum amplitude

Definition at line 324 of file processing_config.hpp.

◆ set_mixed_pixel_aggressor_phi_offset()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_aggressor_phi_offset ( double aggressor_phi_offset )

inline

Set The maximum phase difference before a return is not classified as aggressor.

Parameters

aggressor_phi_offset Phase offset before not a aggressor return

Definition at line 354 of file processing_config.hpp.

◆ set_mixed_pixel_aggressor_threshold()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_aggressor_threshold ( double threshold )

inline

Set the threshold to classify a pixel as an aggressor.

Parameters

threshold Aggressor threshold

Definition at line 266 of file processing_config.hpp.

◆ set_mixed_pixel_amp_min()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_amp_min ( double amp_min )

inline

Set minimum amplitude that pixel needs to have to apply mixed pixel to it.

Parameters

amp_min Minimum amplitude

Definition at line 210 of file processing_config.hpp.

◆ set_mixed_pixel_aratio()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_aratio ( double aratio )

inline

Set the amplitude ratio for detecting MPI.

Parameters

aratio Amplitude ratio

Definition at line 238 of file processing_config.hpp.

◆ set_mixed_pixel_aratio_min()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_aratio_min ( double aratio_min )

inline

Set the minimum return amplitude ratio for adaptive sorting.

Parameters

aratio_min Minimum return ratio

Definition at line 338 of file processing_config.hpp.

◆ set_mixed_pixel_enabled()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_enabled ( bool enabled )

inline

Set wether mixed pixel is enabled.

Parameters

enabled Enabled

Definition at line 182 of file processing_config.hpp.

◆ set_mixed_pixel_lut_file()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_lut_file ( StringView file_location )

inline

Set location of the mixed pixel look up table file.

Parameters

file_location File location

Definition at line 196 of file processing_config.hpp.

◆ set_mixed_pixel_max_error_3f()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_max_error_3f ( double max_error_3f )

inline

Set the maximum error when using three modulation frequencies.

Parameters

max_error_3f The error

Definition at line 296 of file processing_config.hpp.

◆ set_mixed_pixel_min_aggressor_size()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_min_aggressor_size ( int32_t size )

inline

Set the minimum amount of bright pixels before a bright spot is classified as an aggressor.

Parameters

size	Minimum aggressor size

Definition at line 282 of file processing_config.hpp.

◆ set_mixed_pixel_phi_diff()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_phi_diff ( double phi_diff )

inline

Set the phase difference for detecting MPI.

Parameters

phi_diff Phase difference

Definition at line 252 of file processing_config.hpp.

◆ set_mixed_pixel_sort_mode()

void chronoptics::tof::ProcessingConfig::set_mixed_pixel_sort_mode ( MpSortMode sort_mode )

inline

Set what output is selected.

Parameters

sort_mode Sort mode

Definition at line 224 of file processing_config.hpp.

◆ set_mpi_detect_aratio()

void chronoptics::tof::ProcessingConfig::set_mpi_detect_aratio ( float aratio )

inline

Set The amplitude ratio value.

Parameters

aratio The maximum ratio

Definition at line 154 of file processing_config.hpp.

◆ set_mpi_detect_enabled()

void chronoptics::tof::ProcessingConfig::set_mpi_detect_enabled ( bool enabled )

inline

Set wether mpi detect is enabled.

Parameters

enabled Enabled

Definition at line 140 of file processing_config.hpp.

◆ set_mpi_detect_phi_diff()

void chronoptics::tof::ProcessingConfig::set_mpi_detect_phi_diff ( float phi_diff )

inline

Set the phase difference ratio.

Parameters

phi_diff The maximum phase difference

Definition at line 168 of file processing_config.hpp.

◆ set_phase_unwrapping_enabled()

void chronoptics::tof::ProcessingConfig::set_phase_unwrapping_enabled ( bool enabled )

inline

Set whether phase unwrapping is enabled.

Parameters

enabled Enabled

Definition at line 112 of file processing_config.hpp.

◆ set_phase_unwrapping_max_offset()

void chronoptics::tof::ProcessingConfig::set_phase_unwrapping_max_offset ( double max_offset )

inline

Set The maximum distance between ideal location and actual.

Parameters

max_offset Max offset, range [0, 1]

Definition at line 126 of file processing_config.hpp.

◆ set_radial_add()

void chronoptics::tof::ProcessingConfig::set_radial_add ( float addition )

inline

Set how much to add to the radial value.

Parameters

addition Radial addition

Definition at line 784 of file processing_config.hpp.

◆ set_radial_scale()

void chronoptics::tof::ProcessingConfig::set_radial_scale ( float scale )

inline

Set how much to scale the radial value by.

Parameters

scale Radial scale

Definition at line 770 of file processing_config.hpp.

◆ set_rigid_transformation_enabled()

void chronoptics::tof::ProcessingConfig::set_rigid_transformation_enabled ( bool enabled )

inline

Set whether rigid transformation is enabled.

Parameters

enabled Enabled

Definition at line 930 of file processing_config.hpp.

◆ set_rigid_transformation_matrix()

void chronoptics::tof::ProcessingConfig::set_rigid_transformation_matrix ( const std::array< float, 16 > & matrix )

inline

Set the rigid transformation 4x4 matrix.

Parameters

matrix 4x4 transformation matrix

Definition at line 947 of file processing_config.hpp.

◆ set_temporal_enabled()

void chronoptics::tof::ProcessingConfig::set_temporal_enabled ( bool enabled )

inline

Set whether the temporal filter is enabled.

The temporal filter is a running average as long as the values are within sigma standard deviations of each other

Parameters

enabled Enabled

Definition at line 420 of file processing_config.hpp.

◆ set_temporal_nframes()

void chronoptics::tof::ProcessingConfig::set_temporal_nframes ( size_t nframes )

inline

Set the maximum number of frames to average together.

Parameters

nframes Number of frames

Definition at line 448 of file processing_config.hpp.

◆ set_temporal_sigma()

void chronoptics::tof::ProcessingConfig::set_temporal_sigma ( double sigma )

inline

Set the number of standard deviations before resetting the running average.

Parameters

sigma The standard deviation

Definition at line 434 of file processing_config.hpp.

◆ set_xyz_dimension()

void chronoptics::tof::ProcessingConfig::set_xyz_dimension ( XyzDimension dimension )

inline

Set the dimension of the xyz output.

Parameters

dimension The dimension

Definition at line 916 of file processing_config.hpp.

◆ write()

void chronoptics::tof::ProcessingConfig::write ( StringView file_location ) const

inline

Write processing config to disk.

Parameters

file_location Location where to save the processing config

Definition at line 70 of file processing_config.hpp.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ProcessingConfig() [1/3]

◆ ProcessingConfig() [2/3]

◆ ProcessingConfig() [3/3]

Member Function Documentation

◆ get_amp_threshold_enabled()

◆ get_amp_threshold_max()

◆ get_amp_threshold_min()

◆ get_average_enabled()

◆ get_average_nframes()

◆ get_bilateral_enabled()

◆ get_bilateral_sigma()

◆ get_bilateral_size()

◆ get_binning_enabled()

◆ get_binning_mode()

◆ get_binning_sigma()

◆ get_binning_size()

◆ get_calibration_enabled()

◆ get_char_add()

◆ get_char_mult()

◆ get_dist_threshold_enabled()

◆ get_dist_threshold_max()

◆ get_dist_threshold_min()

◆ get_flying_distance()

◆ get_flying_edges()

◆ get_flying_enabled()

◆ get_flying_shape()

◆ get_gaussian_enabled()

◆ get_gaussian_sigma()

◆ get_gaussian_size()

◆ get_gpu()

◆ get_hdr_enabled()

◆ get_intensity_add()

◆ get_intensity_scale()

◆ get_local_means_enabled()

◆ get_local_means_sigma()

◆ get_local_means_size()

◆ get_median_enabled()

◆ get_median_size()

◆ get_mixed_pixel_adaptive_amp_max()

◆ get_mixed_pixel_adaptive_amp_min()

◆ get_mixed_pixel_aggressor_phi_offset()

◆ get_mixed_pixel_aggressor_threshold()

◆ get_mixed_pixel_amp_min()

◆ get_mixed_pixel_aratio()

◆ get_mixed_pixel_aratio_min()

◆ get_mixed_pixel_enabled()

◆ get_mixed_pixel_lut_file()

◆ get_mixed_pixel_max_error_3f()

◆ get_mixed_pixel_min_aggressor_size()

◆ get_mixed_pixel_phi_diff()

◆ get_mixed_pixel_sort_mode()

◆ get_mpi_detect_aratio()

◆ get_mpi_detect_enabled()

◆ get_mpi_detect_phi_diff()

◆ get_phase_unwrapping_enabled()

◆ get_phase_unwrapping_max_offset()

◆ get_radial_add()

◆ get_radial_scale()

◆ get_rigid_transformation_enabled()

◆ get_rigid_transformation_matrix()

◆ get_temporal_enabled()

◆ get_temporal_nframes()

◆ get_temporal_sigma()

◆ get_xyz_dimension()

◆ set_amp_threshold_enabled()

◆ set_amp_threshold_max()

◆ set_amp_threshold_min()

◆ set_average_enabled()

◆ set_average_nframes()

◆ set_bilateral_enabled()

◆ set_bilateral_sigma()

◆ set_bilateral_size()

◆ set_binning_enabled()

◆ set_binning_mode()

◆ set_binning_sigma()

◆ set_binning_size()

◆ set_calibration_enabled()