Public Member Functions
sal3d::Merger::Config Class Reference

A merger transformation configuration. More...

#include <Merger.hpp>

List of all members.

Public Member Functions

 Config (sal3d_merger_config c_config)
 Creates a C++ Config object that holds a C sal3d_merger_config.
 Config (const Config &mc)
 Copy constructor.
Configoperator= (const Config &mc)
 Assignment operator.
 Config (const std::string &filename)
 Creates a new Config from a file.
 ~Config ()
 Destructor.
std::vector< float > accuracyMean () const
 Returns the mean accuracy of the calibration in v and g.
std::vector< float > accuracyStdDev () const
 Returns the stddev accuracy of the calibration in v and g.
sal3d_merger_config c_config () const
 Gets the C pointer to a merger_config.
std::vector< float > patternMisorientation () const
 Returns the detected pattern misorientation in the calibration.
void saveToFile (const std::string &fileName) const
 Saves the Config to a file.

Detailed Description

A merger transformation configuration.

This class requires linking with merger.lib (import library for merger.dll).

This configuration describes the transformation needed to apply to a Profile grabbed from the auxiliary camera of an acquisition system, so that it can be merged with the base profile to obtain one with less occlusions.


Constructor & Destructor Documentation

sal3d::Merger::Config::Config ( sal3d_merger_config  c_config) [inline, explicit]

Creates a C++ Config object that holds a C sal3d_merger_config.

The new C++ Config object will get the ownership of the C c_config, which means that you should not call sal3d_merger_config_release() to this c_config, otherwise it would be called twice.

Parameters:
[in]c_configThe C sal3d_merger_config to use to create this object.
sal3d::Merger::Config::Config ( const Config mc) [inline]

Copy constructor.

Parameters:
[in]mcThe Config to copy from.
Exceptions:
sal3d::ErrorOn error
sal3d::Merger::Config::Config ( const std::string &  filename) [inline, explicit]

Creates a new Config from a file.

Parameters:
[in]filenameThe name of the file to use to load the Config.
Exceptions:
sal3d::ErrorOn error

Member Function Documentation

std::vector<float> sal3d::Merger::Config::accuracyMean ( ) const [inline]

Returns the mean accuracy of the calibration in v and g.

The mean accuracy of the calibration, together with the standard deviation of the accuracy, give an idea of the errors expected for scanned objects similar in size to the calibration pattern.

Both v and g mean accuracies are given in original v and g units.

Returns:
The mean accuracy of the calibration in v and g, first and second elements of the vector.
Exceptions:
sal3d::ErrorOn error
std::vector<float> sal3d::Merger::Config::accuracyStdDev ( ) const [inline]

Returns the stddev accuracy of the calibration in v and g.

The accuracy standard deviation of the calibration, together with the mean of the accuracy, give an idea of the errors expected for scanned objects similar in size to the calibration pattern.

Both v and g accuracy standard deviations are given in original v and g units.

Returns:
The accuracy standard deviations of the calibration in v and g, first and second elements of the vector.
Exceptions:
sal3d::ErrorOn error
sal3d_merger_config sal3d::Merger::Config::c_config ( ) const [inline]

Gets the C pointer to a merger_config.

Warning:
Never call sal3d_merger_config_release with the pointer returned by this function or the application will fail.
Returns:
The pointer to the merger_config C interface.
Exceptions:
sal3d::ErrorOn error

Referenced by sal3d::Merger::average().

Config& sal3d::Merger::Config::operator= ( const Config mc) [inline]

Assignment operator.

Parameters:
[in]mcThe Config to copy to this object.
Returns:
A reference to this object.
Exceptions:
sal3d::ErrorOn error
std::vector<float> sal3d::Merger::Config::patternMisorientation ( ) const [inline]

Returns the detected pattern misorientation in the calibration.

The good results of a calibration depend on how well the pattern is oriented along the motion vector. This method returns the difference in v and g coordinates between a point of the front of the pattern, and a point of the back of the pattern. The nearer they are to zero, the better results the calibration should report.

Both v and g deviations are given in original v and g units.

Returns:
The deviation in v and g coordinates between a front pattern point, and a bottom pattern point.
Exceptions:
sal3d::ErrorOn error
void sal3d::Merger::Config::saveToFile ( const std::string &  fileName) const [inline]

Saves the Config to a file.

Parameters:
[in]fileNameThe name of the file to store the Config.
Exceptions:
sal3d::ErrorOn error

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