MeVisLab Toolbox Reference
ml::DICOMTagInformation::DICOMTagDescriptions Class Reference

Container to manage some tag information such as the indexes to all appearances of the tag in DICOMTagFullInfos and a bit mask indicating which types the tag can have. More...

#include <mlDICOMTagDescriptions.h>

Static Public Member Functions

static const DICOMTagDescriptionsgetDICOMTagDescriptions ()
 Function which returns a reference to all available DICOMTagDescriptions. More...
 
static bool getTagInformation (const DCMTree::TagId &tagId, const std::string &prefix, std::string *chapterIndex=nullptr, std::string *chapterName=nullptr, std::string *tagTextName=nullptr, std::string *tagType=nullptr, std::string *tagDesc=nullptr)
 Returns descriptive information in passed non-nullptr string arguments about the given tag id. More...
 

Public Attributes

std::map< DCMTree::RawTagId, size_t > idToFirstDescEntry
 Map storing a mapping of DCMTree::RawTagId values to first matching entry of DICOMTagFullInfos. More...
 
std::map< std::string, DICOMTagInfoEntrytagTypeBits
 Map storing type bits and table entries where it appears for all tag ids. More...
 
std::vector< size_t > Type1Tags
 Indexes of tags only of type "1 ". More...
 
std::vector< size_t > Type1CTags
 Indexes of tags only of type "1C". More...
 
std::vector< size_t > Type2Tags
 Indexes of tags only of type "2 ". More...
 
std::vector< size_t > Type2CTags
 Indexes of tags only of type "2C". More...
 
std::vector< size_t > Type3Tags
 Indexes of tags only of type "3 ". More...
 
std::vector< size_t > Type1AndOtherTags
 Indexes of mixed tags of at least a type 1 or type 1C and at least another type. More...
 
std::vector< size_t > Type2AndOtherTags
 Indexes of mixed tags which are at least of two of the the types 2, 2C, 3 or other, but not of type 1 or 1C. More...
 
std::vector< size_t > TypeUnknownTags
 Indexes of all other tags having unidentified types. More...
 

Detailed Description

Container to manage some tag information such as the indexes to all appearances of the tag in DICOMTagFullInfos and a bit mask indicating which types the tag can have.

Definition at line 101 of file mlDICOMTagDescriptions.h.

Member Function Documentation

◆ getDICOMTagDescriptions()

static const DICOMTagDescriptions& ml::DICOMTagInformation::DICOMTagDescriptions::getDICOMTagDescriptions ( )
static

Function which returns a reference to all available DICOMTagDescriptions.

◆ getTagInformation()

static bool ml::DICOMTagInformation::DICOMTagDescriptions::getTagInformation ( const DCMTree::TagId tagId,
const std::string &  prefix,
std::string *  chapterIndex = nullptr,
std::string *  chapterName = nullptr,
std::string *  tagTextName = nullptr,
std::string *  tagType = nullptr,
std::string *  tagDesc = nullptr 
)
static

Returns descriptive information in passed non-nullptr string arguments about the given tag id.

This information is added separated with ", " in all cases except of tagDesc where a separation with newlines is performed.

Parameters
tagIdId of the tag whose information shall be retrieved.
prefixString prefix to add before each added line".
chapterIndexChapter index in DICOM standard where the tag is described, for example C.7.6.14-1.
chapterNameChapter name in DICOM standard where the tag is described, for example "ACQUISITION CONTEXT MODULE ATTRIBUTES".
tagTextNameDefined name of the tag, for example "Acquisition Context Sequence".
tagTypeType of the tag in its section, for example "2 ", (filled with leading spaces to have 2 chars).
tagDescA free text description of the tag.
Returns
true if useful tag information is found and returned in passed arguments for the given id, false otherwise. In the case of a false return all passed non-nullptr strings are reset to "".

Member Data Documentation

◆ idToFirstDescEntry

std::map< DCMTree::RawTagId, size_t > ml::DICOMTagInformation::DICOMTagDescriptions::idToFirstDescEntry

Map storing a mapping of DCMTree::RawTagId values to first matching entry of DICOMTagFullInfos.

Definition at line 105 of file mlDICOMTagDescriptions.h.

◆ tagTypeBits

std::map< std::string, DICOMTagInfoEntry > ml::DICOMTagInformation::DICOMTagDescriptions::tagTypeBits

Map storing type bits and table entries where it appears for all tag ids.

Definition at line 108 of file mlDICOMTagDescriptions.h.

◆ Type1AndOtherTags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type1AndOtherTags

Indexes of mixed tags of at least a type 1 or type 1C and at least another type.

Definition at line 126 of file mlDICOMTagDescriptions.h.

◆ Type1CTags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type1CTags

Indexes of tags only of type "1C".

Definition at line 114 of file mlDICOMTagDescriptions.h.

◆ Type1Tags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type1Tags

Indexes of tags only of type "1 ".

Definition at line 111 of file mlDICOMTagDescriptions.h.

◆ Type2AndOtherTags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type2AndOtherTags

Indexes of mixed tags which are at least of two of the the types 2, 2C, 3 or other, but not of type 1 or 1C.

Definition at line 130 of file mlDICOMTagDescriptions.h.

◆ Type2CTags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type2CTags

Indexes of tags only of type "2C".

Definition at line 120 of file mlDICOMTagDescriptions.h.

◆ Type2Tags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type2Tags

Indexes of tags only of type "2 ".

Definition at line 117 of file mlDICOMTagDescriptions.h.

◆ Type3Tags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::Type3Tags

Indexes of tags only of type "3 ".

Definition at line 123 of file mlDICOMTagDescriptions.h.

◆ TypeUnknownTags

std::vector< size_t > ml::DICOMTagInformation::DICOMTagDescriptions::TypeUnknownTags

Indexes of all other tags having unidentified types.

Definition at line 133 of file mlDICOMTagDescriptions.h.


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