Implementation of DCMR Context Group: CID 4031 - Common Anatomic Regions. More...

Inheritance diagram for CID4031_CommonAnatomicRegions:

Public Types
enum	EnumType { Abdomen, AbdomenAndPelvis, AcromioclavicularJoint, AnkleJoint, Anus, ApexOfLung, BileDuct, Bladder, BoneOfLowerLimb, BoneOfUpperLimb, Breast, Bronchus, Calcaneus, CervicalSpine, CervicoThoracicSpine, Chest, ChestAndAbdomen, ChestAbdomenAndPelvis, Clavicle, Coccyx, Colon, Duodenum, ElbowJoint, EntireBody, Esophagus, EsophagusStomachAndDuodenum, Extremity, Eye, EyeRegion, FacialBones, Femur, Fibula, Finger, Foot, Forearm, Gallbladder, Hand, Head, HeadAndNeck, Heart, HipJoint, Humerus, Ileum, Ilium, InternalAuditoryCanal, JawRegion, Jejunum, Knee, LargeIntestine, Larynx, LowerLeg, LowerLimb, LumbarSpine, LumboSacralSpine, Mandible, MastoidBone, Maxilla, Mediastinum, MuscleOfLowerLimb, MuscleOfUpperLimb, NasalBone, Neck, NeckAndChest, NeckChestAndAbdomen, NeckChestAbdomenAndPelvis, OpticCanal, OrbitalStructure, PancreaticDuctAndBileDuctSystems, ParanasalSinus, ParotidGland, Patella, Pelvis, PelvisAndLowerExtremities, Phantom, Prostate, Rectum, Rib, SacroiliacJoint, Sacrum, Scapula, SellaTurcica, SesamoidBonesOfFoot, Shoulder, Skull, SmallIntestine, Spine, SternoclavicularJoint, Sternum, Stomach, SubmandibularGland, TarsalJoint, TemporomandibularJoint, Thigh, ThoracicSpine, ThoracoLumbarSpine, Thumb, Toe, Trachea, UpperArm, UpperLimb, UpperUrinaryTract, Ureter, Urethra, UterusAndFallopianTubes, VertebralColumnAndCranium, WristJoint, Zygoma }
	types of common anatomic regions More...

Public Member Functions
	CID4031_CommonAnatomicRegions (const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	(default) constructor More...

	CID4031_CommonAnatomicRegions (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	constructor More...

virtual OFCondition	selectValue (const EnumType selectedValue, const OFBool enhancedEncodingMode=OFFalse)
	select a coded entry given by its type as the current value More...

virtual OFCondition	selectValue (const DSRCodedEntryValue &codedEntryValue, const OFBool check=OFTrue, const OFBool definedContextGroup=OFFalse)
	select a given coded entry as the current value More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &codedEntryValue) const
	search for a given coded entry in this context group. More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &searchForCodedEntry, DSRCodedEntryValue *foundCodedEntry, const OFBool enhancedEncodingMode=OFFalse) const
	search for a given coded entry in this context group More...

Public Member Functions inherited from DSRContextGroup
	operator const DSRCodedEntryValue & () const
	conversion operator that returns the currently selected coded entry value (might be empty if none is selected)

virtual void	clear ()
	clear list of extended coded entries and forget about the currently selected coded entry

OFBool	isExtensible () const
	check whether context group is extensible More...

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

const OFString &	getIdentifier () const
	get context identifier More...

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

const OFString &	getVersion () const
	get context group version (optional) More...

const OFString &	getUID () const
	get context group UID (optional) More...

virtual OFBool	hasSelectedValue () const
	check whether a coded entry is selected as the current value More...

const DSRCodedEntryValue &	getSelectedValue () const
	get currently selected coded entry value (optional) More...

virtual OFCondition	selectValue (const DSRCodedEntryValue &codedEntryValue, const OFBool check=OFTrue, const OFBool definedContextGroup=OFFalse)
	select a given coded entry as the current value More...

virtual OFBool	hasCodedEntry (const DSRCodedEntryValue &codedEntryValue) const
	check whether a given coded entry is contained in this context group. More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &codedEntryValue) const
	search for a given coded entry in this context group. More...

virtual OFBool	hasExtendedCodedEntries () const
	check whether this context group has any extended coded entries. More...

virtual OFCondition	addCodedEntry (const DSRCodedEntryValue &codedEntryValue)
	add a coded entry to this context group as an extension, i.e. as a non-standard code. More...

virtual OFCondition	lookupCodedEntry (DSRCodedEntryValue &codedEntryValue, const OFBool enhancedEncodingMode=OFFalse) const
	search for a given coded entry in this context group and, if found, replace its value with the one found in the context group. More...

virtual void	print (STD_NAMESPACE ostream &stream) const
	print contents of this context group, i.e. a general header, the currently selected coded entry value (if any) and all coded entries that are contained in this context group (both standard and extended ones). More...

virtual OFCondition	checkSelectedValue (const OFBool definedContextGroup=OFFalse) const
	check whether the currently selected coded entry is valid. More...

Static Public Member Functions
static void	initialize ()
	initialize this context group explicitly. More...

static void	cleanup ()
	cleanup this context group, i.e. delete the internal list of standard coded entries. More...

static DSRCodedEntryValue	getCodedEntry (const EnumType value, const OFBool enhancedEncodingMode=OFFalse)
	map a given type to the associated coded entry More...

Protected Types
typedef OFMap< EnumType, DSRBasicCodedEntry >	CodeList
	type used for storing and managing the coded entries

Protected Member Functions
virtual void	printCodes (STD_NAMESPACE ostream &stream) const
	print details on coded entries that are contained in this context group. More...

virtual OFCondition	findCodedEntry (const DSRCodedEntryValue &searchForCodedEntry, DSRCodedEntryValue *foundCodedEntry, const OFBool enhancedEncodingMode=OFFalse) const
	search for a given coded entry in this context group More...

Protected Member Functions inherited from DSRContextGroup
	DSRContextGroup (const OFString &contextIdentifier, const OFString &mappingResource, const OFString &contextGroupVersion="", const OFString &contextGroupUID="", const DSRCodedEntryValue &selectedValue=DSRCodedEntryValue())
	constructor More...

virtual	~DSRContextGroup ()
	destructor

virtual void	printHeader (STD_NAMESPACE ostream &stream) const
	print header with some general information on this context group More...

virtual OFCondition	checkCodedEntry (const DSRCodedEntryValue &codedEntryValue, const OFBool definedContextGroup) const
	check whether a given coded entry is valid. More...

Static Protected Member Functions
static CodeList &	getCodes ()
	get list of standard coded entries that are managed by this context group. More...

static OFCondition	setEnhancedEncodingMode (DSRCodedEntryValue &codedEntryValue)
	set the "Enhanced Encoding Mode" for a given coded entry More...

Static Private Attributes
static CodeList *	Codes
	pointer to internal code list (use a static variable for singleton pattern)

Detailed Description

Implementation of DCMR Context Group: CID 4031 - Common Anatomic Regions.

(type: extensible, version: 20170914)

Member Enumeration Documentation

◆ EnumType

enum CID4031_CommonAnatomicRegions::EnumType

types of common anatomic regions

Enumerator
Abdomen	(T-D4000,SRT,"Abdomen")
AbdomenAndPelvis	(R-FAB57,SRT,"Abdomen and Pelvis")
AcromioclavicularJoint	(T-15420,SRT,"Acromioclavicular joint")
AnkleJoint	(T-15750,SRT,"Ankle joint")
Anus	(T-59900,SRT,"Anus")
ApexOfLung	(T-280A0,SRT,"Apex of Lung")
BileDuct	(T-60610,SRT,"Bile duct")
Bladder	(T-74000,SRT,"Bladder")
BoneOfLowerLimb	(T-12700,SRT,"Bone of lower limb")
BoneOfUpperLimb	(T-D0821,SRT,"Bone of upper limb")
Breast	(T-04000,SRT,"Breast")
Bronchus	(T-26000,SRT,"Bronchus")
Calcaneus	(T-12770,SRT,"Calcaneus")
CervicalSpine	(T-11501,SRT,"Cervical spine")
CervicoThoracicSpine	(T-D00F7,SRT,"Cervico-thoracic spine")
Chest	(T-D3000,SRT,"Chest")
ChestAndAbdomen	(R-FAB55,SRT,"Chest and Abdomen")
ChestAbdomenAndPelvis	(R-FAB56,SRT,"Chest, Abdomen and Pelvis")
Clavicle	(T-12310,SRT,"Clavicle")
Coccyx	(T-11BF0,SRT,"Coccyx")
Colon	(T-59300,SRT,"Colon")
Duodenum	(T-58200,SRT,"Duodenum")
ElbowJoint	(T-15430,SRT,"Elbow joint")
EntireBody	(T-D0010,SRT,"Entire body")
Esophagus	(T-56000,SRT,"Esophagus")
EsophagusStomachAndDuodenum	(T-DD163,SRT,"Esophagus, stomach and duodenum")
Extremity	(T-D0300,SRT,"Extremity")
Eye	(T-AA000,SRT,"Eye")
EyeRegion	(T-D0801,SRT,"Eye region")
FacialBones	(T-11196,SRT,"Facial bones")
Femur	(T-12710,SRT,"Femur")
Fibula	(T-12750,SRT,"Fibula")
Finger	(T-D8800,SRT,"Finger")
Foot	(T-D9700,SRT,"Foot")
Forearm	(T-D8500,SRT,"Forearm")
Gallbladder	(T-63000,SRT,"Gallbladder")
Hand	(T-D8700,SRT,"Hand")
Head	(T-D1100,SRT,"Head")
HeadAndNeck	(T-D1000,SRT,"Head and Neck")
Heart	(T-32000,SRT,"Heart")
HipJoint	(T-15710,SRT,"Hip joint")
Humerus	(T-12410,SRT,"Humerus")
Ileum	(T-58600,SRT,"Ileum")
Ilium	(T-12340,SRT,"Ilium")
InternalAuditoryCanal	(T-AB959,SRT,"Internal Auditory Canal")
JawRegion	(T-D1213,SRT,"Jaw region")
Jejunum	(T-58400,SRT,"Jejunum")
Knee	(T-D9200,SRT,"Knee")
LargeIntestine	(T-59000,SRT,"Large intestine")
Larynx	(T-24100,SRT,"Larynx")
LowerLeg	(T-D9400,SRT,"Lower leg")
LowerLimb	(T-D9000,SRT,"Lower limb")
LumbarSpine	(T-11503,SRT,"Lumbar spine")
LumboSacralSpine	(T-D00F9,SRT,"Lumbo-sacral spine")
Mandible	(T-11180,SRT,"Mandible")
MastoidBone	(T-11133,SRT,"Mastoid bone")
Maxilla	(T-11170,SRT,"Maxilla")
Mediastinum	(T-D3300,SRT,"Mediastinum")
MuscleOfLowerLimb	(T-14668,SRT,"Muscle of lower limb")
MuscleOfUpperLimb	(T-13600,SRT,"Muscle of upper limb")
NasalBone	(T-11149,SRT,"Nasal bone")
Neck	(T-D1600,SRT,"Neck")
NeckAndChest	(R-FAB52,SRT,"Neck and Chest")
NeckChestAndAbdomen	(R-FAB53,SRT,"Neck, Chest and Abdomen")
NeckChestAbdomenAndPelvis	(R-FAB54,SRT,"Neck, Chest, Abdomen and Pelvis")
OpticCanal	(T-11102,SRT,"Optic canal")
OrbitalStructure	(T-D14AE,SRT,"Orbital structure")
PancreaticDuctAndBileDuctSystems	(T-65600,SRT,"Pancreatic duct and bile duct systems")
ParanasalSinus	(T-22000,SRT,"Paranasal sinus")
ParotidGland	(T-61100,SRT,"Parotid gland")
Patella	(T-12730,SRT,"Patella")
Pelvis	(T-D6000,SRT,"Pelvis")
PelvisAndLowerExtremities	(R-FAB58,SRT,"Pelvis and lower extremities")
Phantom	(113681,DCM,"Phantom")
Prostate	(T-92000,SRT,"Prostate")
Rectum	(T-59600,SRT,"Rectum")
Rib	(T-11300,SRT,"Rib")
SacroiliacJoint	(T-15680,SRT,"Sacroiliac joint")
Sacrum	(T-11AD0,SRT,"Sacrum")
Scapula	(T-12280,SRT,"Scapula")
SellaTurcica	(T-D1460,SRT,"Sella turcica")
SesamoidBonesOfFoot	(T-12980,SRT,"Sesamoid bones of foot")
Shoulder	(T-D2220,SRT,"Shoulder")
Skull	(T-11100,SRT,"Skull")
SmallIntestine	(T-58000,SRT,"Small intestine")
Spine	(T-D04FF,SRT,"Spine")
SternoclavicularJoint	(T-15610,SRT,"Sternoclavicular joint")
Sternum	(T-11210,SRT,"Sternum")
Stomach	(T-57000,SRT,"Stomach")
SubmandibularGland	(T-61300,SRT,"Submandibular gland")
TarsalJoint	(T-15770,SRT,"Tarsal joint")
TemporomandibularJoint	(T-15290,SRT,"Temporomandibular joint")
Thigh	(T-D9100,SRT,"Thigh")
ThoracicSpine	(T-11502,SRT,"Thoracic spine")
ThoracoLumbarSpine	(T-D00F8,SRT,"Thoraco-lumbar spine")
Thumb	(T-D8810,SRT,"Thumb")
Toe	(T-D9800,SRT,"Toe")
Trachea	(T-25000,SRT,"Trachea")
UpperArm	(T-D8200,SRT,"Upper arm")
UpperLimb	(T-D8000,SRT,"Upper limb")
UpperUrinaryTract	(T-7000B,SRT,"Upper urinary tract")
Ureter	(T-73000,SRT,"Ureter")
Urethra	(T-75000,SRT,"Urethra")
UterusAndFallopianTubes	(T-88920,SRT,"Uterus and fallopian tubes")
VertebralColumnAndCranium	(T-11011,SRT,"Vertebral column and cranium")
WristJoint	(T-15460,SRT,"Wrist joint")
Zygoma	(T-11166,SRT,"Zygoma")

Constructor & Destructor Documentation

◆ CID4031_CommonAnatomicRegions() [1/2]

CID4031_CommonAnatomicRegions::CID4031_CommonAnatomicRegions ( const DSRCodedEntryValue & selectedValue = DSRCodedEntryValue() )

(default) constructor

Parameters

selectedValue coded entry to be selected as the current value (optional). Should be a valid code according to the DICOM definitions for this context group, i.e. no checks are performed. Call DSRContextGroup::checkSelectedValue() if needed.

◆ CID4031_CommonAnatomicRegions() [2/2]

CID4031_CommonAnatomicRegions::CID4031_CommonAnatomicRegions	(	const EnumType	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

constructor

Parameters

selectedValue	type mapped to a coded entry that is selected as the current value
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Member Function Documentation

◆ cleanup()

static void CID4031_CommonAnatomicRegions::cleanup ( )

static

cleanup this context group, i.e. delete the internal list of standard coded entries.

Usually, there is no need to call this method, but it might be useful in order to explicitly free the associated memory, e.g. when checking for memory leaks. The list will be recreated automatically when needed (or when initialize() is called).

◆ findCodedEntry() [1/3]

virtual OFCondition DSRContextGroup::findCodedEntry

search for a given coded entry in this context group.

If found, the type of the entry (standard or extension) is returned:

SR_EC_CodedEntryInStandardContextGroup
SR_EC_CodedEntryIsExtensionOfContextGroup

Parameters

codedEntryValue coded entry to be searched for

Returns: result of the search process, SR_EC_CodedEntryNotInContextGroup if coded entry could not be found. Use OFCondition::good() or OFCondition::bad() if not interested in the type of the entry.

◆ findCodedEntry() [2/3]

virtual OFCondition DSRContextGroup::findCodedEntry

search for a given coded entry in this context group

Parameters

searchForCodedEntry	coded entry to be searched for
foundCodedEntry	pointer to variable that will store the coded entry (if found and pointer is not NULL)
enhancedEncodingMode	set enhanced encoding mode for coded entry (not used for this class, only in derived classes)

Returns: result of the search process, also defines the type of the entry

◆ findCodedEntry() [3/3]

virtual OFCondition CID4031_CommonAnatomicRegions::findCodedEntry	(	const DSRCodedEntryValue &	searchForCodedEntry,
		DSRCodedEntryValue *	foundCodedEntry,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)		const

protectedvirtual

search for a given coded entry in this context group

Parameters

searchForCodedEntry	coded entry to be searched for
foundCodedEntry	pointer to variable that will store the coded entry (if found and pointer is not NULL)
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Returns: result of the search process, also defines the type of the entry

Reimplemented from DSRContextGroup.

◆ getCodedEntry()

static DSRCodedEntryValue CID4031_CommonAnatomicRegions::getCodedEntry	(	const EnumType	value,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

static

map a given type to the associated coded entry

Parameters

value	type that should be mapped to a coded entry
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

Returns: coded entry that is associated with the given type

◆ getCodes()

static CodeList& CID4031_CommonAnatomicRegions::getCodes ( )

staticprotected

get list of standard coded entries that are managed by this context group.

Internally, the singleton pattern is used, so the list is initialized only once. Please note that this function is not thread-safe. Therefore, the initialize() function can be called before any instance of this class is actually used.

Returns: reference to list of coded entries managed by this context group

◆ initialize()

static void CID4031_CommonAnatomicRegions::initialize ( )

static

initialize this context group explicitly.

Internally, the list of standard coded entries is created and initialized by calling getCodes().

Note: This function can be called multiple times but in case of multi-threaded applications should be called at least once before any instance of this class is actually used. For single-threaded applications, there is no need to call it since the initialization is done implicitly.

◆ printCodes()

virtual void CID4031_CommonAnatomicRegions::printCodes ( STD_NAMESPACE ostream & stream ) const

protectedvirtual

print details on coded entries that are contained in this context group.

See DSRCodedEntryValue::print() for details of the coded entry output.

Parameters

stream stream to which the output should be printed

Reimplemented from DSRContextGroup.

◆ selectValue() [1/2]

virtual OFCondition CID4031_CommonAnatomicRegions::selectValue	(	const EnumType	selectedValue,
		const OFBool	enhancedEncodingMode = `OFFalse`
	)

virtual

select a coded entry given by its type as the current value

Parameters

selectedValue	type mapped to a coded entry that is selected as the current value
enhancedEncodingMode	set enhanced encoding mode for coded entry (if enabled)

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

◆ selectValue() [2/2]

virtual OFCondition DSRContextGroup::selectValue

select a given coded entry as the current value

Parameters

codedEntryValue	coded entry to be selected as the current value
check	if enabled, check 'codedEntryValue' for validity and appropriateness before selecting it as the current value. See checkSelectedValue() for details.
definedContextGroup	flag indicating whether this context group is used as a baseline (default) or defined context group. The first means that the list of coded entries in this context group is just a suggestion. The latter means that one of the coded entries should be used.

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

◆ setEnhancedEncodingMode()

static OFCondition CID4031_CommonAnatomicRegions::setEnhancedEncodingMode ( DSRCodedEntryValue & codedEntryValue )

staticprotected

set the "Enhanced Encoding Mode" for a given coded entry

Parameters

codedEntryValue coded entry for which the enhanced encoding mode is set

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/cid4031.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EnumType

Constructor & Destructor Documentation

◆ CID4031_CommonAnatomicRegions() [1/2]

◆ CID4031_CommonAnatomicRegions() [2/2]

Member Function Documentation

◆ cleanup()

◆ findCodedEntry() [1/3]

◆ findCodedEntry() [2/3]

◆ findCodedEntry() [3/3]

◆ getCodedEntry()

◆ getCodes()

◆ initialize()

◆ printCodes()

◆ selectValue() [1/2]

◆ selectValue() [2/2]

◆ setEnhancedEncodingMode()