MEPP2 Project
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GenericParametricModel< TParam, TIn, TOut > Class Template Referenceabstract

#include <genericparametricmodel.h>

Inheritance diagram for GenericParametricModel< TParam, TIn, TOut >:
Inheritance graph
Collaboration diagram for GenericParametricModel< TParam, TIn, TOut >:
Collaboration graph

Public Types

typedef TParam ParameterType
 
typedef TIn InputType
 
typedef TOut OutputType
 

Public Member Functions

 GenericParametricModel ()
 
 GenericParametricModel (const ParameterType &param)
 
virtual ~GenericParametricModel ()
 
void setParameters (const ParameterType &param)
 
const ParameterType & param () const
 
ParameterType & param ()
 
virtual void compute (const InputType &in, OutputType &out) const =0
 
OutputType compute (const InputType &in) const
 
void compute (const std::vector< InputType > &in, std::vector< OutputType > &out) const
 
OutputType operator() (const InputType &in) const
 
void operator() (const InputType &in, OutputType &out) const
 

Protected Member Functions

virtual void default_params ()=0
 sets default values to m_params More...
 

Protected Attributes

ParameterType m_param
 

Detailed Description

template<typename TParam, typename TIn = double, typename TOut = double>
class GenericParametricModel< TParam, TIn, TOut >

Definition at line 17 of file genericparametricmodel.h.

Member Typedef Documentation

◆ InputType

template<typename TParam , typename TIn = double, typename TOut = double>
typedef TIn GenericParametricModel< TParam, TIn, TOut >::InputType

Definition at line 24 of file genericparametricmodel.h.

◆ OutputType

template<typename TParam , typename TIn = double, typename TOut = double>
typedef TOut GenericParametricModel< TParam, TIn, TOut >::OutputType

Definition at line 25 of file genericparametricmodel.h.

◆ ParameterType

template<typename TParam , typename TIn = double, typename TOut = double>
typedef TParam GenericParametricModel< TParam, TIn, TOut >::ParameterType

Definition at line 23 of file genericparametricmodel.h.

Constructor & Destructor Documentation

◆ GenericParametricModel() [1/2]

template<typename TParam , typename TIn = double, typename TOut = double>
GenericParametricModel< TParam, TIn, TOut >::GenericParametricModel ( )
inline

Definition at line 30 of file genericparametricmodel.h.

◆ GenericParametricModel() [2/2]

template<typename TParam , typename TIn = double, typename TOut = double>
GenericParametricModel< TParam, TIn, TOut >::GenericParametricModel ( const ParameterType &  param)
inline

Definition at line 35 of file genericparametricmodel.h.

◆ ~GenericParametricModel()

template<typename TParam , typename TIn = double, typename TOut = double>
virtual GenericParametricModel< TParam, TIn, TOut >::~GenericParametricModel ( )
inlinevirtual

Definition at line 37 of file genericparametricmodel.h.

Member Function Documentation

◆ compute() [1/3]

template<typename TParam , typename TIn = double, typename TOut = double>
OutputType GenericParametricModel< TParam, TIn, TOut >::compute ( const InputType &  in) const
inline

Definition at line 55 of file genericparametricmodel.h.

◆ compute() [2/3]

template<typename TParam , typename TIn = double, typename TOut = double>
virtual void GenericParametricModel< TParam, TIn, TOut >::compute ( const InputType &  in,
OutputType &  out 
) const
pure virtual

Implemented in VisibilityModel, NWHWD16_Threshold, WeibulPsychometricFunction, BartenCSF, SarkisonCSF, and DalyMasking.

Here is the caller graph for this function:

◆ compute() [3/3]

template<typename TParam , typename TIn = double, typename TOut = double>
void GenericParametricModel< TParam, TIn, TOut >::compute ( const std::vector< InputType > &  in,
std::vector< OutputType > &  out 
) const
inline

Definition at line 63 of file genericparametricmodel.h.

◆ default_params()

template<typename TParam , typename TIn = double, typename TOut = double>
virtual void GenericParametricModel< TParam, TIn, TOut >::default_params ( )
protectedpure virtual

sets default values to m_params

Implemented in VisibilityModel, NWHWD16_Threshold, WeibulPsychometricFunction, BartenCSF, SarkisonCSF, and DalyMasking.

◆ operator()() [1/2]

template<typename TParam , typename TIn = double, typename TOut = double>
OutputType GenericParametricModel< TParam, TIn, TOut >::operator() ( const InputType &  in) const
inline

Definition at line 72 of file genericparametricmodel.h.

◆ operator()() [2/2]

template<typename TParam , typename TIn = double, typename TOut = double>
void GenericParametricModel< TParam, TIn, TOut >::operator() ( const InputType &  in,
OutputType &  out 
) const
inline

Definition at line 74 of file genericparametricmodel.h.

◆ param() [1/2]

template<typename TParam , typename TIn = double, typename TOut = double>
ParameterType& GenericParametricModel< TParam, TIn, TOut >::param ( )
inline

Definition at line 45 of file genericparametricmodel.h.

◆ param() [2/2]

template<typename TParam , typename TIn = double, typename TOut = double>
const ParameterType& GenericParametricModel< TParam, TIn, TOut >::param ( ) const
inline

Definition at line 44 of file genericparametricmodel.h.

Here is the caller graph for this function:

◆ setParameters()

template<typename TParam , typename TIn = double, typename TOut = double>
void GenericParametricModel< TParam, TIn, TOut >::setParameters ( const ParameterType &  param)
inline

Definition at line 42 of file genericparametricmodel.h.

Member Data Documentation

◆ m_param

template<typename TParam , typename TIn = double, typename TOut = double>
ParameterType GenericParametricModel< TParam, TIn, TOut >::m_param
protected

Definition at line 88 of file genericparametricmodel.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.20