A class in the DataProcessor hierarchy for making sure all elements are strictly positive. More...
#include "stir/ThresholdMinToSmallPositiveValueDataProcessor.h"
Inheritance diagram for stir::ThresholdMinToSmallPositiveValueDataProcessor< DataT >:
Public Member Functions | |
| ThresholdMinToSmallPositiveValueDataProcessor () | |
| Construct by calling set_defaults() | |
 Public Member Functions inherited from stir::RegisteredParsingObject< ThresholdMinToSmallPositiveValueDataProcessor< DataT >, DataProcessor< DataT >, DataProcessor< DataT > > | |
| 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< DataT > | |
| Succeeded | set_up (const DataT &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 (DataT &data) |
| Calls set_up() (if not already done before) and process data in-place. More... | |
| Succeeded | apply (DataT &out_data, const DataT &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 = "Threshold Min To Small Positive Value" |
Additional Inherited Members | |
| Static Public Member Functions inherited from stir::RegisteredParsingObject< ThresholdMinToSmallPositiveValueDataProcessor< DataT >, DataProcessor< DataT >, DataProcessor< DataT > > | |
| static DataProcessor< DataT > * | 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< DataProcessor< DataT > > | |
| static DataProcessor< DataT > * | 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 DataProcessor< DataT > * | 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< DataProcessor< DataT > > | |
| typedef DataProcessor< DataT > *(* | 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::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< DataProcessor< DataT > > | |
| static RegistryType & | registry () |
| Static function returning the registry. More... | |
| Protected Attributes inherited from stir::ParsingObject | |
| KeyParser | parser |
Detailed Description
template<typename DataT>
class stir::ThresholdMinToSmallPositiveValueDataProcessor< DataT >
A class in the DataProcessor hierarchy for making sure all elements are strictly positive.
Works by calling threshold_min_to_small_positive_value().
As it is derived from RegisteredParsingObject, it implements all the necessary things to parse parameter files etc.
- Parsing parameters
; if part of a larger parameter file, you'd probably have something like ; data processor type := Chained Data Processor Chained Data Processor Parameters:= Data Processor to apply first:= data_processor type ; parameters for first data processor Data Processor to apply second:=data_processor type ; parameters for second data processor END Chained Data Processor Parameters:=
The documentation for this class was generated from the following files:
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/ThresholdMinToSmallPositiveValueDataProcessor.h
- /home/sirfuser/devel/STIRdistrib/STIR/src/buildblock/ThresholdMinToSmallPositiveValueDataProcessor.cxx
