C3DRegTimeStepPlugin Class Reference

The plug-in class for the time-step class of time-marching registration algorithms. More...

#include <mia/3d/timestep.hh>

Inheritance diagram for C3DRegTimeStepPlugin:
[legend]
Collaboration diagram for C3DRegTimeStepPlugin:
[legend]

Public Member Functions

 C3DRegTimeStepPlugin (const char *name)
 Constructor to create the plug-in with its name. More...
 
- Public Member Functions inherited from TFactory< C3DRegTimeStep >
virtual Productcreate (const CParsedOptions &options, char const *params) __attribute__((warn_unused_result))
 
 TFactory (char const *const name)
 
- Public Member Functions inherited from TPlugin< C3DRegTimeStep ::plugin_data, C3DRegTimeStep ::plugin_type >
virtual void get_help (std::ostream &os) const
 
const std::string get_long_name () const
 
 TPlugin (const char *name)
 
- Public Member Functions inherited from CPluginBase
void add_dependend_handlers (HandlerHelpMap &handler_map)
 
void add_property (const char *property)
 
void append_interface (CPluginBase *plugin)
 
 CPluginBase (const char *name)
 
PPluginModule get_module () const
 
unsigned get_priority () const
 
bool has_property (const char *property) const
 
CPluginBasenext_interface ()
 
void set_module (const PPluginModule &module)
 
void set_priority (unsigned p)
 
virtual ~CPluginBase ()
 
- Public Member Functions inherited from CParamTranslator
void add_parameter (const std::string &name, CParameter *param)
 
void check_parameters ()
 
 CParamTranslator (const char *name)
 
virtual void do_get_help_xml (CXMLElement &root) const
 
const std::string get_descr () const
 
void get_help (std::ostream &os) const
 
void get_help_xml (CXMLElement &root) const
 
const char * get_name () const
 
void get_short_help (std::ostream &os) const
 
void set_parameters (const CParsedOptions &options)
 
virtual ~CParamTranslator ()
 

Protected Member Functions

float get_max_timestep () const
 
float get_min_timestep () const
 
- Protected Member Functions inherited from CParamTranslator
CParamListget_parameters ()
 

Additional Inherited Members

- Public Types inherited from TFactory< C3DRegTimeStep >
typedef C3DRegTimeStep Product
 typedef to describe the product of the factory More...
 
typedef std::shared_ptr< C3DRegTimeStepSharedProduct
 typedef for the shared version of the product More...
 
typedef std::unique_ptr< C3DRegTimeStepUniqueProduct
 typedef for the unique version of the product More...
 
- Public Types inherited from TPlugin< C3DRegTimeStep ::plugin_data, C3DRegTimeStep ::plugin_type >
typedef C3DRegTimeStep ::plugin_data PlugData
 Typedef for the data type descriptor handled by this plug-in. More...
 
typedef C3DRegTimeStep ::plugin_type PlugType
 Typedef for the plugin type descriptor handled by this plug-in. More...
 
- Static Public Member Functions inherited from TPlugin< C3DRegTimeStep ::plugin_data, C3DRegTimeStep ::plugin_type >
static const char * get_data_path_part ()
 
static const char * get_type_path_part ()
 

Detailed Description

The plug-in class for the time-step class of time-marching registration algorithms.

Definition at line 124 of file 3d/timestep.hh.

Constructor & Destructor Documentation

◆ C3DRegTimeStepPlugin()

C3DRegTimeStepPlugin::C3DRegTimeStepPlugin ( const char *  name)

Constructor to create the plug-in with its name.

Member Function Documentation

◆ get_max_timestep()

float C3DRegTimeStepPlugin::get_max_timestep ( ) const
protected
Returns
the maximum allowed time step

◆ get_min_timestep()

float C3DRegTimeStepPlugin::get_min_timestep ( ) const
protected
Returns
the minimal allowed time step

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