fw4spl
fwDicomIOFilter::modifier::SliceThicknessModifier Class Reference

Filter that uses the ImagepositionPatient tag to sort the instances. The position increases along the direction given by cross product of the ImageOrientationPatient vectors. More...

#include <SliceThicknessModifier.hpp>

+ Inheritance diagram for fwDicomIOFilter::modifier::SliceThicknessModifier:
+ Collaboration diagram for fwDicomIOFilter::modifier::SliceThicknessModifier:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWDICOMIOFILTER_API SliceThicknessModifier (::fwDicomIOFilter::IFilter::Key key)
 Constructor.
 
virtual FWDICOMIOFILTER_API ~SliceThicknessModifier ()
 Destructor.
 
virtual FWDICOMIOFILTER_API DicomSeriesContainerType apply (const ::fwMedData::DicomSeries::sptr &series, const ::fwLog::Logger::sptr &logger) const override
 Override.
 
virtual FWDICOMIOFILTER_API std::string getName () const override
 Return the name of the filter.
 
virtual FWDICOMIOFILTER_API std::string getDescription () const override
 Return the description of the filter.
 
- Public Member Functions inherited from fwDicomIOFilter::modifier::IModifier
virtual FWDICOMIOFILTER_API ~IModifier ()
 Destructor.
 
FWDICOMIOFILTER_API FilterType getFilterType () const override
 Return filter type.
 
- Public Member Functions inherited from fwDicomIOFilter::IFilter
virtual FWDICOMIOFILTER_API ~IFilter ()
 Destructor.
 
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

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwDicomIOFilter::modifier::IModifier
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 fwDicomIOFilter::IFilter
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 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

virtual FWDICOMIOFILTER_API double getInstanceZPosition (const ::fwMemory::BufferObject::sptr &bufferObj) const
 Compute the Z coordinate of the slice according to the ImagePositionPatient and ImageOrientationPatient tags. More...
 
virtual FWDICOMIOFILTER_API double getSliceThickness (const ::fwMemory::BufferObject::sptr &bufferObj) const
 Get the SliceThickness value from an instance. More...
 
- Protected Member Functions inherited from fwDicomIOFilter::modifier::IModifier
FWDICOMIOFILTER_API IModifier ()
 Constructor.
 
- Protected Member Functions inherited from fwDicomIOFilter::IFilter
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.
 

Static Protected Attributes

static const std::string s_FILTER_NAME = "Slice thickness modifier"
 Filter name.
 
static const std::string s_FILTER_DESCRIPTION
 Filter description. More...
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
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
 

Additional Inherited Members

- Public Types inherited from fwDicomIOFilter::IFilter
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
 
- 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::ObjectgetObject (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::UUIDm_uuid
 UUID used to identify the object, notably for serialization.
 

Detailed Description

Filter that uses the ImagepositionPatient tag to sort the instances. The position increases along the direction given by cross product of the ImageOrientationPatient vectors.

Definition at line 23 of file SliceThicknessModifier.hpp.

Member Function Documentation

double fwDicomIOFilter::modifier::SliceThicknessModifier::getInstanceZPosition ( const ::fwMemory::BufferObject::sptr &  bufferObj) const
protectedvirtual

Compute the Z coordinate of the slice according to the ImagePositionPatient and ImageOrientationPatient tags.

Parameters
[in]bufferObjBufferObject containing the slice

Definition at line 103 of file SliceThicknessModifier.cpp.

References fwMemory::BufferObject::LockBase< T >::getBuffer().

Referenced by apply().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double fwDicomIOFilter::modifier::SliceThicknessModifier::getSliceThickness ( const ::fwMemory::BufferObject::sptr &  bufferObj) const
protectedvirtual

Get the SliceThickness value from an instance.

Parameters
[in]bufferObjBufferObject containing the slice

Definition at line 158 of file SliceThicknessModifier.cpp.

References fwMemory::BufferObject::LockBase< T >::getBuffer().

Referenced by apply().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

const std::string fwDicomIOFilter::modifier::SliceThicknessModifier::s_FILTER_DESCRIPTION
staticprotected
Initial value:
=
"Compute and modify slice thickness using <i>ImagePositionPatient</i> "
"and <i>ImageOrientationPatient</i> tags of the two first instances."

Filter description.

Definition at line 63 of file SliceThicknessModifier.hpp.

Referenced by getDescription().


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