Protected Types | Protected Member Functions
C2DFifoFilterPlugin Class Reference

The plug-in base class for the FIFO filters. More...

#include <mia/3d/2dimagefifofilter.hh>

Inheritance diagram for C2DFifoFilterPlugin:
Inheritance graph
[legend]
Collaboration diagram for C2DFifoFilterPlugin:
Collaboration graph
[legend]

Protected Types

typedef std::vector< P2DImageCImageStack
 helper class to store a set of images More...
 

Protected Member Functions

 C2DFifoFilterPlugin (char const *const name)
 
bool call_test (const CImageStack &in_data, const CImageStack &test_data, C2DImageFifoFilter &filter) const
 

Additional Inherited Members

- Public Types inherited from TFactory< C2DImageFifoFilter >
typedef C2DImageFifoFilter Product
 typedef to describe the product of the factory More...
 
typedef std::shared_ptr
< C2DImageFifoFilter
SharedProduct
 typedef for the shared version of the product More...
 
typedef std::unique_ptr
< C2DImageFifoFilter
UniqueProduct
 typedef for the unique version of the product More...
 
- Public Types inherited from TPlugin< C2DImageFifoFilter::plugin_data, C2DImageFifoFilter::plugin_type >
typedef
C2DImageFifoFilter::plugin_data 
PlugData
 Typedef for the data type descriptor handled by this plug-in. More...
 
typedef
C2DImageFifoFilter::plugin_type 
PlugType
 Typedef for the plugin type descriptor handled by this plug-in. More...
 
- Public Member Functions inherited from TFactory< C2DImageFifoFilter >
virtual Productcreate (const CParsedOptions &options, char const *params) __attribute__((warn_unused_result))
 
 TFactory (char const *const name)
 
- Public Member Functions inherited from TPlugin< C2DImageFifoFilter::plugin_data, C2DImageFifoFilter::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_parameter (const std::string &name, CParameter *param)
 
void add_property (const char *property)
 
void append_interface (CPluginBase *plugin)
 
void check_parameters ()
 
 CPluginBase (const char *name)
 
const std::string get_descr () const
 
void get_help_xml (xmlpp::Element &root) const
 
PPluginModule get_module () const
 
const char * get_name () const
 
void get_short_help (std::ostream &os) const
 
bool has_property (const char *property) const
 
CPluginBasenext_interface ()
 
void set_module (const PPluginModule &module)
 
void set_parameters (const CParsedOptions &options)
 
virtual ~CPluginBase ()
 
- Static Public Member Functions inherited from TPlugin< C2DImageFifoFilter::plugin_data, C2DImageFifoFilter::plugin_type >
::boost::filesystem::path search_path ()
 

Detailed Description

The plug-in base class for the FIFO filters.

Definition at line 113 of file 2dimagefifofilter.hh.

Member Typedef Documentation

typedef std::vector<P2DImage> C2DFifoFilterPlugin::CImageStack
protected

helper class to store a set of images

Definition at line 123 of file 2dimagefifofilter.hh.

Constructor & Destructor Documentation

C2DFifoFilterPlugin::C2DFifoFilterPlugin ( char const *const  name)
protected

Plugin constructor

Parameters
nameName of the filter

Member Function Documentation

bool C2DFifoFilterPlugin::call_test ( const CImageStack in_data,
const CImageStack test_data,
C2DImageFifoFilter filter 
) const
protected

Helper function to run tests on stack filters

Parameters
in_datathe input data
test_datathe expected filter result
filterthe filter to be run (usually the same as handled by the plug-in
Returns
true if the filter provided the expected results, false otherwiese
Remarks
this should be a stand-alone function that is implemented in the test library

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