Implementation of DCMR Template: TID 1600 - Image Library (and included templates 1601-1607). More...

Inheritance diagram for TID1600_ImageLibrary:

Public Types
enum	AddImageMode { withoutDescriptors, withAllDescriptors, withSelectedDescriptors, withoutSelectedDescriptors }
	add mode for image entries More...

Public Member Functions
	TID1600_ImageLibrary (const OFBool createLibrary=OFTrue)
	(default) constructor More...

virtual OFBool	isValid () const
	check whether the current internal state is valid. More...

OFBool	hasImageLibrary () const
	check whether the content item 'Image Library' (TID 1600 - Row 1) is present. More...

OFBool	hasImageLibraryGroup () const
	check whether there is an image group in this image library (TID 1600 - Row 2) More...

OFCondition	createNewImageLibrary ()
	clear the internally stored tree of content items and create the mandatory content item 'Image Library' (TID 1600 - Row 1) as the root node of this template More...

OFCondition	addImageGroup ()
	add an image group to the image library. More...

OFCondition	addImageEntry (DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors=ConceptNameList(), const OFBool check=OFTrue)
	add an image entry to the current image group, i.e. add content items for TID 1601 (Image Library Entry). More...

OFCondition	addImageGroupDescriptors (DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors=ConceptNameList(), const OFBool check=OFTrue)
	add common image descriptors to the current image group, i.e. add content items items for TID 1602 (Image Library Entry Descriptors) and included templates. More...

OFCondition	getImageEntryModality (DSRCodedEntryValue &modalityCode)
	go to the most recently added image library entry and get the value of the descriptor 'Modality' (TID 1602 - Row 1) More...

OFCondition	moveCommonImageDescriptorsToImageGroups ()
	move common image descriptors from all image entries in this image library to their respective image groups. More...

OFCondition	setPETImageRadionuclide (const CID4020_PETRadionuclide &radionuclide, const OFBool check=OFTrue)
	set the value of the descriptor 'Radionuclide' (TID 1607 - Row 1) for the current (most recently added) PET image library entry. More...

OFCondition	setPETImageRadiopharmaceuticalAgent (const CID4021_PETRadiopharmaceutical &agent, const OFBool check=OFTrue)
	set the value of the descriptor 'Radiopharmaceutical Agent' (TID 1607 - Row 2) for the current (most recently added) PET image library entry. More...

OFCondition	setPETImageRadiopharmaceuticalStartDateTime (const OFString &dateTime, const OFBool check=OFTrue)
	set the value of the descriptor 'Radiopharmaceutical Start Date Time' (TID 1607 - Row 4) for the current (most recently added) PET image library entry. More...

OFCondition	setPETImageRadiopharmaceuticalStopDateTime (const OFString &dateTime, const OFBool check=OFTrue)
	set the value of the descriptor 'Radiopharmaceutical Stop Date Time' (TID 1607 - Row 5) for the current (most recently added) PET image library entry. More...

OFCondition	setPETImageRadiopharmaceuticalVolume (const CMR_SRNumericMeasurementValue &volume, const OFBool check=OFTrue)
	set the value of the descriptor 'Radiopharmaceutical Volume' (TID 1607 - Row 6) for the current (most recently added) PET image library entry. More...

OFCondition	setPETImageRadionuclideTotalDose (const CMR_SRNumericMeasurementValue &totalDose, const OFBool check=OFTrue)
	set the value of the descriptor 'Radiopharmaceutical Total Dose' (TID 1607 - Row 7) for the current (most recently added) PET image library entry. More...

Public Member Functions inherited from DSRSubTemplate
	DSRSubTemplate (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="")
	constructor More...

	DSRSubTemplate (const DSRSubTemplate &subTemplate)
	copy constructor. More...

virtual	~DSRSubTemplate ()
	destructor

virtual DSRSubTemplate *	clone () const
	clone this template. More...

virtual DSRDocumentSubTree *	cloneTree () const
	clone the internally stored subtree of this template. More...

virtual void	clear ()
	clear internal member variables. More...

OFBool	isRootTemplate () const
	check whether this template is a root template, i.e. describes a complete SR document tree starting from the root node More...

virtual const DSRDocumentSubTree &	getTree ()
	get read-only access to internally stored subtree. More...

virtual OFCondition	addExtraContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent)
	add extra content item to the current one (if the template is extensible). More...

virtual OFCondition	insertExtraTemplate (const DSRSubTemplate &subTemplate, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown)
	insert tree from given extra template to internally stored subtree. More...

virtual OFBool	isCursorValid () const
	check whether the internal cursor, which points to the current content item, is valid More...

virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags=0, const DSRPositionCounter *posCounter=NULL)
	print current SR document tree to specified output stream More...

virtual OFCondition	writeXML (STD_NAMESPACE ostream &stream, const size_t flags=0)
	write current SR document tree in XML format More...

size_t	countNodes (const OFBool searchIntoSubTemplates=OFFalse, const OFBool countIncludedTemplateNodes=OFTrue) const
	count number of content items (nodes) in the document tree. More...

virtual size_t	gotoNamedNode (const DSRCodedEntryValue &conceptName, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node. More...

virtual size_t	gotoNextNamedNode (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next named node. More...

virtual size_t	gotoAnnotatedNode (const OFString &annotationText, const OFBool startFromRoot=OFTrue)
	set internal cursor to an annotated node. More...

virtual size_t	gotoNextAnnotatedNode (const OFString &annotationText)
	set internal cursor to the next annotated node. More...

virtual DSRContentItem &	getCurrentContentItem ()
	get reference to current content item. More...

virtual OFCondition	updateByReferenceRelationships (const OFBool updateIncludedTemplates=OFFalse)
	update the position strings used to encode by-reference relationships (if any). More...

Public Member Functions inherited from DSRTemplateCommon
virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	isTemplateIdentificationValid (const OFBool check=OFTrue) const
	check whether template identification is valid More...

virtual OFBool	isExtensible () const
	check whether template is extensible More...

virtual OFBool	isOrderSignificant () const
	check whether the order of content items in this template is significant More...

virtual OFBool	compareTemplateIdentication (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification with given values More...

const OFString &	getTemplateIdentifier () const
	get template identifier More...

const OFString &	getMappingResource () const
	get mapping resource More...

const OFString &	getMappingResourceUID () const
	get optional mapping resource UID More...

virtual void	setExtensible (const OFBool mode=OFTrue)
	change mode specifying whether the template is extensible or non-extensible More...

virtual void	setOrderSignificant (const OFBool mode=OFTrue)
	change mode specifying whether the order of content items in this template is significant or non-significant More...

Protected Member Functions
OFCondition	createImageLibrary ()
	create the mandatory content item 'Image Library' (TID 1600 - Row 1) as the root node of this template. More...

OFCondition	addImageEntryDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors (TID 1602) to given document subtree. More...

OFCondition	addModalitySpecificDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const OFString &modality, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors (TID 1603 to 1607) to given document subtree depending on the given 'modality'. More...

OFCondition	addProjectionRadiographyDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors for projection radiography (TID 1603) More...

OFCondition	addCrossSectionalModalitiesDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors for cross-sectional modalities (TID 1604) More...

OFCondition	addComputedTomographyDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors for CT (TID 1605) More...

OFCondition	addMagneticResonanceDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors for MR (TID 1606) More...

OFCondition	addPositronEmissionTomographyDescriptors (DSRDocumentSubTree &tree, DcmItem &dataset, const AddImageMode mode, const ConceptNameList &descriptors, const OFBool check)
	add image library entry descriptors for PET (TID 1607). More...

OFCondition	goAndCheckImageLibraryEntry (const DSRCodedEntryValue &modalityCode)
	go to the most recently added image library entry and check the value of the associated descriptor 'Modality' (TID 1602 - Row 1) More...

OFCondition	setStringContentItemFromValue (const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFString &stringValue, const OFString &annotationText, const OFBool check)
	search for a particular content item (given by the concept name and value type) and set its string value. More...

OFCondition	setCodeContentItemFromValue (const DSRCodedEntryValue &conceptName, const DSRCodedEntryValue &codeValue, const OFString &annotationText, const OFBool check)
	search for a particular CODE content item (given by the concept name) and set its coded entry value. More...

OFCondition	setNumericContentItemFromValue (const DSRCodedEntryValue &conceptName, const DSRNumericMeasurementValue &numericValue, const DSRCodedEntryValue &measurementUnit, const OFString &annotationText, const OFBool check)
	search for a particular NUM content item (given by the concept name) and set its numeric measurement value. More...

Protected Member Functions inherited from DSRSubTemplate
virtual void	updateTreeForOutput ()
	update the tree for subsequent output, e.g. for being printed or added to an SR document. More...

Protected Member Functions inherited from DSRDocumentSubTree
	DSRDocumentSubTree (DSRDocumentTreeNode *rootNode)
	special constructor that receives a pointer to the root node. More...

	DSRDocumentSubTree (const DSRDocumentTreeNodeCursor &startCursor, size_t stopAfterNodeID)
	special copy constructor that clones a particular subtree only More...

void	swap (DSRDocumentSubTree &tree)
	fast, non-throwing swap function. More...

virtual DSRDocumentTreeNode *	getNode () const
	get pointer to current node. More...

virtual size_t	addNode (DSRDocumentTreeNode *node, const E_AddMode addMode=AM_afterCurrent)
	add new node to the current one. More...

virtual size_t	replaceNode (DSRDocumentTreeNode *node)
	replace current node by the given one. More...

virtual DSRDocumentTreeNode *	extractNode ()
	extract current node from tree. More...

virtual DSRDocumentTreeNode *	getAndRemoveRootNode ()
	get pointer to root node and "forget" the internal reference to this node. More...

virtual size_t	removeNode ()
	remove current node from tree. More...

virtual OFCondition	includeTemplate (const DSRSharedSubTemplate &subTemplate, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown)
	include specified sub-template, i.e. add a new DSRIncludedTemplateTreeNode, which references this template, to the current content item. More...

virtual OFCondition	expandIncludedTemplates (DSRDocumentSubTree *tree) const
	expand all "included template" content items in a given (sub)tree. More...

template<typename T_Cursor >
OFCondition	checkByReferenceRelationships (const size_t mode=0, const size_t flags=0)
	check the by-reference relationships (if any) for validity. More...

virtual void	resetReferenceTargetFlag ()
	reset flag for all content items whether they are target of a by-reference relationship. More...

virtual OFCondition	checkSubTreeConstraints (const DSRDocumentSubTree tree, const DSRIODConstraintChecker checker) const
	check whether the given subtree complies with the constraints of the given checker More...

virtual OFBool	validByReferenceRelationship (const OFString &sourcePosition, const OFString &targetPosition)
	check whether a by-reference relationship from a given source to a target node (specified by the position strings) is valid, i.e. is allowed according to the DICOM standard. More...

	DSRDocumentSubTree ()
	default constructor

	DSRDocumentSubTree (const DSRDocumentSubTree &tree)
	copy constructor. More...

virtual	~DSRDocumentSubTree ()
	destructor

DSRDocumentSubTree &	operator= (DSRDocumentSubTree tree)
	assignment operator. More...

virtual OFBool	isCursorValid () const
	check whether the internal cursor, which points to the current content item, is valid More...

virtual OFBool	isValidDocumentTree (const E_RelationshipType defaultRelType=RT_unknown) const
	check whether this subtree is a valid document tree. More...

virtual OFBool	isExpandedDocumentTree () const
	check whether this subtree is an expanded document tree. More...

virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	canUseTemplateIdentification () const
	check whether template identification is possible at all. More...

virtual OFCondition	print (STD_NAMESPACE ostream &stream, const size_t flags=0, const DSRPositionCounter *posCounter=NULL)
	print current SR document tree to specified output stream More...

virtual OFCondition	writeXML (STD_NAMESPACE ostream &stream, const size_t flags=0)
	write current SR document tree in XML format More...

virtual DSRContentItem &	getCurrentContentItem ()
	get reference to current content item. More...

virtual const DSRDocumentTreeNode *	getCurrentNode () const
	get read-only access to current node (content item) More...

virtual OFBool	getCursorToRootNode (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the root node of this document tree. More...

virtual OFBool	getCursorToRootNode (DSRIncludedTemplateNodeCursor &cursor) const
	get a cursor to the root node of this document tree. More...

virtual OFBool	getCursorToCurrentNode (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the current node of this document tree. More...

virtual OFBool	getCursorToSubTree (DSRDocumentTreeNodeCursor &cursor) const
	get a cursor to the subtree below the current node. More...

size_t	countNodes (const OFBool searchIntoSubTemplates=OFFalse, const OFBool countIncludedTemplateNodes=OFTrue) const
	count number of content items (nodes) in the document tree. More...

virtual size_t	gotoMatchingNode (const DSRDocumentTreeNodeFilter &filter, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a matching node. More...

virtual size_t	gotoNextMatchingNode (const DSRDocumentTreeNodeFilter &filter, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next matching node. More...

virtual size_t	gotoNamedNode (const DSRCodedEntryValue &conceptName, const OFBool startFromRoot=OFTrue, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node. More...

virtual size_t	gotoNamedChildNode (const DSRCodedEntryValue &conceptName)
	set internal cursor to a named node (starting from the first child of the current node and searching on this level only). More...

virtual size_t	gotoNamedNodeInSubTree (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to a named node in the subtree below the current node. More...

virtual size_t	gotoNextNamedNode (const DSRCodedEntryValue &conceptName, const OFBool searchIntoSub=OFTrue)
	set internal cursor to the next named node. More...

virtual size_t	gotoAnnotatedNode (const OFString &annotationText, const OFBool startFromRoot=OFTrue)
	set internal cursor to an annotated node. More...

virtual size_t	gotoNextAnnotatedNode (const OFString &annotationText)
	set internal cursor to the next annotated node. More...

virtual OFBool	canAddContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent) const
	check whether specified content item can be added to the current one. More...

virtual OFBool	canAddByReferenceRelationship (const E_RelationshipType relationshipType, const E_ValueType targetValueType) const
	check whether specified by-reference relationship can be added to the current content item. More...

virtual size_t	addContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const E_AddMode addMode=AM_afterCurrent)
	add specified content item to the current one. More...

virtual OFCondition	addContentItem (DSRDocumentTreeNode *node, const E_AddMode addMode=AM_afterCurrent, const OFBool deleteIfFail=OFFalse)
	add specified content item to the current one. More...

virtual OFCondition	addContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFBool check=OFTrue)
	add specified content item after the current one. More...

virtual OFCondition	addChildContentItem (const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFBool check=OFTrue)
	add specified content item below the current one. More...

virtual size_t	addByReferenceRelationship (const E_RelationshipType relationshipType, const size_t referencedNodeID)
	add specified by-reference relationship to the current content item. More...

virtual OFCondition	updateByReferenceRelationships (const OFBool updateIncludedTemplates=OFFalse)
	update the position strings used to encode by-reference relationships (if any). More...

virtual OFBool	canInsertSubTree (const DSRDocumentSubTree *tree, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown) const
	check whether specified subtree can be inserted at the current position, i.e. added to the current content item. More...

virtual OFCondition	insertSubTree (DSRDocumentSubTree *tree, const E_AddMode addMode=AM_belowCurrent, const E_RelationshipType defaultRelType=RT_unknown, const OFBool deleteIfFail=OFFalse)
	insert specified subtree to this tree, i.e. add it to the current content item. More...

virtual DSRDocumentSubTree *	extractSubTree ()
	extract a subtree, i.e. a fragment from this tree. More...

virtual size_t	removeCurrentContentItem ()
	remove current content item from tree. More...

virtual OFCondition	removeSubTree (const size_t searchID=0)
	remove a subtree from this tree. More...

virtual DSRDocumentTreeNode *	cloneCurrentTreeNode () const
	clone the current tree node. More...

virtual DSRDocumentSubTree *	cloneSubTree (const size_t stopAfterNodeID=0) const
	clone a subtree, i.e. a fragment of this tree. More...

virtual OFCondition	createExpandedSubTree (DSRDocumentSubTree *&tree) const
	created an expanded version of this (sub)tree. More...

virtual OFCondition	setObservationDateTime (const OFString &observationDateTime, const OFBool check=OFTrue)
	set observation date/time for all content items in the document tree. More...

virtual OFBool	compareTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification of the root node with given values. More...

virtual OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
	get template identifier and mapping resource from the root node of this tree. More...

virtual OFCondition	getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource, OFString &mappingResourceUID) const
	get template identifier, mapping resource and optional mapping resource UID from the root node of this tree. More...

virtual OFCondition	setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="", const OFBool check=OFTrue)
	set template identifier and mapping resource to the root node of this tree. More...

Protected Member Functions inherited from DSRTree< DSRDocumentTreeNode >
	DSRTree (DSRDocumentTreeNode *rootNode)
	special constructor that receives a pointer to the root node. More...

	DSRTree (const DSRTreeNodeCursor< DSRDocumentTreeNode > &startCursor, size_t stopAfterNodeID)
	special copy constructor that clones a particular subtree only More...

void	swap (DSRTree< DSRDocumentTreeNode > &tree)
	fast, non-throwing swap function. More...

virtual DSRDocumentTreeNode *	getRoot () const
	get pointer to root node More...

virtual void	deleteTreeFromRootNode (DSRDocumentTreeNode *rootNode)
	delete a tree given by its root node. More...

	DSRTree ()
	default constructor

	DSRTree (const DSRTree< DSRDocumentTreeNode > &tree)
	copy constructor. More...

virtual	~DSRTree ()
	destructor

DSRTree &	operator= (DSRTree< DSRDocumentTreeNode > tree)
	assignment operator. More...

void	clearAnnotations ()
	clear annotations of all tree nodes

OFBool	isEmpty () const
	check whether tree has any nodes More...

size_t	countNodes () const
	count number of nodes in the tree. More...

size_t	getNextNodeID () const
	get ID of the next node to be created. More...

size_t	gotoRoot ()
	set internal cursor to root node More...

size_t	gotoNode (const size_t searchID, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const OFString &reference, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const DSRTreeNodeAnnotation &annotation, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node More...

size_t	gotoNode (const DSRDocumentTreeNode &nodeValue, const OFBool startFromRoot=OFTrue)
	set internal cursor to specified node (given by its value). More...

Protected Member Functions inherited from DSRTemplateCommon
	DSRTemplateCommon (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="")
	constructor More...

virtual	~DSRTemplateCommon ()
	destructor

void	clearEntriesInNodeList ()
	clear all entries in the list of node IDs, i.e. set them to their initial value, which is 0

void	reserveEntriesInNodeList (const size_t count, const OFBool initialize=OFFalse)
	reserve a certain number of entries in the list of node IDs. More...

void	storeEntryInNodeList (const size_t pos, const size_t nodeID)
	store given entry at a certain position in the list of node IDs More...

size_t	getEntryFromNodeList (const size_t pos) const
	get a particular entry from the list of node IDs More...

size_t	gotoEntryFromNodeList (DSRDocumentTreeNodeCursor &cursor, const size_t pos) const
	set given cursor to a specific node More...

size_t	gotoEntryFromNodeList (DSRDocumentSubTree *tree, const size_t pos)
	set internal cursor of a given document tree to a specific node More...

size_t	gotoLastEntryFromNodeList (DSRDocumentSubTree *tree, const size_t lastPos, const size_t firstPos=0)
	set internal cursor of a given document tree to a particular node. More...

virtual OFBool	hasTemplateIdentification () const
	check whether template identification is set More...

virtual OFBool	isTemplateIdentificationValid (const OFBool check=OFTrue) const
	check whether template identification is valid More...

virtual OFBool	isExtensible () const
	check whether template is extensible More...

virtual OFBool	isOrderSignificant () const
	check whether the order of content items in this template is significant More...

virtual OFBool	compareTemplateIdentication (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
	compare template identification with given values More...

const OFString &	getTemplateIdentifier () const
	get template identifier More...

const OFString &	getMappingResource () const
	get mapping resource More...

const OFString &	getMappingResourceUID () const
	get optional mapping resource UID More...

virtual void	setExtensible (const OFBool mode=OFTrue)
	change mode specifying whether the template is extensible or non-extensible More...

virtual void	setOrderSignificant (const OFBool mode=OFTrue)
	change mode specifying whether the order of content items in this template is significant or non-significant More...

Static Protected Member Functions
static OFBool	anyDescriptorsToBeAdded (const AddImageMode mode, const ConceptNameList &descriptors)
	check whether there are any descriptors to be added (based on given parameters) More...

static OFBool	checkDescriptorToBeAdded (const DSRBasicCodedEntry &conceptName, const AddImageMode mode, const ConceptNameList &descriptors)
	check whether a given descriptor should be added (based on further parameters) More...

static OFCondition	addStringContentItemFromDataset (DSRDocumentSubTree &tree, DcmItem &dataset, const DcmTagKey &tagKey, const signed long pos, const E_ValueType valueType, const DSRCodedEntryValue &conceptName, const OFString &annotationText, const OFBool check)
	add a content item with a string value copied from the given dataset. More...

static OFCondition	addCodeContentItemFromDataset (DSRDocumentSubTree &tree, DcmItem &dataset, const DcmTagKey &tagKey, const DSRCodedEntryValue &conceptName, const OFString &annotationText, const OFBool check)
	add a CODE content item with a coded entry value copied from the given dataset. More...

static OFCondition	addNumericContentItemFromDataset (DSRDocumentSubTree &tree, DcmItem &dataset, const DcmTagKey &tagKey, const signed long pos, const DSRCodedEntryValue &conceptName, const DSRCodedEntryValue &measurementUnit, const OFString &annotationText, const OFBool check)
	add a NUM content item with a numeric value copied from the given dataset. More...

Static Protected Member Functions inherited from DSRDocumentSubTree
static DSRDocumentSubTree *	cloneSubTree (const DSRDocumentTreeNodeCursor &startCursor, const size_t stopAfterNodeID=0)
	clone a particular subtree, i.e. a fragment of a tree More...

Additional Inherited Members
Protected Attributes inherited from DSRDocumentSubTree
DSRIODConstraintChecker *	ConstraintChecker
	check relationship content constraints of the associated IOD

Detailed Description

Implementation of DCMR Template: TID 1600 - Image Library (and included templates 1601-1607).

All added content items are annotated with a text in the format "TID 1600 - Row [n]".

Note: Please note that most DICOM element values are copied from the main dataset only and not yet from the respective functional group macros.

Member Enumeration Documentation

◆ AddImageMode

enum TID1600_ImageLibrary::AddImageMode

add mode for image entries

Enumerator
withoutDescriptors	add image entry without descriptors
withAllDescriptors	add image entry with all descriptors from TID 1602 (and included templates)
withSelectedDescriptors	add image entry with selected descriptors only (from given list of concept names)
withoutSelectedDescriptors	add image entry with all but the selected descriptors (from given list of concept names)

Constructor & Destructor Documentation

◆ TID1600_ImageLibrary()

TID1600_ImageLibrary::TID1600_ImageLibrary ( const OFBool createLibrary = OFTrue )

(default) constructor

Parameters

createLibrary flag indicating whether to create an empty image library by calling createImageLibrary() during startup (default)

Member Function Documentation

◆ addCodeContentItemFromDataset()

static OFCondition TID1600_ImageLibrary::addCodeContentItemFromDataset	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const DcmTagKey &	tagKey,
		const DSRCodedEntryValue &	conceptName,
		const OFString &	annotationText,
		const OFBool	check
	)

staticprotected

add a CODE content item with a coded entry value copied from the given dataset.

The content item is only created and added to the subtree if the specified code sequence is present in the 'dataset' and its value is valid (not empty).

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
tagKey	DICOM tag specifying the code sequence attribute from which the coded entry should be retrieved
conceptName	concept name of the content item to be added
annotationText	optional text used to annotate the content item
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addComputedTomographyDescriptors()

OFCondition TID1600_ImageLibrary::addComputedTomographyDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors for CT (TID 1605)

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addCrossSectionalModalitiesDescriptors()

OFCondition TID1600_ImageLibrary::addCrossSectionalModalitiesDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors for cross-sectional modalities (TID 1604)

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addImageEntry()

OFCondition TID1600_ImageLibrary::addImageEntry	(	DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors = `ConceptNameList()`,
		const OFBool	check = `OFTrue`
	)

add an image entry to the current image group, i.e. add content items for TID 1601 (Image Library Entry).

The values of the content items (including the image reference) are copied from the data elements of the given 'dataset'. If no descriptors were added, CMR_EC_NoImageLibraryEntryDescriptorsToBeAdded is returned, which is not regarded as an error.

Parameters

dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	optional list with concept names of descriptors. Its use and interpretation depends on the value of 'mode'.
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise. If no image group exists, CMR_EC_NoImageLibraryGroup is returned.

◆ addImageEntryDescriptors()

OFCondition TID1600_ImageLibrary::addImageEntryDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors (TID 1602) to given document subtree.

This method also calls addModalitySpecificDescriptors() in order to add the included templates (TID 1603 to 1607).

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addImageGroup()

OFCondition TID1600_ImageLibrary::addImageGroup ( )

add an image group to the image library.

Image descriptors that are common to all images in this group can be added by calling addImageGroupDescriptors().

Returns: status, EC_Normal if successful, an error code otherwise

◆ addImageGroupDescriptors()

OFCondition TID1600_ImageLibrary::addImageGroupDescriptors	(	DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors = `ConceptNameList()`,
		const OFBool	check = `OFTrue`
	)

add common image descriptors to the current image group, i.e. add content items items for TID 1602 (Image Library Entry Descriptors) and included templates.

The values of the content items are copied from the data elements of the given 'dataset'. If none were added, CMR_EC_NoImageLibraryEntryDescriptorsToBeAdded is returned, which is not regarded as an error. Please note that this method should be called only once for each image group. Alternatively, moveCommonImageDescriptorsToImageGroups() could be called to move common image descriptors to their respective image groups automatically.

Parameters

dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	optional list with concept names of descriptors. Its use and interpretation depends on the value of 'mode'.
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise. If no image group exists, CMR_EC_NoImageLibraryGroup is returned.

◆ addMagneticResonanceDescriptors()

OFCondition TID1600_ImageLibrary::addMagneticResonanceDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors for MR (TID 1606)

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addModalitySpecificDescriptors()

OFCondition TID1600_ImageLibrary::addModalitySpecificDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const OFString &	modality,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors (TID 1603 to 1607) to given document subtree depending on the given 'modality'.

Warning: The mapping of modality to included templates is probably not perfect yet. Also please note that most DICOM element values are copied from the main dataset and not from the respective functional group macros.

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
modality	value of the Modality (0008,0060) attribute from 'dataset'
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addNumericContentItemFromDataset()

static OFCondition TID1600_ImageLibrary::addNumericContentItemFromDataset	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const DcmTagKey &	tagKey,
		const signed long	pos,
		const DSRCodedEntryValue &	conceptName,
		const DSRCodedEntryValue &	measurementUnit,
		const OFString &	annotationText,
		const OFBool	check
	)

staticprotected

add a NUM content item with a numeric value copied from the given dataset.

The content item is only created and added to the subtree if the specified data element is present in the 'dataset' and its value (retrieved as a string) is not empty.

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
tagKey	DICOM tag specifying the attribute from which the string value should be retrieved
pos	index of the value to get (0..vm-1), -1 for all components
conceptName	concept name of the content item to be added
measurementUnit	measurement unit to be used for the numeric content item
annotationText	optional text used to annotate the content item
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addPositronEmissionTomographyDescriptors()

OFCondition TID1600_ImageLibrary::addPositronEmissionTomographyDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors for PET (TID 1607).

Note: The template rows 10 to 15 are not yet supported by this method.

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addProjectionRadiographyDescriptors()

OFCondition TID1600_ImageLibrary::addProjectionRadiographyDescriptors	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors,
		const OFBool	check
	)

protected

add image library entry descriptors for projection radiography (TID 1603)

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
mode	mode specifying which optional content items are to be added
descriptors	list with concept names of descriptors (depends on 'mode')
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ addStringContentItemFromDataset()

static OFCondition TID1600_ImageLibrary::addStringContentItemFromDataset	(	DSRDocumentSubTree &	tree,
		DcmItem &	dataset,
		const DcmTagKey &	tagKey,
		const signed long	pos,
		const E_ValueType	valueType,
		const DSRCodedEntryValue &	conceptName,
		const OFString &	annotationText,
		const OFBool	check
	)

staticprotected

add a content item with a string value copied from the given dataset.

The content item is only created and added to the subtree if the specified data element is present in the 'dataset' and its string value is not empty.

Parameters

tree	subtree to which the content items should be added
dataset	DICOM dataset from which the values should be copied
tagKey	DICOM tag specifying the attribute from which the string value should be retrieved
pos	index of the value to get (0..vm-1), -1 for all components
valueType	value type of the content item to be added
conceptName	concept name of the content item to be added
annotationText	optional text used to annotate the content item
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ anyDescriptorsToBeAdded()

static OFBool TID1600_ImageLibrary::anyDescriptorsToBeAdded	(	const AddImageMode	mode,
		const ConceptNameList &	descriptors
	)

staticprotected

check whether there are any descriptors to be added (based on given parameters)

Parameters

mode	mode specifying what should be checked and how
descriptors	list with concept names of descriptors (depends on 'mode')

Returns: OFTrue if there are any descriptors to be added, OFFalse if not

◆ checkDescriptorToBeAdded()

static OFBool TID1600_ImageLibrary::checkDescriptorToBeAdded	(	const DSRBasicCodedEntry &	conceptName,
		const AddImageMode	mode,
		const ConceptNameList &	descriptors
	)

staticprotected

check whether a given descriptor should be added (based on further parameters)

Parameters

conceptName	concept name of the descriptor to be checked
mode	mode specifying what should be checked and how
descriptors	list with concept names of descriptors to be checked (depending on the given 'mode')

Returns: OFTrue if given descriptor should be added, OFFalse if not

◆ createImageLibrary()

OFCondition TID1600_ImageLibrary::createImageLibrary ( )

protected

create the mandatory content item 'Image Library' (TID 1600 - Row 1) as the root node of this template.

It is expected that the tree is currently empty.

Returns: status, EC_Normal if successful, an error code otherwise

◆ createNewImageLibrary()

OFCondition TID1600_ImageLibrary::createNewImageLibrary ( )

clear the internally stored tree of content items and create the mandatory content item 'Image Library' (TID 1600 - Row 1) as the root node of this template

Returns: status, EC_Normal if successful, an error code otherwise

◆ getImageEntryModality()

OFCondition TID1600_ImageLibrary::getImageEntryModality ( DSRCodedEntryValue & modalityCode )

go to the most recently added image library entry and get the value of the descriptor 'Modality' (TID 1602 - Row 1)

Parameters

modalityCode reference to coded entry that will store the result (cleared if an error occurs)

Returns: status, EC_Normal if successful, an error code otherwise

◆ goAndCheckImageLibraryEntry()

OFCondition TID1600_ImageLibrary::goAndCheckImageLibraryEntry ( const DSRCodedEntryValue & modalityCode )

protected

go to the most recently added image library entry and check the value of the associated descriptor 'Modality' (TID 1602 - Row 1)

Parameters

modalityCode coded entry (from CID 29) associated with the modality. Used to check the image library entry.

Returns: status, EC_Normal if successful, an error code otherwise

◆ hasImageLibrary()

OFBool TID1600_ImageLibrary::hasImageLibrary ( ) const

check whether the content item 'Image Library' (TID 1600 - Row 1) is present.

Initially, this mandatory content item is created by the constructor of this class (if not disabled). After clear() has been called, it can be created again by calling createNewImageLibrary().

Returns: OFTrue if the image library is present, OFFalse otherwise

◆ hasImageLibraryGroup()

OFBool TID1600_ImageLibrary::hasImageLibraryGroup ( ) const

check whether there is an image group in this image library (TID 1600 - Row 2)

Returns: OFTrue if at least one image group is present, OFFalse otherwise

◆ isValid()

virtual OFBool TID1600_ImageLibrary::isValid ( ) const

virtual

check whether the current internal state is valid.

That means, whether the base class is valid and hasImageLibrary() returns true.

Returns: OFTrue if valid, OFFalse otherwise

Reimplemented from DSRSubTemplate.

◆ moveCommonImageDescriptorsToImageGroups()

OFCondition TID1600_ImageLibrary::moveCommonImageDescriptorsToImageGroups ( )

move common image descriptors from all image entries in this image library to their respective image groups.

This method should usually be called after all image entries have been added using addImageEntry(). If no descriptors were moved, CMR_EC_NoImageLibraryEntryDescriptorsToBeMoved is returned, which is not regarded as an error.

Returns: status, EC_Normal if successful, an error code otherwise

◆ setCodeContentItemFromValue()

OFCondition TID1600_ImageLibrary::setCodeContentItemFromValue	(	const DSRCodedEntryValue &	conceptName,
		const DSRCodedEntryValue &	codeValue,
		const OFString &	annotationText,
		const OFBool	check
	)

protected

search for a particular CODE content item (given by the concept name) and set its coded entry value.

If not found, a new content item is added to the current position and the value is set.

Parameters

conceptName	concept name of the content item to be set/added
codeValue	coded entry value of the content item to be set/added
annotationText	text used to annotate the content item (might be empty)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setNumericContentItemFromValue()

OFCondition TID1600_ImageLibrary::setNumericContentItemFromValue	(	const DSRCodedEntryValue &	conceptName,
		const DSRNumericMeasurementValue &	numericValue,
		const DSRCodedEntryValue &	measurementUnit,
		const OFString &	annotationText,
		const OFBool	check
	)

protected

search for a particular NUM content item (given by the concept name) and set its numeric measurement value.

If not found, a new content item is added to the current position and the value is set.

Parameters

conceptName	concept name of the content item to be set/added
numericValue	numeric measurement value of the content item to be set/added
measurementUnit	measurement unit that should be used by 'numericValue' (optional, might be empty). Used for checking purposes.
annotationText	text used to annotate the content item (might be empty)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadionuclide()

OFCondition TID1600_ImageLibrary::setPETImageRadionuclide	(	const CID4020_PETRadionuclide &	radionuclide,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radionuclide' (TID 1607 - Row 1) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

radionuclide	coded entry to be set (from CID 4020 - PET Radionuclide)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadionuclideTotalDose()

OFCondition TID1600_ImageLibrary::setPETImageRadionuclideTotalDose	(	const CMR_SRNumericMeasurementValue &	totalDose,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radiopharmaceutical Total Dose' (TID 1607 - Row 7) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

totalDose	numeric measurement value to be set (measurement unit should be CODE_UCUM_Bq or a coded entry that is identical to this)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadiopharmaceuticalAgent()

OFCondition TID1600_ImageLibrary::setPETImageRadiopharmaceuticalAgent	(	const CID4021_PETRadiopharmaceutical &	agent,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radiopharmaceutical Agent' (TID 1607 - Row 2) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

agent	coded entry to be set (from CID 4021 - PET Radiopharmaceutical)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadiopharmaceuticalStartDateTime()

OFCondition TID1600_ImageLibrary::setPETImageRadiopharmaceuticalStartDateTime	(	const OFString &	dateTime,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radiopharmaceutical Start Date Time' (TID 1607 - Row 4) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

dateTime	date/time value to be set (associated DICOM VR=DT)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadiopharmaceuticalStopDateTime()

OFCondition TID1600_ImageLibrary::setPETImageRadiopharmaceuticalStopDateTime	(	const OFString &	dateTime,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radiopharmaceutical Stop Date Time' (TID 1607 - Row 5) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

dateTime	date/time value to be set (associated DICOM VR=DT)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setPETImageRadiopharmaceuticalVolume()

OFCondition TID1600_ImageLibrary::setPETImageRadiopharmaceuticalVolume	(	const CMR_SRNumericMeasurementValue &	volume,
		const OFBool	check = `OFTrue`
	)

set the value of the descriptor 'Radiopharmaceutical Volume' (TID 1607 - Row 6) for the current (most recently added) PET image library entry.

If the content item already exists, its value is overwritten. Otherwise, a new content item is added to the end of the list of image library entry descriptors.

Parameters

volume	numeric measurement value to be set (measurement unit should be CODE_UCUM_cm3 or a coded entry that is identical to this)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

◆ setStringContentItemFromValue()

OFCondition TID1600_ImageLibrary::setStringContentItemFromValue	(	const E_ValueType	valueType,
		const DSRCodedEntryValue &	conceptName,
		const OFString &	stringValue,
		const OFString &	annotationText,
		const OFBool	check
	)

protected

search for a particular content item (given by the concept name and value type) and set its string value.

If not found, a new content item is added to the current position and the value is set.

Parameters

valueType	value type of the content item to be set/added
conceptName	concept name of the content item to be set/added
stringValue	string value of the content item to be set/added
annotationText	text used to annotate the content item (might be empty)
check	if enabled, check values for validity before setting them

Returns: status, EC_Normal if successful, an error code otherwise

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

dcmsr/include/dcmtk/dcmsr/cmr/tid1600.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AddImageMode

Constructor & Destructor Documentation

◆ TID1600_ImageLibrary()

Member Function Documentation

◆ addCodeContentItemFromDataset()

◆ addComputedTomographyDescriptors()

◆ addCrossSectionalModalitiesDescriptors()

◆ addImageEntry()

◆ addImageEntryDescriptors()

◆ addImageGroup()

◆ addImageGroupDescriptors()

◆ addMagneticResonanceDescriptors()

◆ addModalitySpecificDescriptors()

◆ addNumericContentItemFromDataset()

◆ addPositronEmissionTomographyDescriptors()

◆ addProjectionRadiographyDescriptors()

◆ addStringContentItemFromDataset()

◆ anyDescriptorsToBeAdded()

◆ checkDescriptorToBeAdded()

◆ createImageLibrary()

◆ createNewImageLibrary()

◆ getImageEntryModality()

◆ goAndCheckImageLibraryEntry()

◆ hasImageLibrary()

◆ hasImageLibraryGroup()

◆ isValid()

◆ moveCommonImageDescriptorsToImageGroups()

◆ setCodeContentItemFromValue()

◆ setNumericContentItemFromValue()

◆ setPETImageRadionuclide()

◆ setPETImageRadionuclideTotalDose()

◆ setPETImageRadiopharmaceuticalAgent()

◆ setPETImageRadiopharmaceuticalStartDateTime()

◆ setPETImageRadiopharmaceuticalStopDateTime()

◆ setPETImageRadiopharmaceuticalVolume()

◆ setStringContentItemFromValue()