Public Member Functions | Private Attributes | List of all members
kaboom::Options Class Reference

A class to parse the program options for the reconstruction executable. More...

#include <Options.hpp>

Inheritance diagram for kaboom::Options:
Inheritance graph
[legend]

Public Member Functions

int b () const
 Returns the position of the x coordinate in the data. More...
 
bool convertToLVR () const
 
bool exportScanPositions () const
 
bool filter () const
 
int g () const
 Returns the position of the x coordinate in the data. More...
 
int getEnd () const
 
string getInputDir () const
 
string getInputFile () const
 
int getK () const
 
size_t getMinPointsPerVoxel () const
 
string getOutputDir () const
 
string getOutputFile () const
 
string getOutputFormat () const
 
std::string getPoseExtension () const
 
std::string getPosePrefix () const
 
std::string getScanExtension () const
 
std::string getScanPrefix () const
 
float getSigma () const
 
int getStart () const
 
int getTargetSize () const
 
double getVoxelSize () const
 
int i () const
 Returns the position of the x coordinate in the data. More...
 
 Options (int argc, char **argv)
 Ctor. Parses the command parameters given to the main function of the program. More...
 
int r () const
 Returns the position of the x coordinate in the data. More...
 
bool transformBefore () const
 
virtual ~Options ()
 
- Public Member Functions inherited from lvr2::BaseOption
 BaseOption (int argc, char **argv)
 
CoordinateTransform< float > coordinateTransform () const
 
void printLogo () const
 
void printTransformation (std::ostream &out) const
 Prints transformation information to the given output stream. More...
 
float sx () const
 Returns the scaling factor for the x coordinates. More...
 
float sy () const
 Returns the scaling factor for the y coordinates. More...
 
float sz () const
 Returns the scaling factor for the z coordinates. More...
 
int x () const
 Returns the position of the x coordinate in the data. More...
 
int y () const
 Returns the position of the x coordinate in the data. More...
 
int z () const
 Returns the position of the x coordinate in the data. More...
 
virtual ~BaseOption ()
 

Private Attributes

options_description m_descr
 The internally used option description. More...
 
string m_outputFile
 Output file name. More...
 
positional_options_description m_pdescr
 The internally used positional option desription. More...
 
variables_map m_variables
 The internally used variable map. More...
 

Additional Inherited Members

- Protected Member Functions inherited from lvr2::BaseOption
virtual void setup ()
 Setup internal data structures. More...
 
void setupInputTransformation ()
 Setup transformation info for ModelIO. More...
 
- Protected Attributes inherited from lvr2::BaseOption
int m_argc
 Argument count. More...
 
char ** m_argv
 Argument values. More...
 
CoordinateTransform< float > * m_coordinateTransform
 Coordinate transform information. More...
 
options_description m_descr
 The internally used option description. More...
 
positional_options_description m_pdescr
 The internally used positional option desription. More...
 
variables_map m_variables
 The internally used variable map. More...
 

Detailed Description

A class to parse the program options for the reconstruction executable.

Definition at line 61 of file src/tools/lvr2_kaboom/Options.hpp.

Constructor & Destructor Documentation

◆ Options()

Options::Options ( int  argc,
char **  argv 
)

Ctor. Parses the command parameters given to the main function of the program.

Definition at line 40 of file src/tools/lvr2_kaboom/Options.cpp.

◆ ~Options()

Options::~Options ( )
virtual

Definition at line 160 of file src/tools/lvr2_kaboom/Options.cpp.

Member Function Documentation

◆ b()

int kaboom::Options::b ( ) const
inline

Returns the position of the x coordinate in the data.

Definition at line 102 of file src/tools/lvr2_kaboom/Options.hpp.

◆ convertToLVR()

bool Options::convertToLVR ( ) const

Definition at line 113 of file src/tools/lvr2_kaboom/Options.cpp.

◆ exportScanPositions()

bool Options::exportScanPositions ( ) const

Definition at line 119 of file src/tools/lvr2_kaboom/Options.cpp.

◆ filter()

bool Options::filter ( ) const

Definition at line 124 of file src/tools/lvr2_kaboom/Options.cpp.

◆ g()

int kaboom::Options::g ( ) const
inline

Returns the position of the x coordinate in the data.

Definition at line 97 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getEnd()

int kaboom::Options::getEnd ( ) const
inline

Definition at line 111 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getInputDir()

string Options::getInputDir ( ) const

Definition at line 98 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getInputFile()

string Options::getInputFile ( ) const

Definition at line 93 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getK()

int Options::getK ( ) const

Definition at line 134 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getMinPointsPerVoxel()

size_t Options::getMinPointsPerVoxel ( ) const

Definition at line 154 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getOutputDir()

string Options::getOutputDir ( ) const

Definition at line 103 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getOutputFile()

string Options::getOutputFile ( ) const

Definition at line 88 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getOutputFormat()

string Options::getOutputFormat ( ) const

Definition at line 108 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getPoseExtension()

std::string kaboom::Options::getPoseExtension ( ) const
inline

Definition at line 116 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getPosePrefix()

std::string kaboom::Options::getPosePrefix ( ) const
inline

Definition at line 114 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getScanExtension()

std::string kaboom::Options::getScanExtension ( ) const
inline

Definition at line 115 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getScanPrefix()

std::string kaboom::Options::getScanPrefix ( ) const
inline

Definition at line 113 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getSigma()

float Options::getSigma ( ) const

Definition at line 139 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getStart()

int kaboom::Options::getStart ( ) const
inline

Definition at line 109 of file src/tools/lvr2_kaboom/Options.hpp.

◆ getTargetSize()

int Options::getTargetSize ( ) const

Definition at line 144 of file src/tools/lvr2_kaboom/Options.cpp.

◆ getVoxelSize()

double Options::getVoxelSize ( ) const

Definition at line 149 of file src/tools/lvr2_kaboom/Options.cpp.

◆ i()

int kaboom::Options::i ( ) const
inline

Returns the position of the x coordinate in the data.

Definition at line 107 of file src/tools/lvr2_kaboom/Options.hpp.

◆ r()

int kaboom::Options::r ( ) const
inline

Returns the position of the x coordinate in the data.

Definition at line 92 of file src/tools/lvr2_kaboom/Options.hpp.

◆ transformBefore()

bool Options::transformBefore ( ) const

Definition at line 129 of file src/tools/lvr2_kaboom/Options.cpp.

Member Data Documentation

◆ m_descr

options_description kaboom::Options::m_descr
private

The internally used option description.

Definition at line 127 of file src/tools/lvr2_kaboom/Options.hpp.

◆ m_outputFile

string kaboom::Options::m_outputFile
private

Output file name.

Definition at line 121 of file src/tools/lvr2_kaboom/Options.hpp.

◆ m_pdescr

positional_options_description kaboom::Options::m_pdescr
private

The internally used positional option desription.

Definition at line 130 of file src/tools/lvr2_kaboom/Options.hpp.

◆ m_variables

variables_map kaboom::Options::m_variables
private

The internally used variable map.

Definition at line 124 of file src/tools/lvr2_kaboom/Options.hpp.

The documentation for this class was generated from the following files:

lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Wed Mar 2 2022 00:37:26