NDEVR
API Documentation
GeometryRegistrationParameters

Describes options/parameters for running a GeometryRegistration pass. More...

Inheritance diagram for GeometryRegistrationParameters:
[legend]
Collaboration diagram for GeometryRegistrationParameters:
[legend]

Public Member Functions

 GeometryRegistrationParameters ()
 Constructs default GeometryRegistrationParameters.
Public Member Functions inherited from GenericOptionGroup
 GenericOptionGroup ()=default
 Default constructor.
 GenericOptionGroup (const TranslatedString &group_name, const StringView &group_id=StringView())
 Constructs an option group with the given name and optional identifier.
virtual ~GenericOptionGroup ()
 Virtual destructor.
void addOption (const GenericOption &option)
 Adds a fully configured GenericOption to this group.
template<class t_type>
void addOption (const TranslatedString &name, const t_type &value, bool is_editable=true)
 Adds a new option to this group with the given name and typed value.
void addOptionsToINI (INIFactory &factory)
 Adds all options in this group to an existing INIFactory for serialization.
void clear ()
 Removes all options from this group.
virtual void fromJSONNode (const JSONNode &node)
 Deserializes this option group from a JSON node.
GenericOptiongetOption (const TranslatedString &n)
 Retrieves a mutable reference to the option with the given translated name.
const GenericOptiongetOption (const TranslatedString &n) const
 Retrieves a const reference to the option with the given translated name.
template<class t_type>
t_type getValue (const StringView &name) const
 Retrieves the value of an option converted to the requested type, looked up by string identifier.
template<class t_type>
t_type getValue (const StringView &name, const t_type &value_if_not_exist) const
 Retrieves the value of an option by string identifier, returning a fallback if the option does not exist.
template<class t_type>
t_type getValue (const TranslatedString &name) const
 Retrieves the value of an option converted to the requested type, looked up by translated name.
template<class t_type>
t_type getValue (const TranslatedString &name, const t_type &value_if_not_exist) const
 Retrieves the value of an option by translated name, returning a fallback if the option does not exist.
bool hasOption (const StringView &option_name) const
 Checks whether an option with the given string identifier exists in this group.
bool hasOption (const TranslatedString &option_name) const
 Checks whether an option with the given translated name exists in this group.
INIFactory ini ()
 Creates an INIFactory for serializing this option group to INI format.
bool operator!= (const GenericOptionGroup &option_group) const
 Checks inequality between two option groups.
bool operator== (const GenericOptionGroup &option_group) const
 Checks equality between two option groups by comparing all option values.
void setOption (const GenericOption &option)
 Replaces an existing option with the given GenericOption, matched by its identifier.
template<class t_type>
void setValue (const StringView &name, const t_type &value)
 Sets the value of an existing option identified by its string name.
template<class t_type>
void setValue (const TranslatedString &name, const t_type &value)
 Sets the value of an existing option identified by its translated name.
virtual JSONNode toJSONNode (bool only_value=true) const
 Serializes this option group to a JSON node.

Public Attributes

const void * lock = nullptr
 Optional mutex/lock pointer for thread-safe access during registration.
LogPtr log
 Log target for diagnostic and progress messages.
Buffer< Matrix< fltp08 > > original_transforms
 The original transforms of each registration point set before alignment.
Buffer< Matrix< fltp08 > > potential_a_to_b_transform
 Candidate transforms mapping source geometry to the reference frame.
GeometryVertices reference
 The reference (fixed) point set that other geometry is aligned to.
Matrix< fltp08reference_transform
 The world-space transform of the reference geometry.
Buffer< GeometryVerticesregistration_points
 The movable point sets to be aligned to the reference.
std::function< void(uint04 iteration_a, uint04 iteration_b, Matrix< fltp08 > &mat, bool finished)> update_data_callback
 Callback invoked during registration iterations to report progress.
Public Attributes inherited from GenericOptionGroup
String id
 The unique identifier for this option group.
TranslatedString name
 The user-facing display name of this option group.
Dictionary< String, GenericOptionoptions
 The dictionary mapping option identifiers to their GenericOption instances.
Buffer< Stringordered_options
 The insertion-ordered list of option identifiers for preserving display order.

Detailed Description

Describes options/parameters for running a GeometryRegistration pass.


Holds all inputs needed by a registration algorithm: the reference geometry, the point sets to register, initial transform guesses, and a callback for progress updates.

Definition at line 37 of file GeometryRegistration.h.

Constructor & Destructor Documentation

◆ GeometryRegistrationParameters()

GeometryRegistrationParameters::GeometryRegistrationParameters ( )

Constructs default GeometryRegistrationParameters.


Member Data Documentation

◆ update_data_callback

std::function<void(uint04 iteration_a, uint04 iteration_b, Matrix<fltp08>& mat, bool finished)> GeometryRegistrationParameters::update_data_callback

Callback invoked during registration iterations to report progress.


Note
The exact semantics of iteration_a and iteration_b are engine-specific. Typically iteration_a is the outer loop index and iteration_b the inner loop index.

Definition at line 58 of file GeometryRegistration.h.


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