Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mirtk::RadialErrorFunction Class Referenceabstract

#include <RadialErrorFunction.h>

Inheritance diagram for mirtk::RadialErrorFunction:
Inheritance graph
Collaboration diagram for mirtk::RadialErrorFunction:
Collaboration graph

Public Types

enum  TypeId {
  Unknown, Distance, Squared, Gaussian,
  Charbonnier, PeronaMalik
}
 Enumeration of available error functions. More...
 

Public Member Functions

virtual double Derivative (double d) const =0
 
virtual RadialErrorFunctionNewInstance () const =0
 Copy construct a new instance.
 
virtual TypeId Type () const =0
 Type enumeration value.
 
virtual double Value (double d) const =0
 
virtual ~RadialErrorFunction ()=0
 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.
 
virtual ParameterList Parameter () const
 Get parameter name/value pairs.
 
bool Parameter (const ParameterList &)
 Set parameters from name/value pairs.
 
virtual bool Set (const char *name, const char *value)
 
virtual ~Object ()
 Destructor.
 

Static Public Member Functions

static RadialErrorFunctionNew (TypeId)
 Construct a new instance of specified type.
 
static RadialErrorFunctionNew (const char *)
 Construct a new instance of specified type.
 
- Static Public Member Functions inherited from mirtk::Object
static const char * NameOfType ()
 Get name of this class type.
 

Protected Member Functions

 RadialErrorFunction ()
 Constructor.
 
- Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void Throw (ErrorType err, const char *func, Args... args) const
 

Additional Inherited Members

- Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)
 

Detailed Description

Abstract radial fiducial registration error (FRE) function

Definition at line 32 of file RadialErrorFunction.h.

Member Enumeration Documentation

§ TypeId

Enumeration of available error functions.

Enumerator
Unknown 

Unknown/invalid/default function.

Distance 

(Euclidean) distance

Squared 

Squared (Euclidean) distance.

Gaussian 

Gaussian error function.

Charbonnier 

Charbonnier fiducial registration error.

PeronaMalik 

Perona-Malik fiducial registration error.

Definition at line 44 of file RadialErrorFunction.h.

Member Function Documentation

§ Derivative()

virtual double mirtk::RadialErrorFunction::Derivative ( double  d) const
pure virtual

Evaluate derivative of radial registration error

Parameters
[in]dSquared (Euclidean) distance.

Implemented in mirtk::GaussianErrorFunction, mirtk::PeronaMalikErrorFunction, mirtk::CharbonnierErrorFunction, mirtk::DistanceErrorFunction, and mirtk::SquaredErrorFunction.

§ Value()

virtual double mirtk::RadialErrorFunction::Value ( double  d) const
pure virtual

Evaluate radial registration error

Parameters
[in]dSquared (Euclidean) distance.

Implemented in mirtk::GaussianErrorFunction, mirtk::PeronaMalikErrorFunction, mirtk::CharbonnierErrorFunction, mirtk::DistanceErrorFunction, and mirtk::SquaredErrorFunction.


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