Public Member Functions | List of all members
mirtk::FiducialRegistrationError Class Reference

#include <FiducialRegistrationError.h>

Inheritance diagram for mirtk::FiducialRegistrationError:
Inheritance graph
Collaboration diagram for mirtk::FiducialRegistrationError:
Collaboration graph

Public Member Functions

 FiducialRegistrationError (const char *="", double=1.0)
 Constructor.
 
 FiducialRegistrationError (const FiducialRegistrationError &)
 Copy constructor.
 
FiducialRegistrationErroroperator= (const FiducialRegistrationError &)
 Assignment operator.
 
virtual ~FiducialRegistrationError ()
 Destructor.
 
- Public Member Functions inherited from mirtk::PointCorrespondenceDistance
bool DoEvaluateSourceError () const
 Whether to evaluate source to target error.
 
bool DoEvaluateTargetError () const
 Whether to evaluate target to source error.
 
virtual void Initialize ()
 Initialize error measure once input and parameters have been set.
 
PointCorrespondenceDistanceoperator= (const PointCorrespondenceDistance &)
 Assignment operator.
 
virtual ParameterList Parameter () const
 Get parameter key/value as string map.
 
 PointCorrespondenceDistance (const char *="", double=1.0)
 Constructor.
 
 PointCorrespondenceDistance (const PointCorrespondenceDistance &)
 Copy constructor.
 
virtual void Reinitialize ()
 Reinitialize error measure after change of input topology.
 
virtual void Update (bool=true)
 Update moving input points and internal state of distance measure.
 
virtual bool Upgrade ()
 Update energy term after convergence.
 
virtual void WriteDataSets (const char *, const char *, bool=true) const
 Write input of data fidelity term.
 
virtual void WriteGradient (const char *, const char *) const
 Write gradient of data fidelity term w.r.t each transformed input.
 
virtual ~PointCorrespondenceDistance ()
 Destructor.
 
- Public Member Functions inherited from mirtk::PointSetDistance
virtual ~PointSetDistance ()
 Destructor.
 
- Public Member Functions inherited from mirtk::DataFidelity
virtual ~DataFidelity ()
 Destructor.
 
- Public Member Functions inherited from mirtk::EnergyTerm
virtual enum EnergyMeasure EnergyMeasure () const =0
 Energy measure implemented by this term.
 
void Gradient (double *gradient, double step)
 
virtual void GradientStep (const double *gradient, double &min, double &max) const
 
double InitialValue ()
 Returns initial value of energy term.
 
void NormalizedGradient (double *gradient, double step)
 
string Prefix (const char *=NULL) const
 Prefix to be used for debug output files.
 
virtual void Print (Indent=0) const
 Print debug information.
 
virtual double RawValue (double) const
 
double RawValue ()
 
void ResetInitialValue ()
 Reset initial value of energy term.
 
void ResetValue ()
 Reset cached value of energy term.
 
double Value ()
 Evaluate energy term.
 
virtual ~EnergyTerm ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Configurable
string DefaultName () const
 
virtual bool Set (const char *, const char *)
 Set parameter value from string.
 
virtual ~Configurable ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Observable
void AddObserver (Observer &)
 Add observer.
 
void Broadcast (Event, const void *=NULL)
 Broadcast event to observers.
 
void ClearObservers ()
 Delete all observers.
 
void DeleteObserver (Observer &)
 Delete observer.
 
void NotifyObservers (Event, const void *=NULL)
 Notify all observers about given event if this object has changed.
 
int NumberOfObservers () const
 Number of current observers.
 
virtual ~Observable ()
 Destructor.
 
- Public Member Functions inherited from mirtk::Object
virtual const char * NameOfClass () const =0
 Get name of class, which this object is an instance of.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual ~Object ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from mirtk::PointSetDistance
typedef Vector3D< double > GradientType
 Type of gradient w.r.t a single transformed data point.
 
- Public Types inherited from mirtk::EnergyTerm
typedef ObjectFactory< enum EnergyMeasure, EnergyTermFactoryType
 Type of energy term factory.
 
- Static Public Member Functions inherited from mirtk::PointSetDistance
static PointSetDistanceNew (PointSetDistanceMeasure, const char *="", double=1.0)
 Instantiate specified similarity measure.
 
- Static Public Member Functions inherited from mirtk::EnergyTerm
static FactoryTypeFactory ()
 Get global energy term factory instance.
 
static EnergyTermNew (EnergyMeasure, const char *="", double=1.0)
 Construct new energy term.
 
static EnergyTermTryNew (EnergyMeasure, const char *="", double=1.0)
 Construct new energy term or return nullptr if term not available.
 
- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 
- Protected Member Functions inherited from mirtk::PointCorrespondenceDistance
virtual double Evaluate ()
 Evaluate unweighted energy term.
 
void EvaluateGradient (double *gradient, double step, double weight)
 
void ForwardEvent (Observable *, Event, const void *)
 Forward point correspondence map event.
 
 mirtkAttributeMacro (Array< int >, TargetSample)
 Indices of sampled target points.
 
 mirtkAttributeMacro (Array< int >, SourceSample)
 Indices of sampled source points.
 
 mirtkAttributeMacro (int, NumberOfUpdates)
 Number of invocations of Update modulo _UpdatePeriod.
 
 mirtkComponentMacro (PointCorrespondence, Correspondence)
 Point correspondence map.
 
 mirtkComponentMacro (RadialErrorFunction, ErrorFunction)
 Polydata registration error weight function.
 
 mirtkPublicAttributeMacro (double, TargetSampleDistance)
 Approximate distance between sampled target points.
 
 mirtkPublicAttributeMacro (double, SourceSampleDistance)
 Approximate distance between sampled source points.
 
 mirtkPublicAttributeMacro (int, NumberOfTargetSamples)
 Maximum number of target samples used.
 
 mirtkPublicAttributeMacro (int, NumberOfSourceSamples)
 Maximum number of target samples used.
 
 mirtkPublicAttributeMacro (int, UpdatePeriod)
 Number of Update calls between reevaluation of correspondences.
 
 mirtkPublicAttributeMacro (bool, EvaluateTargetError)
 Whether to evaluate error of target points and corresponding source points.
 
 mirtkPublicAttributeMacro (bool, EvaluateSourceError)
 Whether to evaluate error of source points and corresponding target points.
 
virtual void NonParametricGradient (const RegisteredPointSet *source, GradientType *gradient)
 
virtual void ParametricGradient (const RegisteredPointSet *source, const GradientType *np_gradient, double *gradient, double weight)
 
 PointCorrespondenceDistance (const char *, double, PointCorrespondence *, RadialErrorFunction *=NULL)
 Construct distance with given default point correspondence type and error function.
 
void SamplePoints ()
 Sample point sets.
 
virtual bool SetWithoutPrefix (const char *, const char *)
 Set parameter value from string.
 
virtual void WriteDataSet (const char *, const RegisteredPointSet *, const Array< int > &, const PointCorrespondence *) const
 Write given input data set to specified file.
 
- Protected Member Functions inherited from mirtk::PointSetDistance
void AllocateGradientWrtSource (int)
 Allocate memory for (non-parametric) gradient w.r.t points of source.
 
void AllocateGradientWrtTarget (int)
 Allocate memory for (non-parametric) gradient w.r.t points of target.
 
void CopyAttributes (const PointSetDistance &, int=-1, int=-1)
 Copy attributes from other point set distance measure.
 
void Initialize (int, int)
 Initialize distance measure once input and parameters have been set.
 
 mirtkAttributeMacro (bool, InitialUpdate)
 Whether Update has not been called since initialization.
 
 mirtkComponentMacro (GradientType, GradientWrtTarget)
 Memory for (non-parametric) gradient w.r.t points of target.
 
 mirtkComponentMacro (GradientType, GradientWrtSource)
 Memory for (non-parametric) gradient w.r.t points of source.
 
 mirtkPublicAggregateMacro (RegisteredPointSet, Target)
 First point set.
 
 mirtkPublicAggregateMacro (RegisteredPointSet, Source)
 Second point set.
 
PointSetDistanceoperator= (const PointSetDistance &)
 Assignment operator.
 
 PointSetDistance (const char *="", double=1.0)
 Constructor.
 
 PointSetDistance (const PointSetDistance &, int=-1, int=-1)
 Copy constructor.
 
void Reinitialize (int, int)
 
virtual void WriteGradient (const char *, const RegisteredPointSet *, const GradientType *, const Array< int > *=NULL) const
 Write gradient of data fidelity term w.r.t each transformed input.
 
- Protected Member Functions inherited from mirtk::DataFidelity
 DataFidelity (const char *="", double=1.0)
 Constructor.
 
 DataFidelity (const DataFidelity &)
 Copy constructor.
 
DataFidelityoperator= (const DataFidelity &)
 Assignment operator.
 
virtual bool SetWithPrefix (const char *, const char *)
 Set parameter value from string.
 
- Protected Member Functions inherited from mirtk::EnergyTerm
 EnergyTerm (const char *="", double=1.0)
 Constructor.
 
 EnergyTerm (const EnergyTerm &)
 Copy constructor.
 
EnergyTermoperator= (const EnergyTerm &)
 Assignment operator.
 
- Protected Member Functions inherited from mirtk::Configurable
 Configurable (const char *="")
 Constructor.
 
 Configurable (const Configurable &)
 Copy constructor.
 
string DefaultPrefix () const
 Get default object name prefix (if any)
 
bool HasName () const
 Whether this object has an explicit name.
 
bool HasPrefix () const
 Whether this object has either an explicit name or default prefix.
 
template<class T >
bool InsertWithPrefix (ParameterList &, string, T) const
 Insert parameter into name/value list with object name prefix.
 
bool InsertWithPrefix (ParameterList &, const ParameterList &) const
 Insert parameters into name/value list with object name prefix.
 
Configurableoperator= (const Configurable &)
 Assignment operator.
 
string ParameterNameWithoutPrefix (const char *) const
 Get name of parameter without object name prefix.
 
string ParameterNameWithPrefix (const string &) const
 Get name of parameter with default object name prefix.
 
string ParameterNameWithPrefix (const char *) const
 Get name of parameter with default object name prefix.
 
- Protected Member Functions inherited from mirtk::Observable
 Observable ()
 Default constructor.
 
 Observable (const Observable &)
 Copy constructor.
 
Observableoperator= (const Observable &)
 Assignment operator.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 
- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 
- Protected Attributes inherited from mirtk::PointCorrespondenceDistance
EventDelegate _EventDelegate
 Forwards correspondence map event messages to observers of energy term.
 

Detailed Description

Fiducial registration error (FRE) measure

Definition at line 32 of file FiducialRegistrationError.h.


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