MeVisLab Toolbox Reference
ml::PrivateFMETagsSupport Namespace Reference

Functions

MLDICOMTags_EXPORT unsigned short addPrivateFMECreatorTag (DCMTree::Tree &dcmTree, const unsigned short privateFMETagSlotBase=0x10)
MLDICOMTags_EXPORT DCMTree::TagPtr getCreatedPrivateFMETag (unsigned short elementSlot, unsigned short elementSubId, DCMTree::Vr vr, unsigned int multiplicityStart, unsigned int multiplicityEnd)
MLDICOMTags_EXPORT DCMTree::TagPtr getCreatedAndAddedPrivateFMETag (unsigned short elementBase, unsigned short elementSubId, DCMTree::Vr vr, unsigned int multiplicityStart, unsigned int multiplicityEnd, DCMTree::Tree &dcmTree)
 Same as getCreatedPrivateFMETag(), but also adds the tag to dcmTree; exceptions are not caught at all.
MLDICOMTags_EXPORT void createPrivateFMEFrameTags (const unsigned int index, const std::string &sopInstanceUID, const std::string &sopClassUID, DCMTree::TreePtr dcmTree, DicomMessageCollector &dcmMsgCollector)

Function Documentation

◆ addPrivateFMECreatorTag()

MLDICOMTags_EXPORT unsigned short ml::PrivateFMETagsSupport::addPrivateFMECreatorTag ( DCMTree::Tree & dcmTree,
const unsigned short privateFMETagSlotBase = 0x10 )

If it does not exist it adds a new private creator tag with FMEPrivateCreatorString and groupId FMEPrivateTagsGroupId, and add it to dcmTree. Returns the found private slot << 8, or 0 if no private slot could be found; exceptions are not caught at all; privateFMETagSlotBase is the minimum slot to start search for a free slot if needed.

References addPrivateFMECreatorTag(), and MLDICOMTags_EXPORT.

Referenced by addPrivateFMECreatorTag().

◆ createPrivateFMEFrameTags()

MLDICOMTags_EXPORT void ml::PrivateFMETagsSupport::createPrivateFMEFrameTags ( const unsigned int index,
const std::string & sopInstanceUID,
const std::string & sopClassUID,
DCMTree::TreePtr dcmTree,
DicomMessageCollector & dcmMsgCollector )

Adds

  • Private creator tag in/with group FMEPrivateTagsGroupId and with value FMEPrivateCreatorString,
  • FMEPrivateSourceIndexOfDecomposedFrame tag with value originalFrameIndex and FMEPrivateSourceSOPClassUIDOfDecomposedFrame with tag value sopInstanceUID if sopInstanceUID is not empty, otherwise both tags are not added,
  • FMEPrivateSourceSOPClassUIDOfDecomposedFrame with tag value sopClassUID if sopClassUID is not empty, otherwise the tag is not added in dcmTree if dcmTree is non nullptr, otherwise, with nullptr, the call is ignored without error.
    Parameters
    indexThe index value to be added as private tag to dcmTree; only added if sopInstanceUID is not empty.
    sopInstanceUIDThe UID value of SOPInstanceUID to be added as private tag to dcmTree; only added if sopInstanceUID is not empty.
    sopClassUIDThe UID value of SOPClassUID to be added as private tag to dcmTree; only added if sopClassUID is not empty.
    dcmTreeThe DCMTree into which the private creator + tasg shall be added.
    dcmMsgCollectorCollects error messages in case of DCMTree::Exceptions or if no free private slots for new tags are available.

References createPrivateFMEFrameTags().

Referenced by createPrivateFMEFrameTags().

◆ getCreatedAndAddedPrivateFMETag()

MLDICOMTags_EXPORT DCMTree::TagPtr ml::PrivateFMETagsSupport::getCreatedAndAddedPrivateFMETag ( unsigned short elementBase,
unsigned short elementSubId,
DCMTree::Vr vr,
unsigned int multiplicityStart,
unsigned int multiplicityEnd,
DCMTree::Tree & dcmTree )

Same as getCreatedPrivateFMETag(), but also adds the tag to dcmTree; exceptions are not caught at all.

References getCreatedAndAddedPrivateFMETag(), and MLDICOMTags_EXPORT.

Referenced by getCreatedAndAddedPrivateFMETag().

◆ getCreatedPrivateFMETag()

MLDICOMTags_EXPORT DCMTree::TagPtr ml::PrivateFMETagsSupport::getCreatedPrivateFMETag ( unsigned short elementSlot,
unsigned short elementSubId,
DCMTree::Vr vr,
unsigned int multiplicityStart,
unsigned int multiplicityEnd )

Create a private FME tag assuming that the private FME creator already has been added to dcmTree, exceptions are not caught at all.

Parameters
elementSlotThe private slot << 8 of the private creator.
elementSubIdThe lower eight bit of the private tag to add, see mlDICOMPrivateFMETags.h for details.
vrThe Value representation to use for the tag.
multiplicityStartThe minimum multiplicity the tag shall have.
multiplicityEndThe maximum multiplicity the tag shall have.
Returns
The created tag.

References getCreatedPrivateFMETag(), and MLDICOMTags_EXPORT.

Referenced by getCreatedPrivateFMETag().