STIR  6.2.0
Public Member Functions | Static Public Attributes | List of all members
stir::TruncateToCylindricalFOVImageProcessor< elemT > Class Template Reference

A class in the DataProcessor hierarchy that sets voxels to 0 outside a given radius. More...

#include "stir/TruncateToCylindricalFOVImageProcessor.h"

Inheritance diagram for stir::TruncateToCylindricalFOVImageProcessor< elemT >:
Inheritance graph
[legend]

Public Member Functions

 TruncateToCylindricalFOVImageProcessor ()
 Default constructor.
 
void set_truncate_rim (const int truncate_rim)
 
int get_truncate_rim ()
 
void set_strictly_less_than_radius (const bool arg)
 
bool get_strictly_less_than_radius () const
 
template<>
const char *const registered_name
 
- Public Member Functions inherited from stir::RegisteredParsingObject< TruncateToCylindricalFOVImageProcessor< 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 &)
 
ParsingObjectoperator= (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< TruncateToCylindricalFOVImageProcessor< 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 &registered_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_lessRegistryType
 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< Root >
static RegistryTyperegistry ()
 Static function returning the registry. More...
 
- Protected Attributes inherited from stir::ParsingObject
KeyParser parser
 

Detailed Description

template<typename elemT>
class stir::TruncateToCylindricalFOVImageProcessor< elemT >

A class in the DataProcessor hierarchy that sets voxels to 0 outside a given radius.

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 documentation for this class was generated from the following files: