Class to represent a DICOM Data Element (Attribute) Tag (Group, Element). More...

#include <gdcmTag.h>

Inheritance diagram for gdcm::Tag:

Public Member Functions
	Tag (const Tag &_val)

	Tag (uint16_t group, uint16_t element)
	Constructor with 2*uint16_t.

	Tag (uint32_t tag=0)
	Constructor with 1*uint32_t Prefer the cstor that takes two uint16_t.

uint16_t	GetElement () const
	Returns the 'Element number' of the given Tag.

uint32_t	GetElementTag () const
	Returns the full tag value of the given Tag.

uint16_t	GetGroup () const
	Returns the 'Group number' of the given Tag.

uint32_t	GetLength () const
	return the length of tag (read: size on disk)

Tag	GetPrivateCreator () const
	Return the Private Creator Data Element tag of a private data element.

bool	IsGroupLength () const
	return whether the tag correspond to a group length tag:

bool	IsGroupXX (const Tag &t) const
	e.g 6002,3000 belong to groupXX: 6000,3000

bool	IsIllegal () const
	return if the tag is considered to be an illegal tag

bool	IsPrivate () const

bool	IsPrivateCreator () const

bool	IsPublic () const

bool	operator!= (const Tag &_val) const

bool	operator< (const Tag &_val) const

bool	operator<= (const Tag &t2) const

Tag &	operator= (const Tag &_val)

bool	operator== (const Tag &_val) const

uint16_t &	operator[] (const unsigned int &_id)
	Returns the Group or Element of the given Tag, depending on id (0/1)

const uint16_t &	operator[] (const unsigned int &_id) const
	Returns the Group or Element of the given Tag, depending on id (0/1)

std::string	PrintAsContinuousString () const

std::string	PrintAsContinuousUpperCaseString () const
	Same as PrintAsContinuousString, but hexadecimal [a-f] are printed using upper case.

std::string	PrintAsPipeSeparatedString () const

template<typename TSwap >
std::istream &	Read (std::istream &is)
	Read a tag from binary representation.

bool	ReadFromCommaSeparatedString (const char *str)

bool	ReadFromContinuousString (const char *str)

bool	ReadFromPipeSeparatedString (const char *str)

void	SetElement (uint16_t element)
	Sets the 'Element number' of the given Tag.

void	SetElementTag (uint16_t group, uint16_t element)
	Sets the 'Group number' & 'Element number' of the given Tag.

void	SetElementTag (uint32_t tag)
	Sets the full tag value of the given Tag.

void	SetGroup (uint16_t group)
	Sets the 'Group number' of the given Tag.

void	SetPrivateCreator (Tag const &t)
	Set private creator:

template<typename TSwap >
const std::ostream &	Write (std::ostream &os) const
	Write a tag in binary rep.

Friends
std::ostream &	operator<< (std::ostream &_os, const Tag &_val)

std::istream &	operator>> (std::istream &_is, Tag &_val)

Detailed Description

Class to represent a DICOM Data Element (Attribute) Tag (Group, Element).

Basically an uint32_t which can also be expressed as two uint16_t (group and element)

Note: DATA ELEMENT TAG: A unique identifier for a Data Element composed of an ordered pair of numbers (a Group Number followed by an Element Number). GROUP NUMBER: The first number in the ordered pair of numbers that makes up a Data Element Tag. ELEMENT NUMBER: The second number in the ordered pair of numbers that makes up a Data Element Tag.

Examples: BasicAnonymizer.cs, BasicImageAnonymizer.cs, ChangeSequenceUltrasound.cxx, Cleaner.cs, ClinicalTrialAnnotate.cxx, ClinicalTrialIdentificationWorkflow.cs, CreateARGBImage.cxx, CreateCMYKImage.cxx, CreateFakeRTDOSE.cxx, CreateJPIPDataSet.cxx, DecompressImage.cs, DeriveSeries.cxx, DumpToSQLITE3.cxx, DumpVisusChange.cxx, DuplicatePCDE.cxx, EncapsulateFileInRawData.cxx, ExtractEncapsulatedFile.cs, ExtractEncryptedContent.cxx, Extracting_All_Resolution.cxx, Fake_Image_Using_Stream_Image_Writer.cxx, FileAnonymize.cs, FileChangeTS.cs, FileChangeTSLossy.cs, FixBrokenJ2K.cxx, FixJAIBugJPEGLS.cxx, GenAllVR.cxx, GenFakeIdentifyFile.cxx, GenFakeImage.cxx, GenLongSeqs.cxx, GenSeqs.cxx, GetJPEGSamplePrecision.cxx, GetSequenceUltrasound.cxx, GetSubSequenceData.cxx, LargeVRDSExplicit.cxx, MakeTemplate.cxx, ManipulateFile.cs, MergeTwoFiles.cxx, MpegVideoInfo.cs, PatchFile.cxx, PublicDict.cxx, ReadAndDumpDICOMDIR.cxx, ReadAndDumpDICOMDIR2.cxx, ReadAndPrintAttributes.cxx, ReadExplicitLengthSQIVR.cxx, ScanDirectory.cs, SimpleScanner.cxx, SortImage.cxx, StreamImageReaderTest.cxx, TraverseModules.cxx, VolumeSorter.cxx, gdcmrtionplan.cxx, gdcmrtplan.cxx, iU22tomultisc.cxx, pmsct_rgb1.cxx, and rle2img.cxx.

Constructor & Destructor Documentation

◆ Tag() [1/3]

gdcm::Tag::Tag	(	uint16_t	group,
		uint16_t	element
	)

inline

Constructor with 2*uint16_t.

◆ Tag() [2/3]

gdcm::Tag::Tag ( uint32_t tag = 0 )

inline

Constructor with 1*uint32_t Prefer the cstor that takes two uint16_t.

◆ Tag() [3/3]

gdcm::Tag::Tag ( const Tag & _val )

inline

References tag.

Member Function Documentation

◆ GetElement()

uint16_t gdcm::Tag::GetElement ( ) const

inline

Returns the 'Element number' of the given Tag.

Examples: DuplicatePCDE.cxx, and PublicDict.cxx.

Referenced by gdcm::PrivateTag::PrivateTag(), gdcm::DataSet::ComputeGroupLength(), IsGroupXX(), gdcm::PrivateDict::PrintXML(), gdcm::SequenceOfFragments::ReadValue(), and SetPrivateCreator().

◆ GetElementTag()

uint32_t gdcm::Tag::GetElementTag ( ) const

inline

Returns the full tag value of the given Tag.

Referenced by gdcm::PrivateTag::operator!=(), gdcm::PrivateTag::operator!=(), gdcm::PrivateTag::operator=(), gdcm::PrivateTag::operator==(), and gdcm::PrivateTag::operator==().

◆ GetGroup()

uint16_t gdcm::Tag::GetGroup ( ) const

inline

Returns the 'Group number' of the given Tag.

Examples: DuplicatePCDE.cxx, and GenAllVR.cxx.

Referenced by gdcm::DataSet::ComputeGroupLength(), gdcm::DataSet::Insert(), gdcm::FileMetaInformation::Insert(), gdcm::CommandDataSet::Insert(), IsGroupXX(), gdcm::PrivateDict::PrintXML(), gdcm::SequenceOfFragments::ReadValue(), and SetPrivateCreator().

◆ GetLength()

uint32_t gdcm::Tag::GetLength ( ) const

inline

return the length of tag (read: size on disk)

◆ GetPrivateCreator()

Tag gdcm::Tag::GetPrivateCreator ( ) const

inline

Return the Private Creator Data Element tag of a private data element.

References SetElement().

◆ IsGroupLength()

bool gdcm::Tag::IsGroupLength ( ) const

inline

return whether the tag correspond to a group length tag:

◆ IsGroupXX()

bool gdcm::Tag::IsGroupXX ( const Tag & t ) const

inline

e.g 6002,3000 belong to groupXX: 6000,3000

References GetElement(), GetGroup(), and IsPrivate().

◆ IsIllegal()

bool gdcm::Tag::IsIllegal ( ) const

inline

return if the tag is considered to be an illegal tag

◆ IsPrivate()

bool gdcm::Tag::IsPrivate ( ) const

inline

PRIVATE DATA ELEMENT: Additional Data Element, defined by an implementor, to communicate information that is not contained in Standard Data Elements. Private Data elements have odd Group Numbers.

Examples: DuplicatePCDE.cxx.

Referenced by IsGroupXX(), and SetPrivateCreator().

◆ IsPrivateCreator()

bool gdcm::Tag::IsPrivateCreator ( ) const

inline

Returns if tag is a Private Creator (xxxx,00yy), where xxxx is odd number and yy in [0x10,0xFF]

Examples: DuplicatePCDE.cxx.

◆ IsPublic()

bool gdcm::Tag::IsPublic ( ) const

inline

STANDARD DATA ELEMENT: A Data Element defined in the DICOM Standard, and therefore listed in the DICOM Data Element Dictionary in PS 3.6. Is the Tag from the Public dict...well the implementation is buggy it does not prove the element is indeed in the dict...

◆ operator!=()

bool gdcm::Tag::operator!= ( const Tag & _val ) const

inline

References tag.

◆ operator<()

bool gdcm::Tag::operator< ( const Tag & _val ) const

inline

DICOM Standard expects the Data Element to be sorted by Tags All other comparison can be constructed from this one and operator ==

References tag, and tags.

◆ operator<=()

bool gdcm::Tag::operator<= ( const Tag & t2 ) const

inline

◆ operator=()

Tag & gdcm::Tag::operator= ( const Tag & _val )

inline

References tag.

◆ operator==()

bool gdcm::Tag::operator== ( const Tag & _val ) const

inline

References tag.

◆ operator[]() [1/2]

uint16_t & gdcm::Tag::operator[] ( const unsigned int & _id )

inline

Returns the Group or Element of the given Tag, depending on id (0/1)

◆ operator[]() [2/2]

const uint16_t & gdcm::Tag::operator[] ( const unsigned int & _id ) const

inline

Returns the Group or Element of the given Tag, depending on id (0/1)

◆ PrintAsContinuousString()

std::string gdcm::Tag::PrintAsContinuousString ( ) const

Print tag value with no separating comma: eg. tag = "12345678" It comes in useful when reading tag values from XML file(in NativeDICOMModel)

◆ PrintAsContinuousUpperCaseString()

std::string gdcm::Tag::PrintAsContinuousUpperCaseString ( ) const

Same as PrintAsContinuousString, but hexadecimal [a-f] are printed using upper case.

◆ PrintAsPipeSeparatedString()

std::string gdcm::Tag::PrintAsPipeSeparatedString ( ) const

Print as a pipe separated string (GDCM 1.x compat only). Do not use in newer code

See also: ReadFromPipeSeparatedString

◆ Read()

template<typename TSwap >

std::istream & gdcm::Tag::Read ( std::istream & is )

inline

Read a tag from binary representation.

◆ ReadFromCommaSeparatedString()

bool gdcm::Tag::ReadFromCommaSeparatedString ( const char * str )

Read from a comma separated string. This is a highly user oriented function, the string should be formatted as: 1234,5678 to specify the tag (0x1234,0x5678) The notation comes from the DICOM standard, and is handy to use from a command line program

◆ ReadFromContinuousString()

bool gdcm::Tag::ReadFromContinuousString ( const char * str )

Read From XML formatted tag value eg. tag = "12345678" It comes in useful when reading tag values from XML file(in NativeDICOMModel)

◆ ReadFromPipeSeparatedString()

bool gdcm::Tag::ReadFromPipeSeparatedString ( const char * str )

Read from a pipe separated string (GDCM 1.x compat only). Do not use in newer code

See also: ReadFromCommaSeparatedString

◆ SetElement()

void gdcm::Tag::SetElement ( uint16_t element )

inline

Sets the 'Element number' of the given Tag.

Examples: DuplicatePCDE.cxx, and PublicDict.cxx.

Referenced by GetPrivateCreator().

◆ SetElementTag() [1/2]

void gdcm::Tag::SetElementTag	(	uint16_t	group,
		uint16_t	element
	)

inline

Sets the 'Group number' & 'Element number' of the given Tag.

◆ SetElementTag() [2/2]

void gdcm::Tag::SetElementTag ( uint32_t tag )

inline

Sets the full tag value of the given Tag.

◆ SetGroup()

void gdcm::Tag::SetGroup ( uint16_t group )

inline

Sets the 'Group number' of the given Tag.

◆ SetPrivateCreator()

void gdcm::Tag::SetPrivateCreator ( Tag const & t )

inline

Set private creator:

Examples: DuplicatePCDE.cxx.

References GetElement(), GetGroup(), and IsPrivate().

◆ Write()

template<typename TSwap >

const std::ostream & gdcm::Tag::Write ( std::ostream & os ) const

inline

Write a tag in binary rep.

Referenced by gdcm::Item::Write(), gdcm::SequenceOfFragments::Write(), and gdcm::SequenceOfItems::Write().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	_os,
		const Tag &	_val
	)

friend

◆ operator>>

std::istream & operator>>	(	std::istream &	_is,
		Tag &	_val
	)

friend

Member Data Documentation

◆ bytes

char gdcm::Tag::bytes[4]

◆ tag

uint32_t gdcm::Tag::tag

Referenced by Tag(), operator!=(), operator<(), operator=(), and operator==().

◆ tags

uint16_t gdcm::Tag::tags[2]

Referenced by operator<().

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

gdcmTag.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Tag() [1/3]

◆ Tag() [2/3]

◆ Tag() [3/3]

Member Function Documentation

◆ GetElement()

◆ GetElementTag()

◆ GetGroup()

◆ GetLength()

◆ GetPrivateCreator()

◆ IsGroupLength()

◆ IsGroupXX()

◆ IsIllegal()

◆ IsPrivate()

◆ IsPrivateCreator()

◆ IsPublic()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PrintAsContinuousString()

◆ PrintAsContinuousUpperCaseString()

◆ PrintAsPipeSeparatedString()

◆ Read()

◆ ReadFromCommaSeparatedString()

◆ ReadFromContinuousString()

◆ ReadFromPipeSeparatedString()

◆ SetElement()

◆ SetElementTag() [1/2]

◆ SetElementTag() [2/2]

◆ SetGroup()

◆ SetPrivateCreator()

◆ Write()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ bytes

◆ tag

◆ tags