mlDICOMSOPClassAndModalityTools.h File Reference

A collection of tools related to Modality and SOP Class UID checks. More...

#include "MLDICOMTagsSystem.h"
#include <ThirdPartyWarningsDisable.h>
#include <string>
#include <ThirdPartyWarningsRestore.h>
#include <mlUtilsSystem.h>
#include <DCMTree_Lib.h>

Go to the source code of this file.

Namespaces
	ml
	Main documentation file for ML users and developers.
	ml::DICOMTagTools
	A namespace collecting tools related to DICOM tags and tree tools.

Functions
MLDICOMTags_EXPORT std::string	ml::DICOMTagTools::getModalityTagValue (DCMTree::Const_TreePtr treePtr) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns a string with value of the modality tag if it can be determined from the passed tree or an empty string otherwise. More...
MLDICOMTags_EXPORT std::string	ml::DICOMTagTools::getSOPClassUIDTagValue (DCMTree::Const_TreePtr treePtr) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns a string with value of the SOPClassUID tag if it can be determined from the passed tree or an empty string otherwise. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasTrueModality (DCMTree::Const_TreePtr treePtr, const std::string &modality) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if the value of the modality tag is of the given modality, the tree is not a secondary capture, and a SOPClassUIDTag exists. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasSOPClassUID (DCMTree::Const_TreePtr dcmTree, const std::string &sopClassUID, bool doDeepSearch=false) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is valid and has the SOPClassUID tag with the given sopClassUID value. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasNMSOPClassUID (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is valid and has the SOPClassUID tag with the value "1.2.840.10008.5.1.4.1.1.20" or "1.2.840.10008.5.1.4.1.1.5" which stands for the NM modality, otherwise false is returned. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasStandardMRSpectroscopyClassUID (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is valid and has the SOPClassUID tag with the value "1.2.840.10008.5.1.4.1.1.4.2" which stands for the standard DICOM MR Spectroscopy modality, otherwise false is returned. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasRetiredPETCurveStorageSOPClassUID (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is of the retired Positron Emission Tomography Curve Storage type with SOPClassUID 1.2.840.10008.5.1.4.1.1.128. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasSCSOPClassUID (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is valid and has a SOPClassUID tag value matching a secondary capture SOPClassUID (which does not have a specific Modality value). More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasParametricMapSOPClassUID (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree is valid and has a Parametric Map SOPClassUID (which does not have a specific Modality value). More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasSOPClassUIDOfModality (DCMTree::Const_TreePtr dcmTree, const std::string &modality) ML_RETURN_VALUE_SHOULD_BE_USED
	EXPERIMENTAL FUNCTION: Returns true if dcmTree is valid and has the SOPClassUID tag which corresponds to the given modality. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::isKnownRetiredModality (const std::string &modality) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if modality is a known retired one, otherwise false. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::isKnownModality (const std::string &modality, bool includeRetired) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if modality is a known one, otherwise false; if includeRetired is true the also retired modalities are considered as known ones, otherwise not. More...
MLDICOMTags_EXPORT std::string	ml::DICOMTagTools::getModalityForSOPClassUID (const std::string &sopClassUID) ML_RETURN_VALUE_SHOULD_BE_USED
	EXPERIMENTAL FUNCTION: If its is known then return the modality corresponding to sopClassUID; if not known or unclear then an empty string is returned. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::isMultiFrameSOPClassUID (const std::string &SOPClassUID) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if the pass UID is a multi-frame SOPClassUID, otherwise false. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::isEnhancedSOPClassUID (const std::string &enhancedSOPClassUID) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if the pass UID is an enhanced Image Storage SOPClassUID, otherwise false. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasSharedOrPerFrameFunctionalGroupSequences (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if the Shared- or the PerFrameFunctionalGroupSequences are on root level, otherwise false. More...
MLDICOMTags_EXPORT bool	ml::DICOMTagTools::hasMultiFrameModule (DCMTree::Const_TreePtr dcmTree) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns true if dcmTree contains has Number of Frames (0028,0008) and Frame Increment Pointer (0028,0009) tags, otherwise false. More...
MLDICOMTags_EXPORT std::string	ml::DICOMTagTools::translateToSingleFrameSOPClassUID (const std::string &enhancedSOPClassUID) ML_RETURN_VALUE_SHOULD_BE_USED
	Returns a single frame SOPClassUID corresponding to enhancedSOPClassUID. More...
MLDICOMTags_EXPORT void	ml::DICOMTagTools::setUpSingleFrameImageStorageSOPClassUIDDerivedFromEnhancedOne (DCMTree::Const_TreePtr dcmMFTree, DCMTree::TreePtr singleFrame)
	Takes the SOPClassUID from dcmMFTree, and writes the corresponding single frame one into singlFrame. More...

Detailed Description

A collection of tools related to Modality and SOP Class UID checks.

Author

Wolf Spindler

Date

11/2014

Definition in file mlDICOMSOPClassAndModalityTools.h.