fwDicomIOFilter::IFilter Class Reference

Base class for Dicom instance filter. More...

#include <IFilter.hpp>

Inheritance diagram for fwDicomIOFilter::IFilter:

Collaboration diagram for fwDicomIOFilter::IFilter:

Classes
class	Registrar
	Class used to register a class factory in factory registry. This class defines also the object factory ( 'create' ) More...

Public Types
enum	FilterType {   MODIFIER = 0, SORTER = 1, SPLITTER = 2, COMPOSITE = 3,   CUSTOM = 4 }
	Filter types. More...
typedef ::fwDicomIOFilter::factory::Key	Key
typedef std::vector< ::fwMedData::DicomSeries::sptr >	DicomSeriesContainerType

Public Member Functions
virtual bool	isA (const std::string &type) const override
virtual FWDICOMIOFILTER_API	~IFilter ()
	Destructor.
virtual FWDICOMIOFILTER_API DicomSeriesContainerType	apply (const ::fwMedData::DicomSeries::sptr &series, const ::fwLog::Logger::sptr &logger) const =0
	Apply the filter. More...
virtual FWDICOMIOFILTER_API std::string	getName () const =0
	Return the name of the filter.
virtual FWDICOMIOFILTER_API std::string	getDescription () const =0
	Return the description of the filter.
virtual FWDICOMIOFILTER_API FilterType	getFilterType () const =0
	Return filter type.
virtual FWDICOMIOFILTER_API bool	isConfigurationRequired () const
	Return true if a configuration is required.
virtual FWDICOMIOFILTER_API bool	isConfigurableWithGUI () const
	Return true if the filter is configurable using GUI.
virtual FWDICOMIOFILTER_API void	configureWithGUI ()
	Configure the filter using GUI dialog.
Public Member Functions inherited from fwTools::Object
Public Member Functions inherited from fwCore::BaseObject
virtual const std::string &	getLeafClassname () const
	return object's classname without its namespace, i.e. BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)
Static Public Member Functions inherited from fwTools::Object
static bool	isTypeOf (const std::string &type)
static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject
Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Member Functions
FWDICOMIOFILTER_API	IFilter ()
	Constructor.
Protected Member Functions inherited from fwTools::fwID
FWTOOLS_API bool	hasID () const
	Return true if the object has an id set. More...
FWTOOLS_API IDType	getID (Policy policy=GENERATE) const
	Returns the id of the object. If it is not set and the policy value is. More...
virtual FWTOOLS_API void	setID (IDType newID)
	Set a newID for the object, (newID must not exist in fwID), the oldest one is released. More...
FWTOOLS_API void	resetID ()
	Release the id for the object. More...
	fwID ()
	Constructor : does nothing.
virtual const std::string &	getLeafClassname () const
	return object's classname without its namespace, i.e. BaseObject

Demangling methods
virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject
static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

Additional Inherited Members
Protected Types inherited from fwTools::fwID
enum	Policy { EMPTY = 1, GENERATE, MUST_EXIST }
typedef std::string	IDType
Static Protected Member Functions inherited from fwTools::fwID
static bool	isTypeOf (const std::string &type)
static FWTOOLS_API bool	exist (IDType _id)
static FWTOOLS_API std::shared_ptr< ::fwTools::Object >	getObject (IDType requestID)
	Retrieve the object attached to the given id. Return a null sptr if no correspondence exist. More...
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject
Protected Attributes inherited from fwTools::Object
std::shared_ptr< ::fwTools::UUID >	m_uuid
	UUID used to identify the object, notably for serialization.

Detailed Description

Base class for Dicom instance filter.

Definition at line 27 of file io/fwDicomIOFilter/include/fwDicomIOFilter/IFilter.hpp.

Member Enumeration Documentation

enum fwDicomIOFilter::IFilter::FilterType

Filter types.

Enumerator
SORTER	Modifier
SPLITTER	Sorter
COMPOSITE	Splitter
CUSTOM	Composite

Definition at line 56 of file io/fwDicomIOFilter/include/fwDicomIOFilter/IFilter.hpp.

Member Function Documentation

virtual FWDICOMIOFILTER_API DicomSeriesContainerType fwDicomIOFilter::IFilter::apply ( const ::fwMedData::DicomSeries::sptr &  series, const ::fwLog::Logger::sptr &  logger  ) const

pure virtual

Apply the filter.

Returns

Returns one or more Dicom Instance Group

Implemented in fwDicomIOFilter::composite::IComposite, fwDicomIOFilter::sorter::ImagePositionPatientSorter, fwDicomIOFilter::sorter::TagValueSorter, fwDicomIOFilter::splitter::ImagePositionPatientSplitter, fwDicomIOFilter::splitter::TagValueInstanceRemoveSplitter, fwDicomIOFilter::splitter::TagValueSplitter, fwDicomIOFilter::custom::DefaultDicomFilter, fwDicomIOFilter::modifier::SliceThicknessModifier, fwDicomIOFilter::splitter::ImageDimensionsSplitter, fwDicomIOFilter::splitter::SOPClassUIDSplitter, and fwDicomIOFilter::custom::NoFilter.

---

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

• io/fwDicomIOFilter/include/fwDicomIOFilter/IFilter.hpp
• io/fwDicomIOFilter/src/fwDicomIOFilter/IFilter.cpp