 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Stream/ImageTemplateMatchingAlgorithm.h>
Manages a list of image templates for a given ImageStream. More...
Inheritance diagram for ImageTemplateMatchingAlgorithm:Manages a list of image templates for a given ImageStream.
New image templates can be created and saved to ImFusion files. Each template has ROIs that can be controlled interactively through the ImageTemplateFromStreamController. The best matching template can also be computed for each frame of the stream.
Public Member Functions | |
| ImageTemplateMatchingAlgorithm (ImageStream *imageStream) | |
| ~ImageTemplateMatchingAlgorithm () override | |
| If load or saveTo were called, this saves all changes to the current ImFusion file. | |
| void | compute () override |
| If the algorithm is matching (isMatching() == true), this selects the best matching image template. | |
| void | onStreamData (std::shared_ptr< const StreamData > streamData) |
| Sets the current frame and calls compute(). | |
| 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. | |
| ImageStream * | stream () const |
| const std::vector< std::unique_ptr< ImageTemplate > > & | imageTemplates () const |
| const ImageTemplate * | selectedImageTemplate () const |
| const ImageTemplate * | addImageTemplate () |
| Adds an image template, selects it, and returns it. | |
| void | deleteSelectedImageTemplate () |
| Deletes the selected image template and selects the previous one. | |
| void | clearImageTemplates () |
| Deletes all image templates. | |
| void | selectImageTemplate (const ImageTemplate *imageTemplate) |
| If the algorithm is matching, does nothing. Otherwise, sets the selected image template and calls compute(). | |
| bool | renameSelectedImageTemplate (const std::string &name) |
| Returns false if the name is already taken (and so the image template was not renamed). | |
| std::string | addRegion () |
| Adds a region to the selected image template and returns its name. | |
| void | setRegion (std::size_t regionIndex, const vec3i &ll, const vec3i &ur) |
| Sets the coordinates of the region at regionIndex of the selected image template. | |
| void | deleteRegion (std::size_t regionIndex) |
| Deletes the region at regionIndex of the selected image template. | |
| void | renameRegion (std::size_t regionIndex, const std::string &name) |
| Renames the region at regionIndex of the selected image template. | |
| void | copyRegionsFrom (const ImageTemplate *imageTemplate) |
| Copies all regions from imageTemplate into the selected image template. | |
| InteractiveCroppingBox::CropOffsets | getRegionOffsets (std::size_t regionIndex) const |
| Returns the coordinates of the region at regionIndex of the selected image template. | |
| void | setMatching (bool matching) |
| bool | isMatching () const |
| void | load (const Filesystem::Path &saveFilePath) |
| Loads all templates from saveFilePath. | |
| void | saveTo (const Filesystem::Path &saveFilePath) |
| Saves all templates to saveFilePath (as an ImFusion file). | |
| Filesystem::Path | saveToTemporary () const |
| Saves all templates to a temporary ImFusion file and returns its path. | |
| std::pair< int, double > | computeBestMatch (const MemImage &targetImage) const |
| 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 |
| Public Member Functions inherited from SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
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 | |
| Signal< std::size_t > | signalNewBestMatch |
| Signal< double > | signalNewSimilarity |
| Signal< bool > | signalMatchingStatusChanged |
| 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 Member Functions inherited from SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| 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. | |
|
overridevirtual |
If the algorithm is matching (isMatching() == true), this selects the best matching image template.
The best match can be accessed by listening to newBestMatchSignal (and indexing imageTemplates()), or with selectedImageTemplate(). This also computes the similarity, and sends newSimilaritySignal if it changed from the last call.
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.
| std::string addRegion | ( | ) |
Adds a region to the selected image template and returns its name.
Also resets the image of the image template to the current frame.
