mlZTUFileNameSet.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
 
#pragma once
 
#include "MLMLToDicomToolsSystem.h"
#include <mlDICOMCachedIOFileHandle.h>
#include <mlDICOMCachedIOProxies.h>
#include <mlZTUIndex.h>
#include <mlTypeDefs.h>
#include <DCMTree_Tree.h>
 
#include <FMEThirdPartyWarningsDisable.h>
#include <map>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
 
ML_START_NAMESPACE
 
class DicomMessageCollector;

class ML_MLToDicomTools_EXPORT ZTUFileNameSet {
  public:
    ZTUFileNameSet();
  
    ZTUFileNameSet(const ZTUFileNameSet &otherObject);
  
    ~ZTUFileNameSet();
  
    typedef std::vector< std::vector< std::vector<DICOMCachedIOFileHandle > > > FileNameSet;

    inline ZTUFileNameSet &operator=(const ZTUFileNameSet &otherObj)
    { 
      if (&otherObj != this){
        // Do not/cannot assign cacheProxies!
        _pageFileNames = otherObj._pageFileNames;
      }
      return *this;
    }

    inline bool operator==(const ZTUFileNameSet &otherObj) const
    { 
      return _pageFileNames == otherObj._pageFileNames; 
    }

    inline bool operator!=(const ZTUFileNameSet &otherObj) const
    { 
      return !operator==(otherObj); 
    }

    bool hasEmptyPagesFileName() const;
  
    bool hasMultiFrameHandle() const;
  
    bool hasNormalFrameHandle() const;

    bool allHandlesExistAsFile(bool allowEmpty) const;

    bool areAllEntriesIdentical() const;

    void resizePageFileNamesToVolumeSize(size_t newZExt, size_t newTExt, size_t newUExt);

    inline void clearPageFileNames() {
      _pageFileNames.clear();
    }

    inline const FileNameSet &getConstPageFileNameSet() const {
      return _pageFileNames;
    };

    inline FileNameSet &getModifiablePageFileNameSet() {
      return _pageFileNames;
    };

    inline void setPageFileNames(const FileNameSet& pFNames) {
      _pageFileNames = pFNames;
    }

    size_t getZExtent() const;

    size_t getTExtentAt(size_t z = 0) const;

    size_t getTExtent() const;

    size_t getUExtentAt(size_t z = 0, size_t t = 0) const;

    size_t getUExtent() const;

    size_t getNumFrames() const;

    bool isValidPosition(size_t z, size_t t, size_t u) const;

    const DICOMCachedIOFileHandle &getPageFileName(size_t z, size_t t, size_t u=0) const;

    void setPageFileName(size_t z, size_t t, size_t u, const std::string fName);

    void appendFileName(const std::string& fileName, bool appendToZ);

    void appendFileNameToZ(const std::string& fileName);

    void appendFileNameToT(const std::string& fileName);

    void appendFileNameToU(const std::string& fileName);

    std::string getFileNameSetAsInfoString(bool fileNamesOnly = false) const;

    DICOMCachedIOFileHandle getFirstNonEmptyFileName() const;

    DICOMCachedIOFileHandle getOriginalFrameHandle() const;
    
    std::vector<DICOMCachedIOFileHandle> getAllFileHandles(const DICOMTagTools::ZTUVector &suppressedHandles = 
                                                           DICOMTagTools::ZTUVector()) const;

    std::string getStateAsString(const std::string& lineEndStr, 
                                 const std::string& cacheFileRootDirPath,
                                 bool useRelativePaths) const;

    MLErrorCode setStateFromString(const std::string & state, 
                                   size_t tExt, 
                                   size_t uExt,
                                   const std::string& cacheDirPath,
                                   size_t& readPos);
    
    bool searchFrameWithSOPInstanceUID(const std::string       &sopInstanceUID,
                                       DICOMCachedIOFileHandle &foundHandle,
                                       DICOMTagTools::ZTUIndex &ztuPosition,
                                       bool                    forceSearchInEnhancedHandles,
                                       DicomMessageCollector   &dcmMsgCollector) const;

    bool searchFrameWithValueInTag(unsigned int            tagId,
                                   const std::string       &tagValue,
                                   DICOMCachedIOFileHandle &foundHandle,
                                   DICOMTagTools::ZTUIndex &ztuPosition,
                                   bool                    forceSearchInEnhancedHandles,
                                   DicomMessageCollector   &dcmMsgCollector) const;

    typedef std::map<DICOMTagTools::ZTUIndex, DCMTree::Const_TagPtr> TagsWithPositionMap;
    
    TagsWithPositionMap getTagFromAllFrames(unsigned int            tagId,
                                            bool                    forceSearchInEnhancedHandles,
                                            bool                    doStringToValue,
                                            DicomMessageCollector   &dcmMsgCollector,
                                            bool                    createNullTagEntries=false,
                                            const std::string       &nullEntryTagValue="",
                                            bool                    createNotConvertibleTagEntries=false,
                                            const std::string       &nonConvertibleTagValue="") const;

    bool needsNewSOPInstanceUID(bool allowOneToOneEnhancedFrameRecomposition,
                                DicomMessageCollector &dcmMsgCollector) const;
    
  private:
    DCMTree::Const_TagPtr _getTagFromHandle(const DICOMCachedIOFileHandle &frameHandle,
                                            unsigned int                  tagId,
                                            bool                          forceSearchInEnhancedHandles,
                                            DicomMessageCollector         &dcmMsgCollector) const;
    
    MLDICOMCachedIOProxies _cacheProxies;
    
    FileNameSet _pageFileNames;
};

typedef ZTUFileNameSet DirectDicomImportPageFileNameSet;
 
ML_END_NAMESPACE