A class in the DataProcessor hierarchy that implements Metz filtering (which includes Gaussian filtering). More...
#include "stir/SeparableCartesianMetzImageFilter.h"
Inheritance diagram for stir::SeparableCartesianMetzImageFilter< elemT >:
Public Member Functions | |
| SeparableCartesianMetzImageFilter () | |
| Default constructor. | |
| VectorWithOffset< float > | get_metz_fwhms () const |
| VectorWithOffset< float > | get_metz_powers () const |
| VectorWithOffset< int > | get_max_kernel_sizes () const |
| Maximum number of elements in the kernels. More... | |
| template<> | |
| const char *const | registered_name |
 Public Member Functions inherited from stir::RegisteredParsingObject< SeparableCartesianMetzImageFilter< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > > | |
| std::string | get_registered_name () const override |
| Returns Derived::registered_name. | |
| std::string | parameter_info () override |
| Returns a string with all parameters and their values, in a form suitable for parsing again. | |
| Public Member Functions inherited from stir::DataProcessor< DiscretisedDensity< 3, elemT > > | |
| Succeeded | set_up (const DiscretisedDensity< 3, elemT > &data) |
| Initialises any internal data (if necessary) using data as a template for sizes, sampling distances etc. More... | |
| virtual void | reset () |
| Makes sure we will ignore any previous call to set-up() More... | |
| Succeeded | apply (DiscretisedDensity< 3, elemT > &data) |
| Calls set_up() (if not already done before) and process data in-place. More... | |
| Succeeded | apply (DiscretisedDensity< 3, elemT > &out_data, const DiscretisedDensity< 3, elemT > &in_data) |
| Calls set_up() (if not already done before) and process in_data, putting the result in out_data. More... | |
| bool | parse (std::istream &f) |
| bool | parse (const char *const filename) |
| Public Member Functions inherited from stir::ParsingObject | |
| ParsingObject (const ParsingObject &) | |
| ParsingObject & | operator= (const ParsingObject &) |
| void | ask_parameters () |
| bool | parse (std::istream &f) |
| bool | parse (const char *const filename) |
| Public Member Functions inherited from stir::TimedObject | |
| void | reset_timers () |
| reset all timers kept by this object | |
| void | stop_timers () const |
| stop all timers kept by this object More... | |
| void | start_timers (bool do_reset=false) const |
| start all timers kept by this object More... | |
| double | get_CPU_timer_value () const |
| get current value of the CPU timer (since first use or last reset) | |
| double | get_wall_clock_timer_value () const |
| get current value of the wall-clock timer (since first use or last reset) | |
Static Public Attributes | |
| static const char *const | registered_name |
Additional Inherited Members | |
| Static Public Member Functions inherited from stir::RegisteredParsingObject< SeparableCartesianMetzImageFilter< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > > | |
| static DataProcessor< DiscretisedDensity< 3, elemT > > * | read_from_stream (std::istream *) |
| Construct a new object (of type Derived) by parsing the istream. More... | |
| Static Public Member Functions inherited from stir::RegisteredObject< Root > | |
| static Root * | read_registered_object (std::istream *in, const std::string ®istered_name) |
| Construct a new object (of a type derived from Root, its actual type determined by the registered_name parameter) by parsing the istream. More... | |
| static Root * | ask_type_and_parameters () |
| ask the user for the type, and then calls read_registered_object(0, type) More... | |
| static void | list_registered_names (std::ostream &stream) |
| List all possible registered names to the stream. More... | |
| Protected Types inherited from stir::RegisteredObject< Root > | |
| typedef Root *(* | RootFactory) (std::istream *) |
| The type of a root factory is a function, taking an istream* as argument, and returning a Root*. | |
| typedef FactoryRegistry< std::string, RootFactory, interfile_less > | RegistryType |
| The type of the registry. | |
| Protected Member Functions inherited from stir::DataProcessor< DiscretisedDensity< 3, elemT > > | |
| virtual Succeeded | virtual_set_up (const DiscretisedDensity< 3, elemT > &)=0 |
| Will be called to build any internal parameters. | |
| virtual void | virtual_apply (DiscretisedDensity< 3, elemT > &data, const DiscretisedDensity< 3, elemT > &in_data) const=0 |
| Performs actual operation (virtual_set_up is called before this function) | |
| virtual void | virtual_apply (DiscretisedDensity< 3, elemT > &data) const=0 |
| Performs actual operation (in-place) | |
| Protected Member Functions inherited from stir::ParsingObject | |
| virtual bool | post_processing () |
| This will be called at the end of the parsing. More... | |
| virtual void | set_key_values () |
| This will be called before parsing or parameter_info is called. More... | |
| Static Protected Member Functions inherited from stir::RegisteredObject< Root > | |
| static RegistryType & | registry () |
| Static function returning the registry. More... | |
| Protected Attributes inherited from stir::ParsingObject | |
| KeyParser | parser |
Detailed Description
template<typename elemT>
class stir::SeparableCartesianMetzImageFilter< elemT >
A class in the DataProcessor hierarchy that implements Metz filtering (which includes Gaussian filtering).
As it is derived from RegisteredParsingObject, it implements all the necessary things to parse parameter files etc.
The discretised densities that will be filtered are supposed to be on a Cartesian grid. The filtering operation is then performed as 3 separate 1d filters in every direction.
- Warning
- This class is currently restricted to 3d. This is mainly because of the difficulty to give sensible names to the parameters used for parsing in n dimensions.
- See also
- SeparableMetzArrayFilter for what a Metz filter is
Member Function Documentation
◆ get_max_kernel_sizes()
template<typename elemT >
| VectorWithOffset< int > stir::SeparableCartesianMetzImageFilter< elemT >::get_max_kernel_sizes | ( | ) | const |
Maximum number of elements in the kernels.
-1 means unrestricted
References stir::KeyParser::add_key(), stir::KeyParser::add_start_key(), stir::KeyParser::add_stop_key(), stir::VectorWithOffset< T >::fill(), stir::ParsingObject::initialise_keymap(), and stir::ParsingObject::set_defaults().
The documentation for this class was generated from the following files:
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/SeparableCartesianMetzImageFilter.h
- /home/sirfuser/devel/STIRdistrib/STIR/src/buildblock/SeparableCartesianMetzImageFilter.cxx
