 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/GL/BakeDeformationAlgorithm.h>
Algorithm for baking in an image deformation while adjusting the size to encompass the full deformation. More...
Algorithm for baking in an image deformation while adjusting the size to encompass the full deformation.
Public Member Functions | |
| BakeDeformationAlgorithm (SharedImageSet &imgs, SharedImageSet *ref=nullptr) | |
| Creates the algorithm instance with a data. | |
| ~BakeDeformationAlgorithm () override | |
| Deletes owned resources. | |
| Public Member Functions inherited from ImFusion::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 ImFusion::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 |
Methods implementing the algorithm interface | |
| void | compute () override |
| Applies the processing. | |
| OwningDataList | takeOutput () override |
| If new data was created, make it available here. | |
| void | configure (const Properties *p) override |
| Apply configuration. | |
| void | configuration (Properties *p) const override |
| Configures the algorithm. | |
| void | setInput (SharedImageSet &newInput) |
| Replaces the input of the algorithm. | |
| void | setNearestInterpolation (bool val=false) |
| Configures whether nearest interpolation is used, or linear in case of false. | |
| void | setAdjustSize (bool val=true) |
| Configures whether the resulting image should adjust its size to encompass the deformation. | |
| void | setSamplerWrapping (GL::Sampler::Wrap samplerWrapping) |
| Set sampler wrapping. | |
| void | setBorderColor (const vec4f &color) |
| Set border color in case sampler wrapping is ClampToEdge. | |
| void | setUseCPU (bool val=true) |
| Set if the algorithm should run on CPU. | |
| std::unique_ptr< SharedImage > | applyTo (int i) |
| Apply Deformations to SharedImage i in the SharedImageSet given in the constructor returns a pointer to a newly created SharedImage, ensure that it gets owned by a unique_ptr Note: requires estimateOutputSize(i) to have been run before. | |
| void | estimateOutputSize (int i) |
| Estimates the output size by running deformations on the edge surfaces. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
Additional Inherited Members | |
| Public Types inherited from ImFusion::Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
| Static Public Member Functions inherited from ImFusion::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 inherited from ImFusion::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 ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from ImFusion::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 ImFusion::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 ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
| ImFusion::BakeDeformationAlgorithm::BakeDeformationAlgorithm | ( | SharedImageSet & | imgs, |
| SharedImageSet * | ref = nullptr ) |
Creates the algorithm instance with a data.
| ref | - if not nullptr, the output image will have the same position as the reference image, else the output location is estimated. |
|
static |
Factory method to check for applicability or to create the algorithm
|
overridevirtual |
Applies the processing.
Implements ImFusion::Algorithm.
|
overridevirtual |
If new data was created, make it available here.
Reimplemented from ImFusion::Algorithm.
|
overridevirtual |
Apply configuration.
Reimplemented from ImFusion::Configurable.
|
overridevirtual |
Configures the algorithm.
Reimplemented from ImFusion::Configurable.