Reads DICOM data from a directory path in order to create a SeriesDB object. More...

#include <SeriesDBReader.hpp>

Inheritance diagram for fwDcmtkIO::SeriesDBReader:

Collaboration diagram for fwDcmtkIO::SeriesDBReader:

Public Types
typedef std::map< std::string, std::shared_ptr< ::fwMedData::Patient > >	PatientMapType

typedef std::map< std::string, std::shared_ptr< ::fwMedData::Study > >	StudyMapType

typedef std::map< std::string, std::shared_ptr< ::fwMedData::Equipment > >	EquipmentMapType

typedef std::vector< std::shared_ptr< ::fwMedData::DicomSeries > >	DicomSeriesContainerType

typedef std::vector< std::string >	FilenameContainerType

typedef std::vector< std::string >	SupportedSOPClassContainerType

Public Types inherited from fwDataIO::reader::GenericObjectReader< ::fwMedData::SeriesDB >
typedef ::fwMedData::SeriesDB	DataType
	the object type related

Public Types inherited from fwDataIO::reader::IObjectReader
typedef std::function< void(std::uint64_t) >	ProgressCallback

typedef std::function< void() >	CancelCallback

typedef ::fwDataIO::reader::factory::Key	Key

Public Types inherited from fwTools::ProgressAdviser
typedef ::boost::signals2::signal< void(float, std::string) >	ProgessSignal
	define a boost signal signature for the ProgessHandler

typedef ProgessSignal::slot_type	ProgessHandler
	define the ProgessHandler type

Public Member Functions
virtual bool	isA (const std::string &type) const override

FWDCMTKIO_API	SeriesDBReader (::fwDataIO::reader::IObjectReader::Key key)

FWDCMTKIO_API void	read () override
	Reads DICOM data from configured path and fills SeriesDB object.

FWDCMTKIO_API void	readFromDicomSeriesDB (std::shared_ptr< const ::fwMedData::SeriesDB > dicomSeriesDB,::fwServices::IService::sptr notifier=::fwServices::IService::sptr())
	Reads DICOM data from DicomSeries an fills SeriesDB object. More...

FWDCMTKIO_API void	readDicomSeries ()
	Reads DICOM data from configured path and fills SeriesDB object with DicomSeries.

FWDCMTKIO_API bool	isDicomDirAvailable ()
	Return true if a dicomdir file can be read.

FWDCMTKIO_API DicomSeriesContainerType &	getDicomSeries ()
	Return DicomSeries container.

const bool &	getDicomdirActivated () const
	Get Set whether the reader must use the dicomdir file or not.

void	setDicomdirActivated (const bool &isDicomdirActivated)
	Set Set whether the reader must use the dicomdir file or not.

const std::string &	getDicomFilterType () const
	Get Dicom filter type that must be applied prior the reading process.

void	setDicomFilterType (const std::string &dicomFilterType)
	Set Dicom filter type that must be applied prior the reading process.

const SupportedSOPClassContainerType &	getSupportedSOPClassContainer () const
	Get Supported SOP Class.

void	setSupportedSOPClassContainer (const SupportedSOPClassContainerType &supportedSOPClassContainer)
	Set Supported SOP Class.

Public Member Functions inherited from fwDataIO::reader::GenericObjectReader< ::fwMedData::SeriesDB >
	GenericObjectReader ()
	Constructor. Do nothing.

virtual std::string	extension () override

virtual	~GenericObjectReader ()
	Destructor. Do nothing.

virtual void	setObject (::fwTools::Object::sptr obj) override
	m_object setter. More...

virtual std::shared_ptr< DataType >	getConcreteObject ()
	m_object getter. More...

Public Member Functions inherited from fwDataIO::reader::IObjectReader
virtual FWDATAIO_API::fwTools::Object::sptr	getObject ()
	m_object getter. More...

virtual FWDATAIO_API void	setLocation (const ::fwData::location::ILocation::sptr _location)
	m_location setter. More...

virtual FWDATAIO_API::fwData::location::ILocation::sptr	getLocation ()
	m_location getter. More...

FWDATAIO_API void	cancel ()
	Requests reader abortion.

virtual FWDATAIO_API std::shared_ptr< ::fwJobs::IJob >	getJob () const
	Returns the internal job.

Public Member Functions inherited from fwCore::BaseObject
Public Member Functions inherited from fwData::location::enableFolder< ::fwDataIO::reader::IObjectReader >
	enableFolder (::fwDataIO::reader::IObjectReader *rw)
	constructor More...

void	setFolder (ILocation::PathType folder)
	Set folder filesystem path.

ILocation::PathType	getFolder ()
	Get folder filesystem path.

void	setRecursive (bool val)
	Set the flag if folder location is recursive.

bool	getRecursive ()
	Get the flag if folder location is recursive.

Public Member Functions inherited from fwData::location::enableMultiFiles< ::fwDataIO::reader::IObjectReader >
	enableMultiFiles (::fwDataIO::reader::IObjectReader *rw)
	constructor More...

void	setFiles (ILocation::VectPathType paths)
	Set file system paths.

ILocation::VectPathType	getFiles ()
	Get file system paths.

Public Member Functions inherited from fwTools::ProgressAdviser
FWTOOLS_API void	addHandler (const ProgessHandler &handler)

FWTOOLS_API void	notifyProgress (float percent, const std::string &msg="") const
	notify modification for all handler

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwDataIO::reader::GenericObjectReader< ::fwMedData::SeriesDB >
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 fwDataIO::reader::IObjectReader
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

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

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
Protected Member Functions inherited from fwDataIO::reader::IObjectReader
FWDATAIO_API	IObjectReader ()
	Constructor. Do nothing.

virtual FWDATAIO_API	~IObjectReader ()
	Destructor. Do nothing.

Protected Attributes inherited from fwDataIO::reader::IObjectReader
::fwTools::Object::wptr	m_object
	Object result of reading process. More...

::fwData::location::ILocation::sptr	m_location
	Object location ( file path, directory path, url, etc )

Protected Attributes inherited from fwTools::ProgressAdviser
ProgessSignal	m_progressSignal
	to notify progress simply use m_progressSignal( percent,msg ) to notify to Handler

Detailed Description

Reads DICOM data from a directory path in order to create a SeriesDB object.

Definition at line 39 of file fwDcmtkIO/include/fwDcmtkIO/SeriesDBReader.hpp.

Member Function Documentation

void fwDcmtkIO::SeriesDBReader::readFromDicomSeriesDB	(	std::shared_ptr< const ::fwMedData::SeriesDB >	dicomSeriesDB,
		::fwServices::IService::sptr	notifier = `::fwServices::IService::sptr()`
	)

Reads DICOM data from DicomSeries an fills SeriesDB object.

Parameters

[in]	dicomSeriesDB	SeriesDB containing DicomSeries that must be read
[in]	notifier	Service used to notify changes in SeriesDB

Definition at line 122 of file fwDcmtkIO/src/fwDcmtkIO/SeriesDBReader.cpp.

References OSLM_ASSERT.

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

Public Types

Public Member Functions

Static Public Member Functions

Friends

Demangling methods

Additional Inherited Members

Detailed Description

Member Function Documentation