 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/GL/GlLocalExtremalFilter.h>
Local extremal Filter. More...
Local extremal Filter.
Public Types | |
| enum class | Submode { MIN = 0 , MAX = 1 } |
| Filter submode. | |
| 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... | |
Public Member Functions | |
| GlLocalExtremalFilter (GL::Framebuffer *fbo=0) | |
| bool | setKernelSize (int size, double k) override |
| void | setSubmode (Submode mode) |
| Set the filter submode. | |
| void | compute (const GlImage &imgIn, GlImage &imgOut) override |
| Execute the filter on the image. | |
| bool | good () const override |
| Return true if the filter can be used, in particular if the shaders are available. | |
| Public Member Functions inherited from ImFusion::GlFilter | |
| GlFilter (GL::Framebuffer *fbo=0) | |
| Constructor with optional FBO to use. If no FBO is specified a private FBO is created. | |
| ~GlFilter () override | |
| Destructor. | |
| void | compute () override |
| Algorithm interface. | |
| virtual bool | setKernelSize (double, vec3, double) |
| Common interface to set filter kernel size in mm and parameter. | |
| virtual void | compute (SharedImage &imgIn, SharedImage &imgOut) |
| virtual void | compute (const std::vector< GlImage * > &imgIn, std::vector< GlImage * > &imgOut) |
| Convenience function for executing filter on multiple images. | |
| virtual void | prepareForMasking (Mask *) |
| Prepare the filter's GlProgram(s) for masking. | |
| virtual bool | supportsMetricMode () const |
| Return true if the filter supports anisotropic spacing, i.e. metric. | |
| void | setMetricMode (bool value) |
| If the GlFilter supports metric, i.e. | |
| bool | metricMode () const |
| Getter for m_metricMode. | |
| Public Member Functions inherited from ImFusion::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 ImFusion::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 |
Protected Attributes | |
| std::unique_ptr< GL::ImageProgram > | m_program |
| int | m_kernelSize = 3 |
| Kernel size in pixels. | |
| Submode | m_submode = Submode::MAX |
| Filter submode. | |
| Protected Attributes inherited from ImFusion::GlFilter | |
| GL::Framebuffer * | m_fbo |
| bool | m_ownFbo |
| bool | m_metricMode |
| If set to true the GlFilter result will be computed taking the spacing into account. | |
| 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. | |
Additional Inherited Members | |
| 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. | |
|
overridevirtual |
| size | Size of quadratic kernel. Currently supported sizes are 3 and 5. |
| k | Threshold value. Note that this is the slider value multiplied by 0.01 |
Reimplemented from ImFusion::GlFilter.
|
overridevirtual |
Execute the filter on the image.
Implements ImFusion::GlFilter.
|
overridevirtual |
Return true if the filter can be used, in particular if the shaders are available.
Implements ImFusion::GlFilter.
|
protected |
Kernel size in pixels.