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

imebra::DicomDictionary

ImebraDicomDictionary

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 getUnicodeTagName(const TagId &id)

Retrieve a tag’s description.

Return

The tag’s description

Parameters
  • id: the tag’s id

static std::string getTagName(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 getWordSize(tagVR_t dataType)

Return the size of the data type’s elements.

Return

the size of a single element

Parameters
  • dataType: the data type for which the information is required

static std::uint32_t getMaxSize(tagVR_t 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

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::getTagName:error:(ImebraTagId * tagId, NSError ** pError)

Retrieve a tag’s description.

Return

the tag’s description

Parameters
  • tagId: the tag’s id

  • pError: set to NSError derived class in case of error

ImebraTagVR_t 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 id

  • pError: set to NSError derived class in case of error

unsigned int ImebraDicomDictionary::getWordSize:(ImebraTagVR_t 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:(ImebraTagVR_t 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