DICOM dictionary¶
Introduction¶
This chapter describes Dicom Dictionary class which return description and default type of the known DICOM tags.
The following class is described in this chapter:
C++ class |
Objective-C/Swift class |
Description |
|---|---|---|
Returns description and VRs of well known tags |
Dicom Dictionary class¶
DicomDictionary¶
C++¶
-
class
DicomDictionary¶ Provides information about the tag’s description and their default data type (VR).
Public Static Functions
-
static std::wstring
getUnicodeTagDescription(const TagId &id)¶ Retrieve a tag’s description.
- Return
The tag’s description
- Parameters
id: the tag’s id
-
static std::string
getTagDescription(const TagId &id)¶ Retrieve a tag’s description.
- Return
The tag’s description
- Parameters
id: the tag’s id
-
static tagVR_t
getTagType(const TagId &id)¶ Retrieve a tag’s default data type.
- Return
The tag’s data type
- Parameters
id: the tag’s id
-
static std::uint32_t
getMultiplicityMin(const TagId &id)¶ Return the minimum multiplicity value for the tag (the minimum number of values that should be stored in the tag).
- Return
the minimum multiplicity value
- Parameters
id: the tag’s id
-
static std::uint32_t
getMultiplicityMax(const TagId &id)¶ Return the maximum multiplicity value for the tag (the maximum number of values that can be stored in the tag, 0=unlimited).
- Return
the maximum multiplicity value (0=unlimited)
- Parameters
id: the tag’s id
-
static std::uint32_t
getMultiplicityStep(const TagId &id)¶ Return the step multiplicity value for the tag.
- Return
the step multiplicity value
- Parameters
id: the tag’s id
-
static std::wstring
Objective-C/Swift¶
-
class
ImebraDicomDictionary: public NSObject¶ Provides information about the tag’s description and their default data type (VR).
Public Static Functions
-
NSString* ImebraDicomDictionary::getTagDescription:error:(ImebraTagId * tagId, NSError ** pError) Retrieve a tag’s description.
- Return
the tag’s description
- Parameters
tagId: the tag’s idpError: set to NSError derived class in case of error
-
unsigned int ImebraDicomDictionary::getMultiplicityMin:error:(ImebraTagId * tagId, NSError ** pError) Retrieve a tag’s minimum multiplicity value (the minimum number of values that should be stored in the tag).
- Return
the minimum multiplicity value
- Parameters
tagId: the tag’s idpError: set to NSError derived class in case of error
-
unsigned int ImebraDicomDictionary::getMultiplicityMax:error:(ImebraTagId * tagId, NSError ** pError) Retrieve a tag’s maximum multiplicity value (the maximum number of values that should be stored in the tag, 0=unlimited).
- Return
the maximum multiplicity value (0=unlimited)
- Parameters
tagId: the tag’s idpError: set to NSError derived class in case of error
-
unsigned int ImebraDicomDictionary::getMultiplicityStep:error:(ImebraTagId * tagId, NSError ** pError) Retrieve a tag’s step multiplicity value.
- Return
the step multiplicity value
- Parameters
tagId: the tag’s idpError: set to NSError derived class in case of error
-
ImebraTagType ImebraDicomDictionary::getTagType:error:(ImebraTagId * tagId, (swift_error(nonnull_error)) __attribute__) Retrieve a tag’s default data type.
- Return
The tag’s data type
- Parameters
tagId: the tag’s idpError: set to NSError derived class in case of error
-
unsigned int ImebraDicomDictionary::getWordSize:(ImebraTagType dataType) Return the size (in bytes) of the data type’s elements.
- Return
the size of a single element, in bytes. 0 means that there isn’t a fixed size for the element
- Parameters
dataType: the data type for which the information is required
-
unsigned int ImebraDicomDictionary::getMaxSize:(ImebraTagType dataType) Return the maximum size of the tags with the specified data type.
- Return
the maximum tag’s size in bytes
- Parameters
dataType: the data type for which the information is required
-