degate::ImageProcessorBase Class Reference

Abstract base class for an image processor. More...

#include <ImageProcessorBase.h>

Inheritance diagram for degate::ImageProcessorBase:

List of all members.

Public Member Functions
	ImageProcessorBase (std::string const &_name, std::string const &_description, bool _has_properties, std::type_info const &_type_in, std::type_info const &_type_out)
	The constructor for a plugin.
virtual	~ImageProcessorBase ()
	The destructor for a plugin.
std::string const &	get_name () const
	Get the processor's name.
std::string const &	get_description () const
	Get the processor's description.
virtual ImageBase_shptr	run (ImageBase_shptr _in)=0
	Start processing.
virtual bool	has_property () const
	Check if the processor can be configured.
Protected Member Functions
std::string const &	get_type_in () const
std::string const &	get_type_out () const
Private Attributes
const std::string	name
const std::string	description
const bool	has_properties
std::string	type_in
std::string	type_out
Friends
class	IPPipe

---

Detailed Description

Abstract base class for an image processor.

Definition at line 35 of file ImageProcessorBase.h.

---

Constructor & Destructor Documentation

degate::ImageProcessorBase::ImageProcessorBase	(	std::string const &	_name,
		std::string const &	_description,
		bool	_has_properties,
		std::type_info const &	_type_in,
		std::type_info const &	_type_out
	)		[inline]

The constructor for a plugin.

Parameters:

_name

The name of the plugin.

Definition at line 68 of file ImageProcessorBase.h.

                                                      :
      name(_name),
      description(_description),
      has_properties(_has_properties),
      type_in(_type_in.name()),
      type_out(_type_out.name()) {}

virtual degate::ImageProcessorBase::~ImageProcessorBase

(

)

[inline, virtual]

The destructor for a plugin.

Definition at line 83 of file ImageProcessorBase.h.

{}

---

Member Function Documentation

std::string const& degate::ImageProcessorBase::get_description

(

)

const [inline]

Get the processor's description.

Definition at line 98 of file ImageProcessorBase.h.

References description.

                                             {
      return description;
    }

std::string const& degate::ImageProcessorBase::get_name

(

)

const [inline]

Get the processor's name.

Definition at line 90 of file ImageProcessorBase.h.

References name.

                                      {
      return name;
    }

std::string const& degate::ImageProcessorBase::get_type_in

(

)

const [inline, protected]

Definition at line 52 of file ImageProcessorBase.h.

References type_in.

                                         {
      return type_in;
    }

std::string const& degate::ImageProcessorBase::get_type_out

(

)

const [inline, protected]

Definition at line 56 of file ImageProcessorBase.h.

References type_out.

                                          {
      return type_out;
    }

virtual bool degate::ImageProcessorBase::has_property

(

)

const [inline, virtual]

Check if the processor can be configured.

Definition at line 111 of file ImageProcessorBase.h.

References has_properties.

                                      {
      return has_properties;
    }

virtual ImageBase_shptr degate::ImageProcessorBase::run

(

ImageBase_shptr

_in

)

[pure virtual]

Start processing.

Implemented in degate::IPConvolve< ImageTypeIn, ImageTypeOut >, degate::IPCopy< ImageTypeIn, ImageTypeOut >, degate::IPImageWriter< ImageType >, degate::IPMedianFilter< ImageTypeIn, ImageTypeOut >, degate::IPNormalize< ImageTypeIn, ImageTypeOut >, and degate::IPThresholding< ImageTypeIn, ImageTypeOut >.

---

Friends And Related Function Documentation

friend class IPPipe [friend]

Definition at line 37 of file ImageProcessorBase.h.

---

Member Data Documentation

const std::string degate::ImageProcessorBase::description [private]

Definition at line 42 of file ImageProcessorBase.h.

Referenced by get_description().

const bool degate::ImageProcessorBase::has_properties [private]

Definition at line 44 of file ImageProcessorBase.h.

Referenced by has_property().

const std::string degate::ImageProcessorBase::name [private]

Definition at line 41 of file ImageProcessorBase.h.

Referenced by get_name().

std::string degate::ImageProcessorBase::type_in [private]

Definition at line 46 of file ImageProcessorBase.h.

Referenced by get_type_in().

std::string degate::ImageProcessorBase::type_out [private]

Definition at line 47 of file ImageProcessorBase.h.

Referenced by get_type_out().

---

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

• ImageProcessorBase.h