CTL  0.6.1
Computed Tomography Library
Public Types | Public Member Functions | Friends | List of all members
CTL::IdentityRegularizer Class Reference

The IdentityRegularizer class is an implementation of AbstractVolumeFilter that does not change input volumes at all; typically used as a placeholder. More...

#include <regularizers.h>

Inheritance diagram for CTL::IdentityRegularizer:
Inheritance graph
[legend]
Collaboration diagram for CTL::IdentityRegularizer:
Collaboration graph
[legend]

Public Types

enum  { Type = 2010 }
 
- Public Types inherited from CTL::AbstractVolumeFilter
enum  { Type = 2000 }
 
- Public Types inherited from CTL::SerializationInterface
enum  { Type = -1, UserType = 65536 }
 

Public Member Functions

int type () const override
 
void filter (VoxelVolume< float > &volume) override
 Trivial implementation that does nothing.
 
- Public Member Functions inherited from CTL::AbstractVolumeFilter
virtual QVariant parameter () const
 
virtual void setParameter (const QVariant &parameter)
 
void fromVariant (const QVariant &variant) override
 
QVariant toVariant () const override
 
- Public Member Functions inherited from CTL::SerializationInterface
virtual ~SerializationInterface ()=default
 

Friends

template<class >
struct SerializationHelper::RegisterWithSerializationHelper
 

Additional Inherited Members

- Protected Member Functions inherited from CTL::AbstractVolumeFilter
 AbstractVolumeFilter (const AbstractVolumeFilter &)=default
 
 AbstractVolumeFilter (AbstractVolumeFilter &&)=default
 
AbstractVolumeFilteroperator= (const AbstractVolumeFilter &)=default
 
AbstractVolumeFilteroperator= (AbstractVolumeFilter &&)=default
 
- Protected Member Functions inherited from CTL::SerializationInterface
 SerializationInterface ()=default
 
 SerializationInterface (const SerializationInterface &)=default
 
 SerializationInterface (SerializationInterface &&)=default
 
SerializationInterfaceoperator= (const SerializationInterface &)=default
 
SerializationInterfaceoperator= (SerializationInterface &&)=default
 

Detailed Description

The IdentityRegularizer class is an implementation of AbstractVolumeFilter that does not change input volumes at all; typically used as a placeholder.

This volume filter's implementation of filter() does not alter input volumes at all. Its main use is to serve as a placeholder (or default) regularizer in classes that allow for arbitrary types of AbstractVolumeFilter to be used until a user defined custom class has been installed.

Member Function Documentation

◆ type()

int CTL::IdentityRegularizer::type ( ) const
inlineoverridevirtual

Returns the type-id of the serializable object. Used in deserialization to determine the proper object type.

Add derived classes to the enumeration using the CTL_TYPE_ID macro.

Reimplemented from CTL::AbstractVolumeFilter.


The documentation for this class was generated from the following files: