se::AppConfig Struct Reference

#include <config.hpp>

Public Member Functions
void	readYaml (const std::string &filename)
	Reads the struct members from the "app" node of a YAML file.

Public Attributes
bool	enable_ground_truth = false
	Whether to use the available ground truth camera pose.
bool	enable_rendering = true
	Whether to show the supereight renders.
bool	enable_gui = true
	Whether to show the GUI.
std::string	mesh_path
	The path where meshes are saved.
std::string	slice_path
	The path where slice meshes are saved.
std::string	structure_path
	The path where structure meshes are saved.
int	sensor_downsampling_factor = 1
	The ratio of the input frame size over the frame size used internally.
int	tracking_rate = 1
	Perform tracking on a frame every tracking_rate frames.
int	integration_rate = 1
	Integrate a 3D reconstruction every integration_rate frames.
int	rendering_rate = 4
	Render the 3D reconstruction every rendering_rate frames.
int	meshing_rate = 100
	Mesh the 3D reconstruction every meshing_rate frames.
int	max_frames = -1
	The maximum number of frames to read.
std::string	log_file
	The file where the timing results will be written to.

Member Function Documentation

readYaml()

void se::AppConfig::readYaml

(

const std::string &

filename

)

Reads the struct members from the "app" node of a YAML file.

Members not present in the YAML file aren't modified.

Member Data Documentation

enable_ground_truth

bool se::AppConfig::enable_ground_truth = false

Whether to use the available ground truth camera pose.

enable_rendering

bool se::AppConfig::enable_rendering = true

Whether to show the supereight renders.

Hiding them results in faster operation.

enable_gui

bool se::AppConfig::enable_gui = true

Whether to show the GUI.

Hiding the GUI results in faster operation.

mesh_path

std::string se::AppConfig::mesh_path

The path where meshes are saved.

Set to the empty string to disable meshing. Set to "." for the current directory.

slice_path

std::string se::AppConfig::slice_path

The path where slice meshes are saved.

Set to the empty string to disable slice meshing. Set to "." for the current directory.

structure_path

std::string se::AppConfig::structure_path

The path where structure meshes are saved.

Set to the empty string to disable structure meshing. Set to "." for the current directory.

sensor_downsampling_factor

int se::AppConfig::sensor_downsampling_factor = 1

The ratio of the input frame size over the frame size used internally.

Values greater than 1 result in the input frames being downsampled before processing. Valid values are 1, 2, 4 and 8.

tracking_rate

int se::AppConfig::tracking_rate = 1

Perform tracking on a frame every tracking_rate frames.

integration_rate

int se::AppConfig::integration_rate = 1

Integrate a 3D reconstruction every integration_rate frames.

Should not be less than tracking_rate.

rendering_rate

int se::AppConfig::rendering_rate = 4

Render the 3D reconstruction every rendering_rate frames.

Note

AppConfig::enable_render == true (default) required.

Special cases: If rendering_rate == 0 the volume is only rendered for configuration::max_frame. If rendering_rate < 0 the volume is only rendered for frame abs(rendering_rate).

meshing_rate

int se::AppConfig::meshing_rate = 100

Mesh the 3D reconstruction every meshing_rate frames.

Special cases: If meshing_rate == 0 the volume is only meshed for configuration::max_frame. If meshing_rate < 0 the volume is only meshed for frame abs(meshing_rate).

max_frames

int se::AppConfig::max_frames = -1

The maximum number of frames to read.

Set to -1 to read the whole dataset.

log_file

std::string se::AppConfig::log_file

The file where the timing results will be written to.

The timing results will be written to standard output if log_file is empty.

Todo:

Show on stdout on empty string. Will have to update the perfstats.

---

The documentation for this struct was generated from the following file:

• app/include/config.hpp