ml::DcmtkAccessories Class Reference

Class collecting some DICOM helper functions. More...

#include <mlDcmtkAccessories.h>

List of all members.

Static Public Member Functions
static DRTImageIODPtr	getDRTImageIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
	Opens and loads a DICOM (rt image, rt dose, rt struct, rt plan or sr doc etc.
static DRTDoseIODPtr	getDRTDoseIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTStructureSetIODPtr	getDRTStructureSetIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTIonPlanIODPtr	getDRTIonPlanIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTPlanIODPtr	getDRTPlanIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTTreatmentSummaryRecordIODPtr	getDRTTreatmentSummaryRecordIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTIonBeamsTreatmentRecordIODPtr	getDRTIonBeamsTreatmentRecordIOD (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DSRDocumentPtr	getDSRDocument (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DVPresentationStatePtr	getDVPresentationState (const std::string &fName, std::string *errVal=NULL, DcmFileFormatPtr *dcmFilePtr=NULL)
static DRTImageIODPtr	getDRTImageIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
	Loads a DICOM (rt image, dt dose, rt struct, rt plan or sr doc etc.
static DRTDoseIODPtr	getDRTDoseIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DRTStructureSetIODPtr	getDRTStructureSetIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DRTIonPlanIODPtr	getDRTIonPlanIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DRTPlanIODPtr	getDRTPlanIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DRTTreatmentSummaryRecordIODPtr	getDRTTreatmentSummaryRecordIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DRTIonBeamsTreatmentRecordIODPtr	getDRTIonBeamsTreatmentRecordIOD (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DSRDocumentPtr	getDSRDocument (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static DVPresentationStatePtr	getDVPresentationState (DcmFileFormatPtr &dcmfile, std::string *errVal=NULL)
static bool	getAllReferences (DRTIonPlanIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
	Methods to retrieve the RTObjects referenced by a RTPlan.
static bool	getAllReferences (DRTPlanIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getAllReferences (DRTDoseIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getAllReferences (DRTImageIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getAllReferences (DRTStructureSetIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getAllReferences (DRTTreatmentSummaryRecordIODPtr rtIODPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getRTDoseReferences (DRTPlanIODPtr rtPlanPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getRTStructReferences (DRTPlanIODPtr rtPlanPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getRTStructReferences (DRTDoseIODPtr rtDosePtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getRTPlanReferences (DRTImageIODPtr rtImagePtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getRTPlanReferences (DRTDoseIODPtr rtDosePtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	getStudyReferences (DRTPlanIODPtr rtPlanPtr, DcmtkObjectReferenceInfoConstVector &outReferences, std::string *errVal=NULL)
static bool	loadDcmFile (const std::string &fName, DcmFileFormat &dcmfile, std::string *errVal=NULL)
	Load a DICOM file into the dcmtk DcmFileFormat object.
static OFString	getModality (DcmFileFormat &dcmfile, std::string *errVal=NULL)
	Return the modality of a given DcmFileFormat.
static void	tokenize (const OFString &str, std::vector< OFString > &tokens, const OFString &delimiter=" ")
	Tokenize a given string by splitting it at delimiters.

---

Detailed Description

Class collecting some DICOM helper functions.

Definition at line 95 of file mlDcmtkAccessories.h.

---

Member Function Documentation

static bool ml::DcmtkAccessories::getAllReferences	(	DRTTreatmentSummaryRecordIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getAllReferences	(	DRTStructureSetIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getAllReferences	(	DRTImageIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getAllReferences	(	DRTDoseIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getAllReferences	(	DRTPlanIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getAllReferences	(	DRTIonPlanIODPtr	rtIODPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

Methods to retrieve the RTObjects referenced by a RTPlan.

Parameters:

	rtPlan	A boost pointer to the RTPlanIOD for which the specific RTObject should be returned.
	idx	The index into the list of referenced RTObjects.
	errVal	An optional string which will be filled with an error description if passed as non NULL. Otherwise it is ignored.

Returns:

A boost pointer wrapping the loaded DICOM object, or in case of failure a default NULL boost pointer.

static DRTDoseIODPtr ml::DcmtkAccessories::getDRTDoseIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTDoseIODPtr ml::DcmtkAccessories::getDRTDoseIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DRTImageIODPtr ml::DcmtkAccessories::getDRTImageIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

Loads a DICOM (rt image, dt dose, rt struct, rt plan or sr doc etc.

) object and returns a boost pointer wrapping the loaded object.

Parameters:

	dcmfile	A DcmFileFormat object which must have been initialized with a file name and loaded; it will be used to load/open the DICOM object to be loaded.
	errVal	An optional string which will be filled with an error description if passed as non NULL. Otherwise it is ignored.

Returns:

A boost pointer wrapping the loaded DICOM object, or in case of failure a default NULL boost pointer.

static DRTImageIODPtr ml::DcmtkAccessories::getDRTImageIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

Opens and loads a DICOM (rt image, rt dose, rt struct, rt plan or sr doc etc.

) object and returns a boost pointer wrapping the loaded object.

Parameters:

	fName	The name of the DICOM file containing the object to be loaded.
	errVal	An optional string which will be filled with an error description if passed as non NULL. Otherwise it is ignored.
	dcmFilePtr	If passed NULL a temporary DcmFile is used to load fName. If passed boost ptr points to NULL DcmFileFormat will be created and assigned to it. Is passed boost ptr is valid the DcmFileFormat object will be used to load the DICOM object.

Returns:

A boost pointer wrapping the loaded DICOM object, or in case of failure a default NULL boost pointer.

static DRTIonBeamsTreatmentRecordIODPtr ml::DcmtkAccessories::getDRTIonBeamsTreatmentRecordIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTIonBeamsTreatmentRecordIODPtr ml::DcmtkAccessories::getDRTIonBeamsTreatmentRecordIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DRTIonPlanIODPtr ml::DcmtkAccessories::getDRTIonPlanIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTIonPlanIODPtr ml::DcmtkAccessories::getDRTIonPlanIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DRTPlanIODPtr ml::DcmtkAccessories::getDRTPlanIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTPlanIODPtr ml::DcmtkAccessories::getDRTPlanIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DRTStructureSetIODPtr ml::DcmtkAccessories::getDRTStructureSetIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTStructureSetIODPtr ml::DcmtkAccessories::getDRTStructureSetIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DRTTreatmentSummaryRecordIODPtr ml::DcmtkAccessories::getDRTTreatmentSummaryRecordIOD	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DRTTreatmentSummaryRecordIODPtr ml::DcmtkAccessories::getDRTTreatmentSummaryRecordIOD	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DSRDocumentPtr ml::DcmtkAccessories::getDSRDocument	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DSRDocumentPtr ml::DcmtkAccessories::getDSRDocument	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static DVPresentationStatePtr ml::DcmtkAccessories::getDVPresentationState	(	DcmFileFormatPtr &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

static DVPresentationStatePtr ml::DcmtkAccessories::getDVPresentationState	(	const std::string &	fName,
		std::string *	errVal = NULL,
		DcmFileFormatPtr *	dcmFilePtr = NULL
	)			[static]

static OFString ml::DcmtkAccessories::getModality	(	DcmFileFormat &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

Return the modality of a given DcmFileFormat.

Parameters:

	dcmfile	A reference to a DcmFileFormat from which to read the modality string.
	errVal[out]	An optional string which will be filled with an error description if passed as non NULL. Otherwise it is ignored.

Returns:

A OFString containing the modality. The string is empty if an error occured.

static bool ml::DcmtkAccessories::getRTDoseReferences	(	DRTPlanIODPtr	rtPlanPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getRTPlanReferences	(	DRTDoseIODPtr	rtDosePtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getRTPlanReferences	(	DRTImageIODPtr	rtImagePtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getRTStructReferences	(	DRTDoseIODPtr	rtDosePtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getRTStructReferences	(	DRTPlanIODPtr	rtPlanPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::getStudyReferences	(	DRTPlanIODPtr	rtPlanPtr,
		DcmtkObjectReferenceInfoConstVector &	outReferences,
		std::string *	errVal = NULL
	)			[static]

static bool ml::DcmtkAccessories::loadDcmFile	(	const std::string &	fName,
		DcmFileFormat &	dcmfile,
		std::string *	errVal = NULL
	)			[static]

Load a DICOM file into the dcmtk DcmFileFormat object.

Parameters:

	fName	A string containing the filename of the DICOM file to load.
	dcmfile[out]	A reference to a DcmFileFormat. The file will be loaded into this object.
	errVal[out]	An optional string which will be filled with an error description if passed as non NULL. Otherwise it is ignored.

Returns:

True if the file could be loaded completely into memory, False else.

static void ml::DcmtkAccessories::tokenize	(	const OFString &	str,
		std::vector< OFString > &	tokens,
		const OFString &	delimiter = " "
	)			[static]

Tokenize a given string by splitting it at delimiters.

The parts are pushed back into the tokens vector.

Parameters:

	str	The string to be split.
	tokens[out]	A reference to a vector of OFString. Will contain the tokens.
	delimiter	The delimiter used to split the str.

Returns:

True if the file could be loaded completely into memory, False else.

---

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

• FMEwork/Release/Sources/Shared/MLDcmtkAccessories/mlDcmtkAccessories.h