 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/ML/OperationsSequenceAlgorithm.h>
Algorithm for running operations sequence on data. More...
Inheritance diagram for OperationsSequenceAlgorithm:Algorithm for running operations sequence on data.
Read a YAML configuration file from a machine learning model and execute its pre-processing or post-processing on the input Input is a whole data list, the algorithm will extract all supported data (images and point clouds for now). Can also work as SequentialImageProcessor via StreamAlgorithmExecutor (streaming use case) on an image stream.
Note that when using the SequentialImageProcessor interface instead of instantiating the operations newly for a set of images, results will not be consistent if there are random operations involved, even if you specify a seed value. This is because in sequential mode, the seed is only applied initially, not for every frame.
Public Member Functions | |
| OperationsSequenceAlgorithm (const DataList &input) | |
| 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. | |
| void | configureDefaults () override |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | compute () override |
| Compute the result. | |
| std::pair< std::shared_ptr< SharedImage >, DataComponentList > | processImage (const SharedImage &image, const DataComponentList &components) const override |
| Run the operations sequence on the given image (streaming use use). | |
| OwningDataList | takeOutput () override |
| If the algorithm creates new image data, it has to be transferred here. | |
| std::vector< SharedImageSet * > | inputImages () const |
| Get the list of all input images. | |
| void | setBoundingBoxes (std::unique_ptr< BoundingBoxSet > boxes) |
| Extra-function to handle bounding boxes (since they are not Data) | |
| std::optional< BoundingBoxSet > | outputBoundingBoxes () const |
| void | setInputImages (SharedImageSet *image, SharedImageSet *label) |
| void | setInputData (DataList &data) |
| 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 | |
| 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 |
| Public Member Functions inherited from SequentialImageProcessor | |
| virtual void | setSequentialMode (bool b) |
| This method should be called to let the algorithm know that it should only run in sequential mode. | |
| virtual bool | isSequentialMode () const |
| Returns of the algorithm should only run in sequential mode. | |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a) |
| If data is compatible with algorithm return true. If a is not zero, create algorithm with input data. | |
| static std::string | processingText (const std::string &configPath, const std::string §ion) |
| static std::vector< std::string > | getSections (const std::string &configPath) |
| 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. | |
Protected Member Functions | |
| bool | ensureOperationsSequence () const |
| 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. | |
Algorithms parameters | |
| Parameter< std::string > | p_configPath = {"configPath", "", this} |
| Parameter< std::string > | p_section = {"section", "preprocessing", this} |
| Parameter< std::string > | p_processing = {"yamlText", "", this} |
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 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. | |
| Protected Attributes inherited from SequentialImageProcessor | |
| bool | m_isSequentialMode = false |
| Flag to determine if algorithm is running in sequential mode. | |
|
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.
|
overridevirtual |
Retrieve the properties of this object, replaces values with their defaults and sets it again.
Reimplemented from Configurable.
|
overridevirtual |
Compute the result.
Implements Algorithm.
|
overridevirtual |
Run the operations sequence on the given image (streaming use use).
Implements SequentialImageProcessor.
|
overridevirtual |
If the algorithm creates new image data, it has to be transferred here.
Reimplemented from Algorithm.
