 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
Inheritance diagram for ImageStatisticsAlgorithm:Classes | |
| struct | ChannelStatistics |
Public Member Functions | |
| ImageStatisticsAlgorithm (const SharedImageSet *imageSet) | |
| void | configure (const Properties *) override |
| Set one or multiple properties. | |
| void | configuration (Properties *) const override |
| Retrieve the properties of this object. | |
| void | compute () override |
| Compute the result. | |
| ChannelStatistics | channelStatistics () const |
| Calculate the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object. | |
| ChannelStatistics | channelStatistics (const GlLine &line) const |
| Calculate the per-channel statistics under the given line on the currently selected GlImage image of the SharedImageSet used to create this object. | |
| ChannelStatistics | channelStatistics (const GlRectangle &rectangle) const |
| Calculate the per-channel statistics under the given rectangle on the currently selected GlImage image of the SharedImageSet used to create this object. | |
| ChannelStatistics | channelStatistics (const GlCircle &circle) const |
| Calculate the per-channel statistics under the given circle on the currently selected GlImage image of the SharedImageSet used to create this object. | |
| ChannelStatistics | channelStatistics (const GlMask &mask) const |
| Calcaulte the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object, taking the given mask into consideration. | |
| std::map< unsigned char, ChannelStatistics > | channelStatisticsFromLabelMap (const GlImage &labelMap, const std::vector< unsigned char > &labels={}) const |
| Calcaulte the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object, for each of the labels in the given label map. | |
| const SharedImageSet * | image () const |
| The SharedImageSet used to create this 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 bool | createCompatible (const DataList &data, Algorithm **a) |
| If data is compatible with algorithm return true. If a is not null, create the algorithm with the given input data. | |
| static ChannelStatistics | channelStatistics (const GlImage &image, const GlMask *mask=nullptr) |
| Calculate the per-channel statistics on the given image. | |
| static ChannelStatistics | channelStatistics (const GlImage &image, const GlLine &line, const mat4 &worldToImage, const GlMask *mask=nullptr) |
| Calculate the per-channel statistics on the region of the given image under the given line. | |
| static ChannelStatistics | channelStatistics (const GlImage &image, const GlRectangle &rect, const mat4 &worldToImage, const GlMask *mask=nullptr) |
| Calculate the per-channel statistics on the region of the given image under the given rectangle. | |
| static ChannelStatistics | channelStatistics (const GlImage &image, const GlCircle &circle, const mat4 &worldToImage, const GlMask *mask=nullptr) |
| Calculate the per-channel statistics on the region of the given image under the given circle. | |
| 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. | |
|
inlineoverridevirtual |
Set one or multiple properties.
Reimplemented from Configurable.
|
inlineoverridevirtual |
Retrieve the properties of this object.
Reimplemented from Configurable.
|
inlineoverridevirtual |
Compute the result.
Implements Algorithm.
| ChannelStatistics channelStatistics | ( | ) | const |
Calculate the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object.
If the SharedImageSet this instance was initialized with has a mask, it will be taken into consideration.
| ChannelStatistics channelStatistics | ( | const GlLine & | line | ) | const |
Calculate the per-channel statistics under the given line on the currently selected GlImage image of the SharedImageSet used to create this object.
If the SharedImageSet this instance was initialized with has a mask, it will be taken into consideration.
| ChannelStatistics channelStatistics | ( | const GlRectangle & | rectangle | ) | const |
Calculate the per-channel statistics under the given rectangle on the currently selected GlImage image of the SharedImageSet used to create this object.
If the SharedImageSet this instance was initialized with has a mask, it will be taken into consideration.
| ChannelStatistics channelStatistics | ( | const GlCircle & | circle | ) | const |
Calculate the per-channel statistics under the given circle on the currently selected GlImage image of the SharedImageSet used to create this object.
If the SharedImageSet this instance was initialized with has a mask, it will be taken into consideration.
| ChannelStatistics channelStatistics | ( | const GlMask & | mask | ) | const |
Calcaulte the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object, taking the given mask into consideration.
If the SharedImageSet this instance was initialized with has a mask, it will NOT be taken into consideration.
| std::map< unsigned char, ChannelStatistics > channelStatisticsFromLabelMap | ( | const GlImage & | labelMap, |
| const std::vector< unsigned char > & | labels = {} ) const |
Calcaulte the per-channel statistics on the currently selected GlImage image of the SharedImageSet used to create this object, for each of the labels in the given label map.
The label map must be single channel and have unsigned char component type.
