 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/GL/VectorFieldFlowAlgorithm.h>
Algorithm for computing solutions to (autonomous) ordinary differential equations (ODEs) More...
Inheritance diagram for VectorFieldFlowAlgorithm:Algorithm for computing solutions to (autonomous) ordinary differential equations (ODEs)
This class is designed to solve ODEs of type x'(t) = f(x(t)), where the right-hand side is given by a 2D or 3D vector field. The flow of this vector field (i.e. the solutions of this ODE, with initial value given by pixel centers) is computed and stored in a displacement field. Optionally, the vector field can be post-composed with another deformation.
Public Member Functions | |
| VectorFieldFlowAlgorithm (SharedImageSet &imgIn, SharedImageSet *output, GlDenseDeformation *initialValues=nullptr, GlDenseDeformation *other=nullptr) | |
| Constructor. | |
| VectorFieldFlowAlgorithm (int dim) | |
| Constructor (only shader compilation) | |
| void | compute () override |
| Solve the ODE with rhs given by m_vectorField and initial values m_initialValues. | |
| bool | setSharedImageSetForMask (std::shared_ptr< SharedImageSet > imgForMask) |
| Sets a SharedImageSet to use its mask, ignoring the mask of imgIn. | |
| void | setSamplerDimension (int dim) |
| Set dimension of Gl sampler. | |
| void | computeForDeformations (GlDenseDeformation &vectorField, GlDenseDeformation &displacementField, GlDenseDeformation *initialValues=nullptr, GlDenseDeformation *other=nullptr) |
| Set deformations to avoid shader recompilation. | |
| OwningDataList | takeOutput () override |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| 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 | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| 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 bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| 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. | |
Public Attributes | |
| Parameter< int > | p_numSteps {"numSteps", 10, this} |
| Parameter< float > | p_dt {"dt", 0.1f, this} |
| 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. | |
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... | |
| 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. | |
| VectorFieldFlowAlgorithm | ( | SharedImageSet & | imgIn, |
| SharedImageSet * | output, | ||
| GlDenseDeformation * | initialValues = nullptr, | ||
| GlDenseDeformation * | other = nullptr ) |
Constructor.
| imgIn | SharedImageSet input with vector field representing the right-hand side of the ODE. |
| output | Output SharedImageSet where the computed solution is stored. (If nullptr is provided, an explicit output will be returned.) |
| initialValues | Optional initial values for the ODE solution. |
| other | Optional additional deformation to be composed with the vector field. The constructor requires imgIn to have a deformation and output to have a GlDenseDeformation, or it will throw an exception. The constructor will also throw an exception, if the compilation of the shader fails. Note, the existing deformation of output will be ignored. If the deformation should be taken into account, it has to be passed via the initialValues argument. |
| VectorFieldFlowAlgorithm | ( | int | dim | ) |
Constructor (only shader compilation)
| dim | Sets dimension of sampler The constructor will throw an exception, if the compilation of the shader fails. |
|
overridevirtual |
Solve the ODE with rhs given by m_vectorField and initial values m_initialValues.
Optionally post-compose the vector field with the deformation in m_other. This function implements an approximation to the operator other * exp(vectorField) * initialValues, where * denotes composition of deformations and exp() is the time-1 flow operator.
Implements Algorithm.
| bool setSharedImageSetForMask | ( | std::shared_ptr< SharedImageSet > | imgForMask | ) |
Sets a SharedImageSet to use its mask, ignoring the mask of imgIn.
Not needed if imgIn with mask is passed to the constructor.
|
overridevirtual |
