 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Base/PointCorrespondencesAlgorithm.h>
Algorithm for managing and registering point correspondences between two Data instances. More...
Inheritance diagram for PointCorrespondencesAlgorithm:Public Member Functions | |
| PointsOnData & | firstHandler () |
| The handler for the first data. | |
| PointsOnData & | secondHandler () |
| The handler for the second data. | |
| PointCorrespondences & | correspondences () |
| The point correspondences object. | |
| void | compute () override |
| Performs rigid registration using the current point correspondences. | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| void | configuration (Properties *p) const override |
| Serialize the current object configuration into the given Properties object. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual OwningDataList | takeOutput () |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Static Public Member Functions | |
| static std::unique_ptr< PointCorrespondencesAlgorithm > | create (Data &first, Data &second) |
| Creates the algorithm if compatible PointsOnData handlers exist for both datasets. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| static std::shared_ptr< PointsOnData > | createPointHandler (Data &data) |
| Creates a PointsOnData handler for the given data. | |
| static std::unique_ptr< PointsOnDataManipulator > | createPointManipulator (PointsOnData &pod) |
| Creates a manipulator for the given PointsOnData handler. | |
| template<class DataType, class PodType, class ManipulatorType> | |
| static void | registerPointsOnData (int priority=1) |
| Registers custom PointsOnData and manipulator types into the factory. | |
| Static Public Member Functions inherited from Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Additional Inherited Members | |
| Public Types inherited from Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
| Public Attributes inherited from Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute() | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
static |
Creates a PointsOnData handler for the given data.
It uses registered factories to find the appropriate handler type. Returns nullptr if no compatible handler is found.
|
static |
Creates a manipulator for the given PointsOnData handler.
It uses registered factories to find the appropriate manipulator type. Returns nullptr if no compatible manipulator is found.
|
inlinestatic |
Registers custom PointsOnData and manipulator types into the factory.
The priority parameter determines which factory will be used when multiple factories are available. Higher priority values mean the factory will be used first. In case of equal priorities, the factory registered first will be used. As a general suggestion, priority should be set to the inheritance depth of the class, with 1 being a class that directly inherits from Data, 2 a class that inherits from B, where B inherits directly from Data, and so on.
| DataType | Derived type of base class Data the registered PointsOnData and PointsOnDataManipulator should be used for |
| PodType | Must be of type PointsOnData that takes data of type DataType as construction parameter |
| Manipulator | Must be of type PointsOnDataManipulator that takes PointsOnData of type PodType as construction parameter |
|
overridevirtual |
Performs rigid registration using the current point correspondences.
Implements Algorithm.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from Configurable.
|
overridevirtual |
Serialize the current object configuration into the given Properties object.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from Configurable.
