DicomSeries Helper. This class is used to generate/fill DicomSeries. More...

#include <DicomSeries.hpp>

Collaboration diagram for fwGdcmIO::helper::DicomSeries:

Public Types
typedef std::vector< ::boost::filesystem::path >	FilenameContainerType

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

Public Member Functions
FWGDCMIO_API	DicomSeries ()
	Constructor.

FWGDCMIO_API	~DicomSeries ()
	Destructor.

FWGDCMIO_API DicomSeriesContainerType	read (FilenameContainerType &filenames, const std::shared_ptr< ::fwJobs::Observer > &readerObserver=nullptr, const std::shared_ptr< ::fwJobs::Observer > &completeSeriesObserver=nullptr)
	Read DicomSeries from paths. More...

FWGDCMIO_API void	complete (DicomSeriesContainerType &seriesDB, const std::shared_ptr< ::fwJobs::Observer > &completeSeriesObserver)
	Fill DicomSeries information for series generated using DICOMDIR helper. More...

Protected 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

Protected Member Functions
void	fillSeries (DicomSeriesContainerType &seriesDB, const std::shared_ptr< ::fwJobs::Observer > &completeSeriesObserver)
	Fill series with information contained in first instance. More...

DicomSeriesContainerType	splitFiles (FilenameContainerType &filenames, const std::shared_ptr< ::fwJobs::Observer > &readerObserver)
	Create DicomSeries from list of files. Every instance is read in order to retrieve instance information regarding the matching series. More...

void	createSeries (DicomSeriesContainerType &seriesDB, const ::gdcm::Scanner &scanner, const ::boost::filesystem::path &filename)
	Create a series from the dataset and store it in the series map. More...

std::shared_ptr< ::fwMedData::Patient >	createPatient (const ::gdcm::DataSet &dataset)
	Create a patient from the dataset and store it in the patient map. More...

std::shared_ptr< ::fwMedData::Study >	createStudy (const ::gdcm::DataSet &dataset)
	Create a study from the dataset and store it in the study map. More...

std::shared_ptr< ::fwMedData::Equipment >	createEquipment (const ::gdcm::DataSet &dataset)
	Create an equipment from the dataset and store it in the equipment map. More...

Protected Attributes
PatientMapType	m_patientMap
	Patient Map.

StudyMapType	m_studyMap
	Study Map.

EquipmentMapType	m_equipmentMap
	Equipment Map.

Detailed Description

DicomSeries Helper. This class is used to generate/fill DicomSeries.

It can be used to read DicomSeries from a list of files (using read function).
It can be used to complete DicomSeries that have been created using the DicomDir helper (using complete function).

Definition at line 49 of file io/fwGdcmIO/include/fwGdcmIO/helper/DicomSeries.hpp.

Member Function Documentation

void fwGdcmIO::helper::DicomSeries::complete	(	DicomSeriesContainerType &	seriesDB,
		const std::shared_ptr< ::fwJobs::Observer > &	completeSeriesObserver
	)

Fill DicomSeries information for series generated using DICOMDIR helper.

Parameters

[in,out]	seriesDB	List of DicomSeries that must be completed with information
[in]	completeSeriesObserver	complete series observer

Definition at line 129 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References fillSeries(), SLM_ERROR, and SPTR.

Referenced by fwGdcmIO::reader::SeriesDB::readDicomSeries().

Here is the call graph for this function:

Here is the caller graph for this function:

fwMedData::Equipment::sptr fwGdcmIO::helper::DicomSeries::createEquipment ( const ::gdcm::DataSet & dataset )

protected

Create an equipment from the dataset and store it in the equipment map.

Parameters

[in] dataset GDCM Dataset used to read information

Definition at line 503 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References m_equipmentMap.

Referenced by fillSeries().

Here is the caller graph for this function:

fwMedData::Patient::sptr fwGdcmIO::helper::DicomSeries::createPatient ( const ::gdcm::DataSet & dataset )

protected

Create a patient from the dataset and store it in the patient map.

Parameters

[in] dataset GDCM Dataset used to read information

Definition at line 415 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References m_patientMap.

Referenced by fillSeries().

Here is the caller graph for this function:

void fwGdcmIO::helper::DicomSeries::createSeries	(	DicomSeriesContainerType &	seriesDB,
		const ::gdcm::Scanner &	scanner,
		const ::boost::filesystem::path &	filename
	)

protected

Create a series from the dataset and store it in the series map.

Parameters

[in,out]	seriesDB	List of DicomSeries that must be completed with information
[in]	scanner	GDCM Scanner used to read information
[in]	filename	Filename from which the information must be read

Definition at line 343 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

Referenced by splitFiles().

Here is the caller graph for this function:

fwMedData::Study::sptr fwGdcmIO::helper::DicomSeries::createStudy ( const ::gdcm::DataSet & dataset )

protected

Create a study from the dataset and store it in the study map.

Parameters

[in] dataset GDCM Dataset used to read information

Definition at line 455 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References m_studyMap.

Referenced by fillSeries().

Here is the caller graph for this function:

void fwGdcmIO::helper::DicomSeries::fillSeries	(	DicomSeriesContainerType &	seriesDB,
		const std::shared_ptr< ::fwJobs::Observer > &	completeSeriesObserver
	)

protected

Fill series with information contained in first instance.

Parameters

[in,out]	seriesDB	List of DicomSeries that must be completed with information
[in]	completeSeriesObserver	complete series observer

Definition at line 266 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References createEquipment(), createPatient(), createStudy(), m_equipmentMap, m_patientMap, m_studyMap, SLM_ERROR, and SPTR.

Referenced by complete(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

DicomSeries::DicomSeriesContainerType fwGdcmIO::helper::DicomSeries::read	(	FilenameContainerType &	filenames,
		const std::shared_ptr< ::fwJobs::Observer > &	readerObserver = `nullptr`,
		const std::shared_ptr< ::fwJobs::Observer > &	completeSeriesObserver = `nullptr`
	)

Read DicomSeries from paths.

Parameters

[in]	filenames	instance paths
[in]	readerObserver	reader observer
[in]	completeSeriesObserver	complete series observer

Returns: container containing DicomSeries

Definition at line 118 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References fillSeries(), and splitFiles().

Referenced by fwGdcmIO::reader::SeriesDB::readDicomSeries().

Here is the call graph for this function:

Here is the caller graph for this function:

DicomSeries::DicomSeriesContainerType fwGdcmIO::helper::DicomSeries::splitFiles	(	FilenameContainerType &	filenames,
		const std::shared_ptr< ::fwJobs::Observer > &	readerObserver
	)

protected

Create DicomSeries from list of files. Every instance is read in order to retrieve instance information regarding the matching series.

Parameters

[in]	filenames	List of files
[in]	readerObserver	reader observer

Definition at line 201 of file io/fwGdcmIO/src/fwGdcmIO/helper/DicomSeries.cpp.

References createSeries(), and OSLM_ASSERT.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation