- Generated by
1.15.0
|
MeVisLab Toolbox Reference
|
A tool library with useful functions to detect, analyze, decompose multi-frame DICOM trees. More...
Variables | |
| MLDICOMTags_EXPORT const DICOMTagTools::TagIdDesc | BaseTagsToRemove [] |
A tool library with useful functions to detect, analyze, decompose multi-frame DICOM trees.
| MLDICOMTags_EXPORT void ml::MultiFrameTools::addSequenceContents | ( | DCMTree::Const_TreePtr | srcFrameTree, |
| size_t | pffgItemIdx, | ||
| DCMTree::TreePtr | dstFramePtr, | ||
| DicomMessageCollector & | dcmMsgCollector ) |
Searches all sequences in srcFrameTree and copies the tags in all sequence items flatly to dstFramePtr. Does nothing if any of srcFrameTree or dstFramePtr is nullptr.
| srcFrameTree | The DCMTree in which sequences are searched and whose items are copied to dstFramePtr. |
| pffgItemIdx | The id of the frame currently analyzed. Only needed for message generation. |
| dstFramePtr | The frame into which the tags are to be copied. |
| dcmMsgCollector | Collects error, info and issue messages (typically related to a handle). |
References addSequenceContents(), and MLDICOMTags_EXPORT.
Referenced by addSequenceContents().
| MLDICOMTags_EXPORT void ml::MultiFrameTools::addSubSequenceTags | ( | DCMTree::RawTagId | sequenceTagId, |
| std::vector< DCMTree::RawTagId > * | copyTagIds, | ||
| DCMTree::Const_TreePtr | srcTree, | ||
| size_t | frameIdx, | ||
| DCMTree::TreePtr & | dstTree, | ||
| DicomMessageCollector & | dcmMsgCollector ) |
Gets the tag with ID sequenceTagId from the given srcTree, checks whether it is a sequence tag, and if yes, then it copies the tags with ids given by copyTagIds
| sequenceTagId | The tag id of the sequence to be extracted. |
| copyTagIds | The tag ids of the tags to be copied from the sequence with id sequenceTagId; if nullptr then the entire sequence is copied. |
| srcTree | The tree from which the sequence tag and the copy tag shall be searched/copied. |
| frameIdx | The id of the frame currently analyzed. Only needed for message generation. |
| dstTree | The tree to which the copy of the tag shall be added. |
| dcmMsgCollector | Collects error, info and issue messages (typically related to a handle). |
References addSubSequenceTags(), and MLDICOMTags_EXPORT.
Referenced by addSubSequenceTags().
| MLDICOMTags_EXPORT void ml::MultiFrameTools::copyTopLevelTags | ( | DCMTree::Const_TreePtr | mfTree, |
| DCMTree::TreePtr | dstTree, | ||
| const DICOMTagTools::TagIdDesc * | tagsToCopy, | ||
| bool | alsoCopySequenceTags, | ||
| DicomMessageCollector * | dcmMsgCollector = nullptr ) |
This routine copies root tags from mfTree to destTree; pixel data and/or sequence tags are possibly skipped according to function arguments.
| mfTree | is the source tree whose tags are to be copied, ignored if nullptr. |
| dstTree | is the tree into which the tags shall be copied, ignored if nullptr. |
| tagsToCopy | if nullptr (the default) then all top level tags are copied exclusive pixel data tags(DCMTree_PixelData, DCMTree_FloatPixelData, DCMTree_DoubleFloatPixelData, spectDataTagId1(0x7fe1, 0x1010) and DCMTree::TagId spectDataTagId2(0x5600, 0x0020)) and sequence tags are copied according to alsoCopySequenceTags, if non-nullptr exactly those ones given in tagsToCopy (even with pixel data and/or sequence tags regardless of alsoCopySequenceTags). Non nullptr tagsToCopy must be terminated with {0, ""}. |
| alsoCopySequenceTags | If true then also top levels sequence tags are copied if tagsToCopy is nullptr. |
| dcmMsgCollector | Ignored if nullptr, messages and errors are logged as ML error/warnings then; otherwise messages are logged into dcmMsgCollector. |
References copyTopLevelTags(), and MLDICOMTags_EXPORT.
Referenced by copyTopLevelTags().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::doMultiFrameDecomposition | ( | DCMTree::Const_TreePtr | mfTree, |
| std::vector< DCMTree::TreePtr > & | singleFrameList, | ||
| const DICOMTagTools::TagIdDesc * | tagsToCopy, | ||
| const DICOMTagTools::TagIdDesc * | tagsToRemove, | ||
| bool | addFullFunctionalGroupSequences, | ||
| DicomMessageCollector & | dcmMsgCollector ) |
Decomposes a the multi-frame file given by fileAttributes and adds each frame as a single frame with _addFile. If mfTree is no multi-frame tree or the value of the NumberOfFrames tags is <= 1 then no decomposition is performed and return arguments are not modified.
| mfTree | The DICOM tag tree from which all single frame trees will be extracted. |
| singleFrameList | Returns a vector containing single frame trees for each frame in mfTree. |
| tagsToCopy | if nullptr (the default) then all top level non sequence tags exclusive pixel data tags are copied, otherwise those ones given in tagsToCopy. If non nullptr then tagsToCopy must be terminated with {0, ""}. |
| tagsToRemove | If non nullptr then all tags with the given ids are removed from the top level of the created trees, otherwise this argument is ignored. If non nullptr then tagsToRemove must be terminated with {0, ""}. |
| addFullFunctionalGroupSequences | Older versions only copied the contents of functional sequences to the top-level of the generated frames, which however, is not sufficient for newer requirements, thus now the entire sequences are also copied if this flag is on. It can be disabled for backwards compatibility. |
| dcmMsgCollector | Collects error, info and issue messages (typically related to a handle). |
References doMultiFrameDecomposition(), and MLDICOMTags_EXPORT.
Referenced by doMultiFrameDecomposition().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::extractSingleFramesFromMultiFrameTree | ( | DCMTree::Const_TreePtr | dcmMFTree, |
| std::vector< DCMTree::TreePtr > & | singleFrameList, | ||
| const DICOMTagTools::TagIdDesc * | tagsToCopy, | ||
| const DICOMTagTools::TagIdDesc * | tagsToRemove, | ||
| bool | addFullFunctionalGroupSequences, | ||
| DicomMessageCollector & | dcmMsgCollector ) |
If possible this routine tries to build a set of DICOM trees (one for each frame) from the multi-frame or enhanced CT DICOM tree and returns them in singleFrameList. For dcmMFTree not containing enhanced CT or multi-frame structures in PerFrameFunctionalGroupsSequence singleFrameList will be returned empty without warnings or errors. TODO: Currently only a predefined subset of tags is extracted from subtrees. In future this perhaps will be provided as an additional argument to copy all or a user defined subset.
| dcmMFTree | The DICOM tag tree from which all single frame trees will be extracted. |
| singleFrameList | Returns a vector containing single frame trees for each frame in dcmMFTree. |
| tagsToCopy | if nullptr (the default) then all top level non sequence tags exclusive pixel data tags are copied, otherwise those ones given in tagsToCopy. If non nullptr then tagsToCopy must be terminated with {0, ""}. |
| tagsToRemove | If non nullptr then all tags with the given ids are removed from the top level of the created trees, otherwise this argument is ignored. If non nullptr then tagsToRemove must be terminated with {0, ""}. Note: tags may be added again from shared or per-frame functional entries after removing them from top level or as default tags from other tree generators in DICOM importers to fulfil DICOM standard requirements. |
| addFullFunctionalGroupSequences | Older versions only copied the contents of functional sequences to the top-level of the generated frames, which however, is not sufficient for newer requirements, thus now the entire sequences are also copied if this flag is on. It can be disabled for backwards compatibility. |
| dcmMsgCollector | Collects error, info and issue messages (typically related to a handle). |
References extractSingleFramesFromMultiFrameTree(), and MLDICOMTags_EXPORT.
Referenced by extractSingleFramesFromMultiFrameTree().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::isDecomposedEnhancedDCMTree | ( | DCMTree::Const_TreePtr | dcmTree | ) |
Returns true if dcmTree seems to be a tree which had been decomposed with for example DirectDicomImport; returns true on success and false on null dcmTree or one which seems to be of true non enhanced nature.
References isDecomposedEnhancedDCMTree(), and MLDICOMTags_EXPORT.
Referenced by isDecomposedEnhancedDCMTree().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::isEnhanced | ( | DCMTree::Const_TreePtr | dcmTree | ) |
Returns true if dcmTree seems to be a valid dcmTree and and enhanced IOD denoted with an enhanced SOPClassUID; nullptr trees return false. Note that this may not return true on enhanced frames resulting from the decomposition process of for example DirectDicomImport; consider using wasOrIsEnhancedDCMTree for that purpose.
References isEnhanced(), and MLDICOMTags_EXPORT.
Referenced by isEnhanced().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::isSingleFrame | ( | DCMTree::Const_TreePtr | dcmTree | ) |
Returns true if dcmTree seems to be a valid dcmTree and no multi-frame file; nullptr trees return false.
References isSingleFrame(), and MLDICOMTags_EXPORT.
Referenced by isSingleFrame().
| MLDICOMTags_EXPORT bool ml::MultiFrameTools::wasOrIsEnhancedDCMTree | ( | DCMTree::Const_TreePtr | dcmTree | ) |
Returns true if dcmTree seems to be a valid enhanced tree or one which had been decomposed with for example DirectDicomImport. Will return true on success and false on null dcmTree or one which seems to be of true non enhanced nature.
References MLDICOMTags_EXPORT, and wasOrIsEnhancedDCMTree().
Referenced by wasOrIsEnhancedDCMTree().
|
extern |
A list of tags which should not copied from a top level multi-frame tree to a single frame, because they do not make sense for single frames any more or because they could provide invalid information if the information is not overwritten by specific subframes. This list is terminated with {0, ""}.
1.15.0