STIR  6.2.0
Public Member Functions | List of all members
stir::RegisteredObjectBase Class Referenceabstract

Base class for all classes that can parse .par files (and more?)The only reason that this class exists is such that KeyParser can store different types of objects, and get some basic info from it. More...

#include "stir/RegisteredObjectBase.h"

Inheritance diagram for stir::RegisteredObjectBase:
Inheritance graph
[legend]

Public Member Functions

virtual std::string get_registered_name () const =0
 Returns the name of the type of the object. More...
 
- Public Member Functions inherited from stir::ParsingObject
 ParsingObject (const ParsingObject &)
 
ParsingObjectoperator= (const ParsingObject &)
 
void ask_parameters ()
 
virtual std::string parameter_info ()
 
bool parse (std::istream &f)
 
bool parse (const char *const filename)
 

Additional Inherited Members

- Protected Member Functions inherited from stir::ParsingObject
virtual void set_defaults ()
 Set defaults before parsing.
 
virtual void initialise_keymap ()
 Initialise all keywords.
 
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...
 
- Protected Attributes inherited from stir::ParsingObject
KeyParser parser
 

Detailed Description

Base class for all classes that can parse .par files (and more?)

The only reason that this class exists is such that KeyParser can store different types of objects, and get some basic info from it.

See also
RegisteredObject for more info on the registries etc that are used for parsing..

Member Function Documentation

◆ get_registered_name()

virtual std::string stir::RegisteredObjectBase::get_registered_name ( ) const
pure virtual

Returns the name of the type of the object.

Each type that can be parsed has a unique (within its hierarchy) name associated with it. This function returns that name. KeyParser::parameter_info() needs to know this name such that it can fill it in.

Implemented in stir::RegisteredParsingObject< BackProjectorByBinParallelproj, BackProjectorByBin >, stir::RegisteredParsingObject< AbsTimeIntervalWithParsing, AbsTimeInterval, AbsTimeInterval >, stir::RegisteredParsingObject< RelativeDifferencePrior< elemT >, GeneralisedPrior< DiscretisedDensity< 3, elemT > >, GeneralisedPrior< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< SeparableLowPassImageFilter< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< Ellipsoid, Shape3D, Shape3DWithOrientation >, stir::RegisteredParsingObject< FourierRebinning, ProjDataRebinning, ProjDataRebinning >, stir::RegisteredParsingObject< EllipsoidalCylinder, Shape3D, Shape3DWithOrientation >, stir::RegisteredParsingObject< MultiDynamicDiscretisedDensityOutputFileFormat, OutputFileFormat< DynamicDiscretisedDensity >, OutputFileFormat< DynamicDiscretisedDensity > >, stir::RegisteredParsingObject< GatedSpatialTransformation, SpatialTransformation >, stir::RegisteredParsingObject< InterfileOutputFileFormat, OutputFileFormat< DiscretisedDensity< 3, float > >, OutputFileFormat< DiscretisedDensity< 3, float > > >, stir::RegisteredParsingObject< ProjMatrixByBinUsingInterpolation, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< ProjMatrixByBinUsingRayTracing, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< ProjMatrixByDenselUsingRayTracing, ProjMatrixByDenselOnCartesianGridUsingElement >, stir::RegisteredParsingObject< ECAT6OutputFileFormat, OutputFileFormat< DiscretisedDensity< 3, float > >, OutputFileFormat< DiscretisedDensity< 3, float > > >, stir::RegisteredParsingObject< NonRigidObjectTransformationUsingBSplines< num_dimensions, elemT >, ObjectTransformation< num_dimensions, elemT >, ObjectTransformation< num_dimensions, elemT > >, stir::RegisteredParsingObject< ProjectorByBinPairUsingSeparateProjectors, ProjectorByBinPair, ProjectorByBinPair >, stir::RegisteredParsingObject< Box3D, Shape3D, Shape3DWithOrientation >, stir::RegisteredParsingObject< ITKOutputFileFormat, OutputFileFormat< DiscretisedDensity< 3, float > >, OutputFileFormat< DiscretisedDensity< 3, float > > >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearModelForMeanAndProjData< TargetT >, GeneralisedObjectiveFunction< TargetT >, PoissonLogLikelihoodWithLinearModelForMean< TargetT > >, stir::RegisteredParsingObject< AbsTimeIntervalFromDynamicData, AbsTimeInterval, AbsTimeInterval >, stir::RegisteredParsingObject< ECAT7ParametricDensityOutputFileFormat< DiscretisedDensityT >, OutputFileFormat< ParametricDiscretisedDensity< DiscretisedDensityT > >, OutputFileFormat< ParametricDiscretisedDensity< DiscretisedDensityT > > >, stir::RegisteredParsingObject< PostsmoothingBackProjectorByBin, BackProjectorByBin >, stir::RegisteredParsingObject< ECAT7OutputFileFormat, OutputFileFormat< DiscretisedDensity< 3, float > >, OutputFileFormat< DiscretisedDensity< 3, float > > >, stir::RegisteredParsingObject< ProjMatrixByBinUsingSolidAngle, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< PresmoothingForwardProjectorByBin, ForwardProjectorByBin >, stir::RegisteredParsingObject< QuadraticPrior< float >, GeneralisedPrior< DiscretisedDensity< 3, float > >, PriorWithParabolicSurrogate< DiscretisedDensity< 3, float > > >, stir::RegisteredParsingObject< ChainedBinNormalisation, BinNormalisation >, stir::RegisteredParsingObject< SingleScatterSimulation, ScatterSimulation, ScatterSimulation >, stir::RegisteredParsingObject< PLSPrior< elemT >, GeneralisedPrior< DiscretisedDensity< 3, elemT > >, GeneralisedPrior< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< ForwardProjectorByBinParallelproj, ForwardProjectorByBin >, stir::RegisteredParsingObject< ProjectorByBinPairUsingParallelproj, ProjectorByBinPair, ProjectorByBinPair >, stir::RegisteredParsingObject< BinNormalisationFromECAT7, BinNormalisation, BinNormalisationWithCalibration >, stir::RegisteredParsingObject< NonseparableConvolutionUsingRealDFTImageFilter< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< BinNormalisationFromML2D, BinNormalisation >, stir::RegisteredParsingObject< BinNormalisationSPECT, BinNormalisation, BinNormalisationWithCalibration >, stir::RegisteredParsingObject< CombinedShape3D, Shape3D, Shape3D >, stir::RegisteredParsingObject< TrivialBinNormalisation, BinNormalisation >, stir::RegisteredParsingObject< SeparableCartesianMetzImageFilter< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< RigidObject3DMotionFromPolaris, RigidObject3DMotion, RigidObject3DMotion >, stir::RegisteredParsingObject< BackProjectorByBinUsingSquareProjMatrixByBin, BackProjectorByBin >, stir::RegisteredParsingObject< BinNormalisationFromGEHDF5, BinNormalisation, BinNormalisationWithCalibration >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearModelForMeanAndListModeDataWithProjMatrixByBin< TargetT >, GeneralisedObjectiveFunction< TargetT >, PoissonLogLikelihoodWithLinearModelForMeanAndListModeData< TargetT > >, stir::RegisteredParsingObject< CudaRelativeDifferencePrior< elemT >, GeneralisedPrior< DiscretisedDensity< 3, elemT > >, RelativeDifferencePrior< elemT > >, stir::RegisteredParsingObject< DAVImageFilter3D< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< BinNormalisationFromProjData, BinNormalisation >, stir::RegisteredParsingObject< SinglesRatesFromSglFile, SinglesRates, SinglesRatesForTimeSlices >, stir::RegisteredParsingObject< ThresholdMinToSmallPositiveValueDataProcessor< DataT >, DataProcessor< DataT >, DataProcessor< DataT > >, stir::RegisteredParsingObject< DiscretisedShape3D, Shape3D, Shape3D >, stir::RegisteredParsingObject< InputStreamWithRecordsFromUPENNbin, InputStreamWithRecordsFromUPENN, InputStreamWithRecordsFromUPENN >, stir::RegisteredParsingObject< BackProjectorByBinUsingInterpolation, BackProjectorByBin >, stir::RegisteredParsingObject< ForwardProjectorByBinUsingRayTracing, ForwardProjectorByBin >, stir::RegisteredParsingObject< QuadraticPrior< elemT >, GeneralisedPrior< DiscretisedDensity< 3, elemT > >, PriorWithParabolicSurrogate< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< BinNormalisationFromECAT8, BinNormalisation, BinNormalisationWithCalibration >, stir::RegisteredParsingObject< MaximalImageFilter3D< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< FBP2DReconstruction, Reconstruction< DiscretisedDensity< 3, float > >, AnalyticReconstruction >, stir::RegisteredParsingObject< ProjMatrixByBinSPECTUB, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< ProjectorByBinPairUsingProjMatrixByBin, ProjectorByBinPair, ProjectorByBinPair >, stir::RegisteredParsingObject< PostsmoothingForwardProjectorByBin, ForwardProjectorByBin >, stir::RegisteredParsingObject< Transform3DObjectImageProcessor< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< ProjMatrixByBinFromFile, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< ProjMatrixByBinSinglePhoton, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< BackProjectorByBinUsingProjMatrixByBin, BackProjectorByBin >, stir::RegisteredParsingObject< ForwardProjectorByBinNiftyPET, ForwardProjectorByBin >, stir::RegisteredParsingObject< FBP3DRPReconstruction, Reconstruction< DiscretisedDensity< 3, float > >, AnalyticReconstruction >, stir::RegisteredParsingObject< ForwardProjectorByBinUsingProjMatrixByBin, ForwardProjectorByBin >, stir::RegisteredParsingObject< ChainedDataProcessor< DataT >, DataProcessor< DataT >, DataProcessor< DataT > >, stir::RegisteredParsingObject< FilterRootPrior< DataT >, GeneralisedPrior< DataT >, GeneralisedPrior< DataT > >, stir::RegisteredParsingObject< NonseparableSpatiallyVaryingFilters< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< OSMAPOSLReconstruction< TargetT >, Reconstruction< TargetT >, IterativeReconstruction< TargetT > >, stir::RegisteredParsingObject< InputStreamFromROOTFileForCylindricalPET, InputStreamFromROOTFile, InputStreamFromROOTFile >, stir::RegisteredParsingObject< ProjMatrixByBinPinholeSPECTUB, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< SeparableConvolutionImageFilter< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< TruncateToCylindricalFOVImageProcessor< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< BinNormalisationSinogramRescaling, BinNormalisation >, stir::RegisteredParsingObject< BackProjectorByBinNiftyPET, BackProjectorByBin >, stir::RegisteredParsingObject< ECAT7DynamicDiscretisedDensityOutputFileFormat, OutputFileFormat< DynamicDiscretisedDensity >, OutputFileFormat< DynamicDiscretisedDensity > >, stir::RegisteredParsingObject< AbsTimeIntervalFromECAT7ACF, AbsTimeInterval, AbsTimeInterval >, stir::RegisteredParsingObject< SinglesRatesFromECAT7, SinglesRates, SinglesRatesForTimeFrames >, stir::RegisteredParsingObject< SeparableGaussianImageFilter< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< LogcoshPrior< elemT >, GeneralisedPrior< DiscretisedDensity< 3, elemT > >, PriorWithParabolicSurrogate< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< KOSMAPOSLReconstruction< TargetT >, Reconstruction< TargetT >, OSMAPOSLReconstruction< TargetT > >, stir::RegisteredParsingObject< MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > >, stir::RegisteredParsingObject< BinNormalisationUsingProfile, BinNormalisation >, stir::RegisteredParsingObject< OSSPSReconstruction< TargetT >, Reconstruction< TargetT >, IterativeReconstruction< TargetT > >, stir::RegisteredParsingObject< InterfileParametricDiscretisedDensityOutputFileFormat< DiscDensityT >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > >, stir::RegisteredParsingObject< RigidObject3DTransformation, ObjectTransformation< 3, float >, ObjectTransformation< 3, float > >, stir::RegisteredParsingObject< ModifiedInverseAverigingImageFilter< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< PatlakPlot, KineticModel >, stir::RegisteredParsingObject< InputStreamWithRecordsFromUPENNtxt, InputStreamWithRecordsFromUPENN, InputStreamWithRecordsFromUPENN >, stir::RegisteredParsingObject< HUToMuImageProcessor< TargetT >, DataProcessor< TargetT >, DataProcessor< TargetT > >, stir::RegisteredParsingObject< BinNormalisationFromAttenuationImage, BinNormalisation >, stir::RegisteredParsingObject< ProjectorByBinPairUsingNiftyPET, ProjectorByBinPair, ProjectorByBinPair >, stir::RegisteredParsingObject< multiply_plane_scale_factorsImageProcessor< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< NonseparableSpatiallyVaryingFilters3D< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< ParametricQuadraticPrior< TargetT >, GeneralisedPrior< TargetT >, PriorWithParabolicSurrogate< TargetT > >, stir::RegisteredParsingObject< MedianImageFilter3D< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearModelForMeanAndDynamicProjData< TargetT >, GeneralisedObjectiveFunction< TargetT >, PoissonLogLikelihoodWithLinearModelForMean< TargetT > >, stir::RegisteredParsingObject< ProjMatrixByBinWithPositronRange, ProjMatrixByBin, ProjMatrixByBin >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearModelForMeanAndGatedProjDataWithMotion< TargetT >, GeneralisedObjectiveFunction< TargetT >, SumOfGeneralisedObjectiveFunctions< PoissonLogLikelihoodWithLinearModelForMeanAndProjData< TargetT >, TargetT, PoissonLogLikelihoodWithLinearModelForMean< TargetT > > >, stir::RegisteredParsingObject< SinglesRatesFromGEHDF5, SinglesRates, SinglesRatesForTimeSlices >, stir::RegisteredParsingObject< MinimalImageFilter3D< elemT >, DataProcessor< DiscretisedDensity< 3, elemT > >, DataProcessor< DiscretisedDensity< 3, elemT > > >, stir::RegisteredParsingObject< InterfileDynamicDiscretisedDensityOutputFileFormat, OutputFileFormat< DynamicDiscretisedDensity >, OutputFileFormat< DynamicDiscretisedDensity > >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearKineticModelAndDynamicProjectionData< TargetT >, GeneralisedObjectiveFunction< TargetT >, PoissonLogLikelihoodWithLinearModelForMean< TargetT > >, stir::RegisteredParsingObject< ModifiedInverseAveragingImageFilterAll< elemT >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > >, DataProcessor< DiscretisedDensity< num_dimensions, elemT > > >, stir::RegisteredParsingObject< InputStreamFromROOTFileForECATPET, InputStreamFromROOTFile, InputStreamFromROOTFile >, stir::RegisteredParsingObject< PoissonLogLikelihoodWithLinearModelForMeanAndGatedProjDataWithMotion< TargetT >, GeneralisedObjectiveFunction< TargetT >, PoissonLogLikelihoodWithLinearModelForMean< TargetT > >, and stir::BinNormalisationPETFromComponents.


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