ImFusion SDK 4.3
GlIntensityNormalizedSmoothedGradient Class Reference

#include <ImFusion/GL/GlIntensityNormalizedSmoothedGradient.h>

Gradient relative to image intensity smoothed with a constant kernel. More...

+ Inheritance diagram for GlIntensityNormalizedSmoothedGradient:

Detailed Description

Gradient relative to image intensity smoothed with a constant kernel.

A local relative gradient (gradient length divided by intensity) is computed and and smoothed within one shader.

Only available for 3 dimensions.

Public Member Functions

 GlIntensityNormalizedSmoothedGradient (GL::Framebuffer *fbo=0)
 Constructor with optional FBO to use. If no FBO is specified a private FBO is created.
 
 ~GlIntensityNormalizedSmoothedGradient () override
 Destructor.
 
void compute (const GlImage &imgIn, GlImage &imgOut) override
 Execute the filter on the image, output image needs 3 channels.
 
void setHalfKernelSize (int size)
 
int halfKernelSize ()
 
bool good () const override
 Return if the filter can be used, in particular if the shaders are available.
 
- Public Member Functions inherited from 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 (int, double)
 Common interface to set filter kernel size and parameter.
 
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 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.
 
Progressprogress () 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 FactoryInfofactoryInfo () 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 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Protected Member Functions

void initProgram (int dim)
 
- 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

GL::ImageProgramm_program
 
int m_dim
 
int m_kernelSize = 3
 
std::unique_ptr< TypedImage< float > > m_ownedKernelX
 
std::unique_ptr< TypedImage< float > > m_ownedKernelY
 
std::unique_ptr< TypedImage< float > > m_ownedKernelZ
 
GlImagem_kernelX
 
GlImagem_kernelY
 
GlImagem_kernelZ
 
- Protected Attributes inherited from GlFilter
GL::Framebufferm_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 Algorithm
std::string m_name
 Algorithm name.
 
Progressm_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< Actionm_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< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

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...
 
- 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 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.
 

Member Function Documentation

◆ compute()

void compute ( const GlImage & imgIn,
GlImage & imgOut )
overridevirtual

Execute the filter on the image, output image needs 3 channels.

Implements GlFilter.

◆ good()

bool good ( ) const
overridevirtual

Return if the filter can be used, in particular if the shaders are available.

Implements GlFilter.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close