 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/GL/GlSmoothingFilter.h>
Gaussian smoothing filter. More...
Gaussian smoothing filter.
Public Member Functions | |
| GlSmoothingFilter (GL::Framebuffer *fbo=0) | |
| bool | setKernelSize (int size, double k=-1.0) override |
| Set kernel size in pixels, which needs to be an odd number and at least 3. | |
| bool | setKernelSize (vec3i sizes) |
| Set kernel size in pixels for each spatial dimension, each kernel size needs to be an odd number and at least 3. | |
| bool | setKernelSize (double size, vec3 spacing, double k=-1.0) override |
| Roughly set kernel size in mm, which must be larger than each of the components in spacing. | |
| bool | setKernelSize (vec3 size, vec3 spacing) |
| Roughly set kernel size in mm for each spatial dimension, each kernel dimension must be larger than each of the components in spacing. | |
| bool | supportsMetricMode () const override |
| Returns whether the member function setKernelSize(double,vec3,double) is implemented. | |
| Public Member Functions inherited from ImFusion::GlSeparableConvolutionFilter | |
| GlSeparableConvolutionFilter (GL::Framebuffer *fbo=0) | |
| bool | setKernels (const std::vector< const MemImage * > &imgKernels) |
| Set kernels. | |
| void | setSubVolume (const std::optional< Geometry::AlignedBox > &subVolume) |
| Specify an area of the image on which the filter is applied By default the filter is applied to the entire image Note that the values outside of the area in the output texture are unspecified. | |
| void | setSubVolume (const GL::ImageProgram::Cuboid &subVolume) |
| void | setNormalizeKernel (bool flag) |
| Specify whether to normalize kernel Set this false when using an antisymmetric function (the user must take care of the correct kernel values). | |
| bool | normalizeKernel () const |
| void | compute (const GlImage &imgIn, GlImage &imgOut) override |
| Execute the filter on the image. | |
| void | compute (SharedImage &imgIn, SharedImage &imgOut) override |
| bool | good () const override |
| Return if the filter can be used. | |
| GL::Sampler & | samplingParameters () |
| 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 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. | |
| 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 |
Additional Inherited Members | |
| 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... | |
| 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::GlSeparableConvolutionFilter | |
| void | computeInternal (const GlImage &imgIn, GlImage &imgOut, Mask *mask) |
| 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. | |
| Protected Attributes inherited from ImFusion::GlSeparableConvolutionFilter | |
| std::unique_ptr< GL::ImageProgram > | m_program |
| std::vector< std::unique_ptr< GlImage > > | m_kernels |
| kernels for each component, order: x,y,z. Size MUST be 1 or 3. | |
| std::unique_ptr< GlImage > | m_auxTexture |
| bool | m_normalizeKernel = true |
| std::optional< Geometry::AlignedBox > | m_subVolume |
| GL::Sampler | m_samplingParameters |
| 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. | |
|
overridevirtual |
Set kernel size in pixels, which needs to be an odd number and at least 3.
k parameter is unused. Returns whether the kernel was set successfully.
Reimplemented from ImFusion::GlFilter.
| bool ImFusion::GlSmoothingFilter::setKernelSize | ( | vec3i | sizes | ) |
Set kernel size in pixels for each spatial dimension, each kernel size needs to be an odd number and at least 3.
k parameter is unused. Returns whether the kernel was set successfully.
|
overridevirtual |
Roughly set kernel size in mm, which must be larger than each of the components in spacing.
Spacing is the pixel spacing of the image that should be filtered, in mm. The actual size of the resulting kernel in pixels will be the smallest odd integer that is at least size divided by spacing. k parameter is unused. Returns whether the kernel was set successfully.
Reimplemented from ImFusion::GlFilter.
| bool ImFusion::GlSmoothingFilter::setKernelSize | ( | vec3 | size, |
| vec3 | spacing ) |
Roughly set kernel size in mm for each spatial dimension, each kernel dimension must be larger than each of the components in spacing.
Spacing is the pixel spacing of the image that should be filtered, in mm. The actual size of the resulting kernel in pixels will be the smallest odd integer that is at least size divided by spacing. k parameter is unused. Returns whether the kernel was set successfully.
|
inlineoverridevirtual |
Returns whether the member function setKernelSize(double,vec3,double) is implemented.
Reimplemented from ImFusion::GlFilter.