MeVisLab Toolbox Reference
mlDICOMGetTools.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
5 
10 //----------------------------------------------------------------------------------
11 #pragma once
12 
13 #include "MLDICOMTagsSystem.h"
14 
15 #include <ThirdPartyWarningsDisable.h>
16 #include <list>
17 #include <set>
18 #include <string>
19 #include <vector>
20 #include <ThirdPartyWarningsRestore.h>
21 
22 #include <mlLinearAlgebra.h>
23 #include <mlScaleShiftData.h>
24 
25 // DICOM Tree prototypes.
26 #include <DCMTree_Lib.h>
27 
28 ML_START_NAMESPACE
29 
30 // Forwards
31 class DicomMessageCollector;
32 
33 //----------------------------------------------------------------------------------
35 //----------------------------------------------------------------------------------
36 namespace DICOMTagTools {
37 
41 MLDICOMTags_EXPORT std::string createInstanceUID(bool useFMEUIDPrefix=false);
42 
44 MLDICOMTags_EXPORT bool looksLikeValidDICOMUID(const std::string &uidStrToCheck);
45 
49 MLDICOMTags_EXPORT bool isValidCSVrCharacter(const char ch);
50 
55 MLDICOMTags_EXPORT bool looksLikeValidCSVrValue(const std::string &codedString,
56  std::string *explanation=nullptr);
57 
65 MLDICOMTags_EXPORT void deepSearchTags(DCMTree::Const_TreePtr treePtr,
66  const DCMTree::TagId &tagId,
67  const size_t numTagsToFind,
68  std::vector<DCMTree::Const_TagPtr> &tagVector);
69 
73 MLDICOMTags_EXPORT void deepSearchTags(DCMTree::TreePtr treePtr,
74  const DCMTree::TagId &tagId,
75  const size_t numTagsToFind,
76  std::vector<DCMTree::TagPtr> &tagVector);
77 
84 MLDICOMTags_EXPORT bool deepSearchTag(DCMTree::Const_TreePtr treePtr,
85  const DCMTree::TagId &tagId,
86  DCMTree::Const_TagPtr &result);
87 
90 MLDICOMTags_EXPORT bool deepSearchTag(DCMTree::TreePtr treePtr,
91  const DCMTree::TagId &tagId,
92  DCMTree::TagPtr &result);
93 
94 
100 MLDICOMTags_EXPORT bool deepSearchTag(DCMTree::Const_TreePtr treePtr,
101  const std::string &tagIdStr,
102  DCMTree::Const_TagPtr &result);
103 
106 MLDICOMTags_EXPORT bool deepSearchTag(DCMTree::TreePtr treePtr,
107  const std::string &tagIdStr,
108  DCMTree::TagPtr &result);
109 
113 MLDICOMTags_EXPORT const DCMTree::TreePtrVector *getSequenceItemTreePtrVector(DCMTree::Const_TreePtr dcmMFTree,
114  DCMTree::RawTagId sequenceTagId);
115 
122 MLDICOMTags_EXPORT std::string getTagValue(DCMTree::Const_TreePtr treePtr,
123  DCMTree::RawTagId tagId,
124  bool useNumericTagValueSorting);
125 
130 MLDICOMTags_EXPORT size_t getTripleTag(DCMTree::Const_TreePtr treePtr,
131  DCMTree::RawTagId tagId,
132  double &ippX, double &ippY, double &ippZ,
133  double initX, double initY, double initZ);
134 
139 MLDICOMTags_EXPORT size_t getHexTag(DCMTree::Const_TreePtr treePtr,
140  DCMTree::RawTagId tagId,
141  double &ippX1, double &ippY1, double &ippZ1,
142  double &ippX2, double &ippY2, double &ippZ2,
143  double initX1, double initY1, double initZ1,
144  double initX2, double initY2, double initZ2);
145 
156 MLDICOMTags_EXPORT std::string isValidDICOMDate(std::string str,
157  bool allowEmptyStrings = true,
158  bool allowOldFormat = true);
159 
167 MLDICOMTags_EXPORT std::string isValidDICOMTime(const std::string &str,
168  bool allowEmptyStrings = true);
169 
174 MLDICOMTags_EXPORT std::string getCompressionDescription(DCMTree::Const_TreePtr treePtr,
175  bool *isRetired=nullptr);
176 
182 MLDICOMTags_EXPORT std::string isLossyCompressed(DCMTree::Const_TreePtr treePtr);
183 
187 MLDICOMTags_EXPORT bool isCompressed(DCMTree::Const_TreePtr treePtr);
188 
195 MLDICOMTags_EXPORT std::string getTransferSyntaxUIDAsString(DCMTree::Const_TreePtr treePtr,
196  bool searchOnlyOnTopLevel=false);
197 
200 MLDICOMTags_EXPORT bool isJPEG2000Compressed(DCMTree::Const_TreePtr treePtr);
201 
207 MLDICOMTags_EXPORT size_t getImagePositionPatient(DCMTree::Const_TreePtr treePtr,
208  double &ippX,
209  double &ippY,
210  double &ippZ,
211  bool replaceOnlyIfFound);
212 
218 MLDICOMTags_EXPORT size_t getImageOrientationPatient(DCMTree::Const_TreePtr treePtr,
219  double &iopX1,
220  double &iopY1,
221  double &iopZ1,
222  double &iopX2,
223  double &iopY2,
224  double &iopZ2);
225 
226 
228 enum OrientationType
229 {
230  InvalidOrientation = 0 ,
231  Axial ,
232  Prone ,
233  Cranial ,
234  Coronal ,
235  Sagittal ,
236  AlmostAxial ,
237  AlmostCoronal ,
238  AlmostSagittal ,
239  LessAlmostAxial ,
240  LessAlmostCoronal ,
241  LessAlmostSagittal ,
242  Oblique ,
243  OtherOrientation ,
244  NoValues ,
245  NotApplicable ,
246 
247  NumberOfOrientationTypes
248 };
249 
252 extern const char * const OrientationName[NumberOfOrientationTypes];
253 
261 MLDICOMTags_EXPORT std::string getHumanReadableImageOrientationPatient(DCMTree::Const_TreePtr dcmTree,
262  int *resultOType=nullptr);
263 
267 MLDICOMTags_EXPORT ScaleShiftData getRescaleSlopeInterceptAsScaleShift(DCMTree::Const_TreePtr treePtr);
268 
279 MLDICOMTags_EXPORT DCMTree::Const_TagPtr getAnyPixelDataTag(DCMTree::Const_TreePtr treePtr,
280  bool searchRecursivly=false);
281 
283 MLDICOMTags_EXPORT DCMTree::PixelData getPixelDataPtrFromTree(DCMTree::Const_TreePtr treePtr,
284  size_t *valSizeInBytes,
285  DicomMessageCollector &dcmMsgCollector);
286 
290 MLDICOMTags_EXPORT bool hasMFPixelDataTag(DCMTree::Const_TreePtr treePtr,
291  DCMTree::Const_TagPtr &tagPtr);
292 
295 MLDICOMTags_EXPORT const DCMTree::MFPixelTag* getAsMFPixelPtr(DCMTree::Const_TagPtr tag);
296 
303 MLDICOMTags_EXPORT const boost::shared_array<unsigned char> getPixelDataFrame(DCMTree::Const_TagPtr pixTag,
304  boost::uint32_t frameIdx);
305 
308 MLDICOMTags_EXPORT bool usesNegativeNMStacking(DCMTree::Const_TreePtr treePtr);
309 
311 MLDICOMTags_EXPORT bool hasNegativeSliceSpacing(DCMTree::Const_TreePtr treePtr);
312 
315 MLDICOMTags_EXPORT bool hasAtMostOneFrameInSMFGrid(const DCMTree::StructuredMFPtr &smfTree);
316 
319 MLDICOMTags_EXPORT bool hasAtMostOneFrameInSMFGrid(const DCMTree::Const_StructuredMFPtr &smfTree);
320 
324 MLDICOMTags_EXPORT bool isBitImageDICOM(DCMTree::Const_TreePtr treePtr);
325 
333 MLDICOMTags_EXPORT bool updateMinMaxFromDICOMTags(DCMTree::Const_TreePtr treePtr,
334  MLdouble &minPixVal,
335  MLdouble &maxPixVal);
336 
345 MLDICOMTags_EXPORT bool getDoubleFromTag(DCMTree::Const_TagPtr tagPtr, double &returnDbl);
346 
356 MLDICOMTags_EXPORT bool getDoubleVectorFromTag(DCMTree::Const_TagPtr tagPtr, std::vector<double> &returnDbls);
357 
366 MLDICOMTags_EXPORT bool getVector2FromTag(DCMTree::Const_TagPtr tagPtr, Vector2 &returnVec);
367 
376 MLDICOMTags_EXPORT bool getVector3FromTag(DCMTree::Const_TagPtr tagPtr, Vector3 &returnVec);
377 
386 MLDICOMTags_EXPORT bool getVector6FromTag(DCMTree::Const_TagPtr tagPtr, Vector6 &returnVec);
387 
396 MLDICOMTags_EXPORT bool get4x4DoubleMatrixFromTag(DCMTree::Const_TagPtr tagPtr, Matrix4 &returnMat);
397 
404 MLDICOMTags_EXPORT DCMTree::TagPtr getTagIfItExists(DCMTree::TreePtr dcmTree,
405  DCMTree::TagId tagId,
406  std::string *errStr=nullptr);
407 
414 MLDICOMTags_EXPORT DCMTree::TreePtr cloneDCMTree(DCMTree::Const_TreePtr dcmTree,
415  std::string *errStr);
416 
425 MLDICOMTags_EXPORT unsigned int findPrivateTagGroup(DCMTree::TreePtr dcmTree,
426  const std::string &privateCreatorString);
427 
447 MLDICOMTags_EXPORT unsigned int searchPrivateCreator(DCMTree::TreePtr dcmTree,
448  const std::string &privateCreatorString="",
449  MLuint16 desiredPrivateGroupId=0x09,
450  MLuint8 desiredPrivateElementGroupId=0x10);
451 
455 MLDICOMTags_EXPORT DCMTree::Const_TagPtr getPrivateFMETag(DCMTree::RawTagId lowerEightBitOfElementId,
456  DCMTree::Const_TreePtr dcmTree);
457 
464 MLDICOMTags_EXPORT bool getTopLevelSOPInstanceUID(DCMTree::Const_TreePtr dcmTree,
465  std::string &sopInstanceUID);
466 
481 MLDICOMTags_EXPORT void getTagStringValuesFromSequence(DCMTree::RawTagId rawTagId,
482  DCMTree::Const_TagPtr sequenceInWhichToSearch,
483  std::string &tagValuesStringListToExtend,
484  const std::string &sep,
485  std::set<std::string> *makeUniqueSet=nullptr,
486  bool searchAsLower8BitOfPrivateFMETag=false);
487 
489 MLDICOMTags_EXPORT DCMTree::Const_TagPtr getMeVisStructuredMFDimensionSequence(DCMTree::Const_TreePtr dcmTree);
490 
492 MLDICOMTags_EXPORT DCMTree::Const_TagPtr getPrivateTag(const std::string &privateCreatorString,
493  unsigned short groupId,
494  DCMTree::RawTagId lowerEightBitOfElementId,
495  DCMTree::Const_TreePtr dcmTree);
496 
498 MLDICOMTags_EXPORT bool isPhilips3D(DCMTree::Const_TreePtr treePtr, MLint *spatialExtent=nullptr);
499 
501 MLDICOMTags_EXPORT unsigned int getNumberOfFrames(DCMTree::Const_TreePtr dcmTree,
502  unsigned int *fromTagOnly=nullptr);
503 
519 MLDICOMTags_EXPORT void extractTagValuesFromPerFrameAndMeVisMFSequence(DCMTree::RawTagId rawTagId,
520  DCMTree::Const_TreePtr dcmTree,
521  std::string &tagValuesStringListToExtend,
522  bool alsoAddTopLevelTags,
523  const std::string &sep,
524  std::set<std::string> *makeUniqueSet=nullptr);
525 
541 MLDICOMTags_EXPORT void getTagStringValuesFromSMFSequence(DCMTree::Const_TreePtr inputDcmTree,
542  const std::vector<MLuint64> &rawTagIds,
543  bool appendFrameCount,
544  bool appendCoords,
545  std::list<std::vector<std::string> > &tagValuesListToExtend);
546 
549 MLDICOMTags_EXPORT void getTagStringValuesFromTopLevel(DCMTree::Const_TreePtr inputDcmTree,
550  const std::vector<MLuint64> &rawTagIds,
551  std::vector<std::string> &rootEntries);
552 };
553 
554 ML_END_NAMESPACE
DCMTree_Lib.h
MLDICOMTagsSystem.h
Project global and OS specific declarations.
MLDICOMTags_EXPORT
#define MLDICOMTags_EXPORT
If included by external modules, exported symbols are declared as import symbols.
Definition: MLDICOMTagsSystem.h:20
DCMTree::TagId
Class to wrap a tag-id.
Definition: DCMTree_TagId.h:40
ml::DicomMessageCollector
Class to collect messages and errors related to a given frame handle.
Definition: mlDicomMessageCollector.h:22
MLuint8
unsigned char MLuint8
Definition: mlTypeDefs.h:115
MLdouble
double MLdouble
Definition: mlTypeDefs.h:223
MLuint16
unsigned short MLuint16
Definition: mlTypeDefs.h:148
MLint
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition: mlTypeDefs.h:578
DCMTree::Const_TagPtr
boost::shared_ptr< const Tag > Const_TagPtr
Definition: DCMTree_Lib.h:63
DCMTree::Const_StructuredMFPtr
boost::shared_ptr< const StructuredMF > Const_StructuredMFPtr
Definition: DCMTree_Lib.h:170
DCMTree::StructuredMFPtr
boost::shared_ptr< StructuredMF > StructuredMFPtr
Definition: DCMTree_Lib.h:168
DCMTree::Const_TreePtr
boost::shared_ptr< const Tree > Const_TreePtr
Definition: DCMTree_Lib.h:73
DCMTree::TagPtr
boost::shared_ptr< Tag > TagPtr
shared-pointer to tag
Definition: DCMTree_Lib.h:59
DCMTree::TreePtrVector
std::vector< TreePtr > TreePtrVector
a vector of TreePtr - used for sequences
Definition: DCMTree_Lib.h:85
DCMTree::TreePtr
boost::shared_ptr< Tree > TreePtr
shared pointer to a DCMTree::Tree
Definition: DCMTree_Lib.h:70
DCMTree::RawTagId
unsigned int RawTagId
Definition: DCMTree_Lib.h:147
ml::DICOMTagTools::updateMinMaxFromDICOMTags
MLDICOMTags_EXPORT bool updateMinMaxFromDICOMTags(DCMTree::Const_TreePtr treePtr, MLdouble &minPixVal, MLdouble &maxPixVal)
Checks for min/max DICOM tags on top level and - if both are found - updates the passed min/max value...
ml::DICOMTagTools::OrientationName
const char *const OrientationName[NumberOfOrientationTypes]
String representations analog to the OrientationType, however, NumberOfOrientationTypes is out of ran...
ml::DICOMTagTools::looksLikeValidCSVrValue
MLDICOMTags_EXPORT bool looksLikeValidCSVrValue(const std::string &codedString, std::string *explanation=nullptr)
Returns true if codedString looks like a string valid for a coded segmentation, otherwise false; if e...
ml::DICOMTagTools::isJPEG2000Compressed
MLDICOMTags_EXPORT bool isJPEG2000Compressed(DCMTree::Const_TreePtr treePtr)
Returns true if any JPEG2000 compression was used to compress the pixel data, otherwise false.
ml::DICOMTagTools::getTagStringValuesFromSMFSequence
MLDICOMTags_EXPORT void getTagStringValuesFromSMFSequence(DCMTree::Const_TreePtr inputDcmTree, const std::vector< MLuint64 > &rawTagIds, bool appendFrameCount, bool appendCoords, std::list< std::vector< std::string > > &tagValuesListToExtend)
Looks for frame-specific tags rawTagIds in getMeVisStructuredMFDimensionSequence of inputDcmTree and ...
ml::DICOMTagTools::isValidCSVrCharacter
MLDICOMTags_EXPORT bool isValidCSVrCharacter(const char ch)
Returns true if ch is a character valid of CS value representations, otherwise false (uppercase lette...
ml::DICOMTagTools::getTagIfItExists
MLDICOMTags_EXPORT DCMTree::TagPtr getTagIfItExists(DCMTree::TreePtr dcmTree, DCMTree::TagId tagId, std::string *errStr=nullptr)
ml::DICOMTagTools::looksLikeValidDICOMUID
MLDICOMTags_EXPORT bool looksLikeValidDICOMUID(const std::string &uidStrToCheck)
Returns true if uidStrToCheck looks like a plausible valid DICOM UID, otherwise false.
ml::DICOMTagTools::deepSearchTag
MLDICOMTags_EXPORT bool deepSearchTag(DCMTree::TreePtr treePtr, const std::string &tagIdStr, DCMTree::TagPtr &result)
Alternative version to deepSearchTags(DCMTree::Const_TreePtr, const std::string &,...
ml::DICOMTagTools::isCompressed
MLDICOMTags_EXPORT bool isCompressed(DCMTree::Const_TreePtr treePtr)
Returns true if the DICOM tree has a transfer syntax UID which indicates compression,...
ml::DICOMTagTools::searchPrivateCreator
MLDICOMTags_EXPORT unsigned int searchPrivateCreator(DCMTree::TreePtr dcmTree, const std::string &privateCreatorString="", MLuint16 desiredPrivateGroupId=0x09, MLuint8 desiredPrivateElementGroupId=0x10)
Determine the first odd group id with private element group id.
ml::DICOMTagTools::getRescaleSlopeInterceptAsScaleShift
MLDICOMTags_EXPORT ScaleShiftData getRescaleSlopeInterceptAsScaleShift(DCMTree::Const_TreePtr treePtr)
Returns a ScaleShiftData object according to rescale and slope tag values.
ml::DICOMTagTools::getVector6FromTag
MLDICOMTags_EXPORT bool getVector6FromTag(DCMTree::Const_TagPtr tagPtr, Vector6 &returnVec)
Converts six values of tagPtr to six Vector6 values in returnVec, respectively.
ml::DICOMTagTools::get4x4DoubleMatrixFromTag
MLDICOMTags_EXPORT bool get4x4DoubleMatrixFromTag(DCMTree::Const_TagPtr tagPtr, Matrix4 &returnMat)
Converts 16 values of tagPtr to 16 double matrix values in returnMat, respectively.
ml::DICOMTagTools::extractTagValuesFromPerFrameAndMeVisMFSequence
MLDICOMTags_EXPORT void extractTagValuesFromPerFrameAndMeVisMFSequence(DCMTree::RawTagId rawTagId, DCMTree::Const_TreePtr dcmTree, std::string &tagValuesStringListToExtend, bool alsoAddTopLevelTags, const std::string &sep, std::set< std::string > *makeUniqueSet=nullptr)
Looks for frame-specific tags with ID rawTagId in sequences DCMTree_PerFrameFunctionalGroupsSequence ...
ml::DICOMTagTools::getImageOrientationPatient
MLDICOMTags_EXPORT size_t getImageOrientationPatient(DCMTree::Const_TreePtr treePtr, double &iopX1, double &iopY1, double &iopZ1, double &iopX2, double &iopY2, double &iopZ2)
Return the DICOM tag ImageOrientationPatient as two 3D vectors (iopX1, iopY1, iopZ1) and (iopX2,...
ml::DICOMTagTools::hasMFPixelDataTag
MLDICOMTags_EXPORT bool hasMFPixelDataTag(DCMTree::Const_TreePtr treePtr, DCMTree::Const_TagPtr &tagPtr)
Returns true if the tree has a multi-frame pixel data tag containing many frames or false otherwise.
ml::DICOMTagTools::cloneDCMTree
MLDICOMTags_EXPORT DCMTree::TreePtr cloneDCMTree(DCMTree::Const_TreePtr dcmTree, std::string *errStr)
Create a deep-copy of the passed dcmTree as DICOM tree to be modified.
ml::DICOMTagTools::isLossyCompressed
MLDICOMTags_EXPORT std::string isLossyCompressed(DCMTree::Const_TreePtr treePtr)
Returns "Yes" if the DICOM tree has a tag indicating a lossy compression, or if the tag indicates no ...
ml::DICOMTagTools::hasAtMostOneFrameInSMFGrid
MLDICOMTags_EXPORT bool hasAtMostOneFrameInSMFGrid(const DCMTree::Const_StructuredMFPtr &smfTree)
Returns true if the passed constant SMFTree has only one grid entry, if smfTree is nullptr or smfTree...
ml::DICOMTagTools::getVector3FromTag
MLDICOMTags_EXPORT bool getVector3FromTag(DCMTree::Const_TagPtr tagPtr, Vector3 &returnVec)
Converts three values of tagPtr to three Vector3 values in returnVec, respectively.
ml::DICOMTagTools::getPixelDataFrame
MLDICOMTags_EXPORT const boost::shared_array< unsigned char > getPixelDataFrame(DCMTree::Const_TagPtr pixTag, boost::uint32_t frameIdx)
Returns a memory copy of the frame at index position frameIdx of the pixel data tag pixTag or nullptr...
ml::DICOMTagTools::isValidDICOMDate
MLDICOMTags_EXPORT std::string isValidDICOMDate(std::string str, bool allowEmptyStrings=true, bool allowOldFormat=true)
Checks whether str is a valid DICOM date string and returns an empty string on success or a non empty...
ml::DICOMTagTools::getTagStringValuesFromTopLevel
MLDICOMTags_EXPORT void getTagStringValuesFromTopLevel(DCMTree::Const_TreePtr inputDcmTree, const std::vector< MLuint64 > &rawTagIds, std::vector< std::string > &rootEntries)
Like getTagStringValuesFromSMFSequence() but retrieves tags only from top level of inputDcmTree into ...
ml::DICOMTagTools::hasNegativeSliceSpacing
MLDICOMTags_EXPORT bool hasNegativeSliceSpacing(DCMTree::Const_TreePtr treePtr)
Returns true if the tree has a SpacingBetweenSlices tag with a negative value.
ml::DICOMTagTools::getHexTag
MLDICOMTags_EXPORT size_t getHexTag(DCMTree::Const_TreePtr treePtr, DCMTree::RawTagId tagId, double &ippX1, double &ippY1, double &ippZ1, double &ippX2, double &ippY2, double &ippZ2, double initX1, double initY1, double initZ1, double initX2, double initY2, double initZ2)
Returns the given DICOM tag as two 3 component double vectors; all values which can not be retrieved ...
ml::DICOMTagTools::getVector2FromTag
MLDICOMTags_EXPORT bool getVector2FromTag(DCMTree::Const_TagPtr tagPtr, Vector2 &returnVec)
Converts two values of tagPtr to two Vector2 values in returnVec, respectively.
ml::DICOMTagTools::getDoubleVectorFromTag
MLDICOMTags_EXPORT bool getDoubleVectorFromTag(DCMTree::Const_TagPtr tagPtr, std::vector< double > &returnDbls)
Converts all values of tagPtr to a std::vector of doubles in returnDbls.
ml::DICOMTagTools::usesNegativeNMStacking
MLDICOMTags_EXPORT bool usesNegativeNMStacking(DCMTree::Const_TreePtr treePtr)
Returns true if the tree has tags which indicate that it is NM data and the pixel data is stacked in ...
ml::DICOMTagTools::getTripleTag
MLDICOMTags_EXPORT size_t getTripleTag(DCMTree::Const_TreePtr treePtr, DCMTree::RawTagId tagId, double &ippX, double &ippY, double &ippZ, double initX, double initY, double initZ)
Returns the given DICOM tag as three double values; all values which can not be retrieved are returne...
ml::DICOMTagTools::getTopLevelSOPInstanceUID
MLDICOMTags_EXPORT bool getTopLevelSOPInstanceUID(DCMTree::Const_TreePtr dcmTree, std::string &sopInstanceUID)
Get the original SOPInstanceUID from top level of dcmTree, returns the value in sopInstanceUID and re...
ml::DICOMTagTools::isValidDICOMTime
MLDICOMTags_EXPORT std::string isValidDICOMTime(const std::string &str, bool allowEmptyStrings=true)
Checks whether str is a valid DICOM time string of the formats HHMM, HHMMSS, or HHMMSS....
ml::DICOMTagTools::createInstanceUID
MLDICOMTags_EXPORT std::string createInstanceUID(bool useFMEUIDPrefix=false)
Generate new IDs for DICOM frames, for example new SOPinstanceUIDs.
ml::DICOMTagTools::getDoubleFromTag
MLDICOMTags_EXPORT bool getDoubleFromTag(DCMTree::Const_TagPtr tagPtr, double &returnDbl)
Converts one values of tagPtr to a double values in returnDbl.
ml::DICOMTagTools::getPrivateTag
MLDICOMTags_EXPORT DCMTree::Const_TagPtr getPrivateTag(const std::string &privateCreatorString, unsigned short groupId, DCMTree::RawTagId lowerEightBitOfElementId, DCMTree::Const_TreePtr dcmTree)
See DICOMCachedIOTools::getPrivateTag().
ml::DICOMTagTools::isPhilips3D
MLDICOMTags_EXPORT bool isPhilips3D(DCMTree::Const_TreePtr treePtr, MLint *spatialExtent=nullptr)
See DICOMCachedIOTools::isPhilips3D().
ml::DICOMTagTools::getAnyPixelDataTag
MLDICOMTags_EXPORT DCMTree::Const_TagPtr getAnyPixelDataTag(DCMTree::Const_TreePtr treePtr, bool searchRecursivly=false)
Searches and returns the first pixel data pointer on top level found in treePtr, or a nil tag if not ...
ml::DICOMTagTools::OrientationType
OrientationType
Enumerator for typical human readable anatomic orientations.
Definition: mlDICOMGetTools.h:229
ml::DICOMTagTools::LessAlmostCoronal
@ LessAlmostCoronal
Less approximately Coronal.
Definition: mlDICOMGetTools.h:240
ml::DICOMTagTools::NumberOfOrientationTypes
@ NumberOfOrientationTypes
Number of available orientation modes.
Definition: mlDICOMGetTools.h:247
ml::DICOMTagTools::LessAlmostSagittal
@ LessAlmostSagittal
Less approximately Sagittal.
Definition: mlDICOMGetTools.h:241
ml::DICOMTagTools::Axial
@ Axial
axial in supine position
Definition: mlDICOMGetTools.h:231
ml::DICOMTagTools::LessAlmostAxial
@ LessAlmostAxial
Less approximately Axial.
Definition: mlDICOMGetTools.h:239
ml::DICOMTagTools::Prone
@ Prone
axial in prone position
Definition: mlDICOMGetTools.h:232
ml::DICOMTagTools::InvalidOrientation
@ InvalidOrientation
Something in the orientation is not standard compliant.
Definition: mlDICOMGetTools.h:230
ml::DICOMTagTools::AlmostSagittal
@ AlmostSagittal
Approximately Sagittal.
Definition: mlDICOMGetTools.h:238
ml::DICOMTagTools::NotApplicable
@ NotApplicable
Orientation type makes no sense in this context.
Definition: mlDICOMGetTools.h:245
ml::DICOMTagTools::OtherOrientation
@ OtherOrientation
A valid orientation, but non of the upper ones.
Definition: mlDICOMGetTools.h:243
ml::DICOMTagTools::AlmostCoronal
@ AlmostCoronal
Approximately Coronal.
Definition: mlDICOMGetTools.h:237
ml::DICOMTagTools::AlmostAxial
@ AlmostAxial
Approximately Axial.
Definition: mlDICOMGetTools.h:236
ml::DICOMTagTools::NoValues
@ NoValues
No orientation values found in DICOM tree.
Definition: mlDICOMGetTools.h:244
ml::DICOMTagTools::getCompressionDescription
MLDICOMTags_EXPORT std::string getCompressionDescription(DCMTree::Const_TreePtr treePtr, bool *isRetired=nullptr)
Returns a textual description of a compression type if it is found in the available transfer UIDs sto...
ml::DICOMTagTools::getHumanReadableImageOrientationPatient
MLDICOMTags_EXPORT std::string getHumanReadableImageOrientationPatient(DCMTree::Const_TreePtr dcmTree, int *resultOType=nullptr)
Determine (ACR_NEMA)ImageOrientationPatient from dcmTree and create a human readable orientation from...
ml::DICOMTagTools::getPixelDataPtrFromTree
MLDICOMTags_EXPORT DCMTree::PixelData getPixelDataPtrFromTree(DCMTree::Const_TreePtr treePtr, size_t *valSizeInBytes, DicomMessageCollector &dcmMsgCollector)
Same as DICOMCachedIOTools::getPixelDataPtrFromTree().
ml::DICOMTagTools::getNumberOfFrames
MLDICOMTags_EXPORT unsigned int getNumberOfFrames(DCMTree::Const_TreePtr dcmTree, unsigned int *fromTagOnly=nullptr)
See DICOMCachedIOTools::getNumberOfFrames().
ml::DICOMTagTools::getTagValue
MLDICOMTags_EXPORT std::string getTagValue(DCMTree::Const_TreePtr treePtr, DCMTree::RawTagId tagId, bool useNumericTagValueSorting)
Return tag value of first tag with id tagId in the DICOM tree treePtr as string if it exists,...
ml::DICOMTagTools::findPrivateTagGroup
MLDICOMTags_EXPORT unsigned int findPrivateTagGroup(DCMTree::TreePtr dcmTree, const std::string &privateCreatorString)
Determine tag ID mask of the private creator given by privateCreatorString and return it as mask 0xGG...
ml::DICOMTagTools::deepSearchTags
MLDICOMTags_EXPORT void deepSearchTags(DCMTree::TreePtr treePtr, const DCMTree::TagId &tagId, const size_t numTagsToFind, std::vector< DCMTree::TagPtr > &tagVector)
Alternative version to deepSearchTags(DCMTree::Const_TreePtr, const DCMTree::TagId,...
ml::DICOMTagTools::isBitImageDICOM
MLDICOMTags_EXPORT bool isBitImageDICOM(DCMTree::Const_TreePtr treePtr)
Returns true if the DICOM pixel size seems to be single bit (indicated by appropriate values of BitsA...
ml::DICOMTagTools::getImagePositionPatient
MLDICOMTags_EXPORT size_t getImagePositionPatient(DCMTree::Const_TreePtr treePtr, double &ippX, double &ippY, double &ippZ, bool replaceOnlyIfFound)
Return the DICOM tag ImagePositionPatient as three double values; all values which can not be retriev...
ml::DICOMTagTools::getTagStringValuesFromSequence
MLDICOMTags_EXPORT void getTagStringValuesFromSequence(DCMTree::RawTagId rawTagId, DCMTree::Const_TagPtr sequenceInWhichToSearch, std::string &tagValuesStringListToExtend, const std::string &sep, std::set< std::string > *makeUniqueSet=nullptr, bool searchAsLower8BitOfPrivateFMETag=false)
Deep-searches all occurrences of the tag with id tagToSearch in the sequence tag sequenceInWhichToSea...
ml::DICOMTagTools::getMeVisStructuredMFDimensionSequence
MLDICOMTags_EXPORT DCMTree::Const_TagPtr getMeVisStructuredMFDimensionSequence(DCMTree::Const_TreePtr dcmTree)
Searches the structured multi-frame sequence tag on top-level in dcmTree or nullptr if not found or d...
ml::DICOMTagTools::getTransferSyntaxUIDAsString
MLDICOMTags_EXPORT std::string getTransferSyntaxUIDAsString(DCMTree::Const_TreePtr treePtr, bool searchOnlyOnTopLevel=false)
Deep search and return the value of the DICOM tag TransferSyntaxUID as string.
ml::DICOMTagTools::getPrivateFMETag
MLDICOMTags_EXPORT DCMTree::Const_TagPtr getPrivateFMETag(DCMTree::RawTagId lowerEightBitOfElementId, DCMTree::Const_TreePtr dcmTree)
Searches private FME tag with lower 8 bit element id lowerEightBitOfElementId with FMEPrivateTagsGrou...
ml::DICOMTagTools::getAsMFPixelPtr
MLDICOMTags_EXPORT const DCMTree::MFPixelTag * getAsMFPixelPtr(DCMTree::Const_TagPtr tag)
Returns a pointer to the correctly cast multi-frame class type of tag if it is a valid multi-frame pi...
ml::DICOMTagTools::getSequenceItemTreePtrVector
MLDICOMTags_EXPORT const DCMTree::TreePtrVector * getSequenceItemTreePtrVector(DCMTree::Const_TreePtr dcmMFTree, DCMTree::RawTagId sequenceTagId)
If possible it returns a pointer to the vector of sequence item (trees) of the tag with id sequenceTa...
DCMTree::PixelData
Contains pixel data which is either shared/ref counted or a direct pointer.
Definition: DCMTree_Lib.h:105