mlDICOMTreeModificationTools.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
#pragma once
 
#include "MLDICOMTagsSystem.h"
 
#include <FMEThirdPartyWarningsDisable.h>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
 
#include <mlUtilsSystem.h>
 
// DICOM Tree prototypes.
#include <DCMTree_Lib.h>
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
namespace DICOMTagTools {
 
MLDICOMTags_EXPORT void removeTag(DCMTree::TreePtr dcmTree,
                                  DCMTree::TagId tagId);
 
MLDICOMTags_EXPORT void removePrivateTag(DCMTree::TreePtr  dcmTree,
                                         unsigned char     tagIdLowerEightBits,
                                         const std::string &privateCreatorString);
 
MLDICOMTags_EXPORT void removePrivateCreatorTag(DCMTree::TreePtr  dcmTree,
                                                const std::string &privateCreatorString);
 
MLDICOMTags_EXPORT void removePrivateSMFTreeTags(DCMTree::TreePtr dcmTree,
                                                 bool             alsoRemovePrivateCreator);
 
MLDICOMTags_EXPORT void removePrivateTagGroup(DCMTree::TreePtr  dcmTree,
                                              bool              removeAllPrivateTags=false,
                                              const std::string &privateCreatorString="");
 
MLDICOMTags_EXPORT void removeType3Tags(DCMTree::TreePtr dcmTree);
 
typedef struct {
  MLuint32      id;  
  const char *name;  
} 
DcmTagIdToRemove, 
TagIdDesc;        
 
MLDICOMTags_EXPORT void removeTags(DCMTree::TreePtr       resultTree,
                                   const DcmTagIdToRemove srcTagsToRemove[]);
 
MLDICOMTags_EXPORT void removeMaskedTags(DCMTree::TreePtr dcmTree,
                                         MLuint32         idVal,
                                         MLuint32         idMask);
 
MLDICOMTags_EXPORT void recursiveRemoveTags(DCMTree::TreePtr                  &dcmTree,
                                            const std::vector<DCMTree::TagId> &listOfIdsToRemove);
 
MLDICOMTags_EXPORT void removeEmptyItemsAtEnd(DCMTree::TagPtr seqTagPtr);
 
MLDICOMTags_EXPORT void recursiveSequenceTagCleanUp(DCMTree::TagPtr seqTagPtr);
 
MLDICOMTags_EXPORT void recursiveSequenceTagCleanUp(DCMTree::TreePtr treePtr);
 
MLDICOMTags_EXPORT void recursiveTagManipulate(DCMTree::TreePtr      treePtr,
                                               const DCMTree::TagId  &tagId,
                                               bool                  remove         = true,
                                               const std::string     &newVal        = "",
                                               size_t                *numGoodManips = nullptr,
                                               size_t                *numBadManips  = nullptr,
                                               size_t                recursionLevel = 0);
 
MLDICOMTags_EXPORT void removePrivateMultiFrameTag(DCMTree::TreePtr &treePtr);
 
MLDICOMTags_EXPORT bool removePixelDataTag(DCMTree::TreePtr treePtr);
 
MLDICOMTags_EXPORT bool removeAllTypesPixelDataTags(DCMTree::TreePtr treePtr);
 
MLDICOMTags_EXPORT bool removeSpectDataTag(DCMTree::TreePtr treePtr);
 
MLDICOMTags_EXPORT bool removeREGDataTag(DCMTree::TreePtr treePtr);
 
MLDICOMTags_EXPORT std::vector<DCMTree::RawTagId> removeLargeTags(DCMTree::TreePtr treePtr,
                                                                  size_t           tagSizeToRemove=0x00040000);
 
MLDICOMTags_EXPORT DCMTree::TreePtr getSequenceItemTree(DCMTree::TagPtr tagPtr,
                                                        size_t          itemIdx);
 
enum OtherTagModificationModes {
  OtherTagDoNotModify = 0,       
  DropType2SQTagValues,          
  DropType3SQTagValues,          
  ReplaceType2Tags,              
  ReplaceType3Tags,              
  RemoveType3Tags                
};
 
enum { NumOtherTagModificationModes = RemoveType3Tags+1 };
 
extern MLDICOMTags_EXPORT const char * const OtherTagModificationModesStrings[NumOtherTagModificationModes];
 
MLDICOMTags_EXPORT void manipulateType2Or3Tags(DCMTree::TreePtr          dcmTree,
                                               OtherTagModificationModes modificationMode,
                                               const std::string         &modStrVal);
 
MLDICOMTags_EXPORT void initNULLSequenceItemsToEmptyTrees(DCMTree::TagPtr tag,
                                                          size_t          from,
                                                          size_t          to,
                                                          std::string     &errStr);
 
MLDICOMTags_EXPORT void resizeToNumberOfSequenceEntries(DCMTree::TagPtr tag,
                                                        MLint           numEntries,
                                                        std::string     &errStr);
 
};
 
ML_END_NAMESPACE