mlDirectDicomImportDPLTagValueProvider.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
 
//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLDirectDicomImportSystem.h"
 
// ML includes
#include <mlTypeDefs.h>
#include <FMEThirdPartyWarningsDisable.h>
#include <map>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
#include <mlConstantString.h>
#include <mlDicomMessageCollector.h>
 
// Needed DPL includes for the provider.
#include "DPL_TagValueProvider.h"
#include "DPL_TagValue.h"
#include "DCMTree_TagId.h"
 
namespace DPL {
  class ErrorInfo;
  class Logger;
  class TagInfo;
}
 
ML_START_NAMESPACE
 
// Forwards
class DirectDicomImportImporterBase;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
typedef std::map< std::string, int> FileLoadStateLookUp;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDIRECTDICOMIMPORT_EXPORT DirectDicomImportDPLTagValueProvider : public DPL::TagValueProvider
{
public:
 
  //----------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------
  typedef struct {
    DCMTree::RawTagId id;
 
    std::string val;
 
  } HardOverwriteTag;
 
  DirectDicomImportDPLTagValueProvider(DPL::Logger                             &logger,
                                       DirectDicomImportImporterBase           &importer,
                                       const std::vector<HardOverwriteTag>     &hardOverwriteTags);
 
  void                  setAllowSortingAccordingToDimensionIndexValues(const std::string &allowMode); 
 
  const std::string     &setAllowSortingAccordingToDimensionIndexValues() const;
 
  void                  setWorkaroundImageOrientationPatientTag(const std::string &workaroundValue); 
 
  const std::string     &getWorkaroundImageOrientationPatientTag() const;
 
  const ConstantString &getFrameName() const;
 
  DPL::TagValue getTagValue(const DPL::FrameId  fullFilePath,
                            const DPL::TagInfo  &tagInfo,
                            DPL::ErrorInfo      *error = nullptr) const override;
 
private:
  
  void _setUpFrameName(const DPL::FrameId fullFilePath,
                       DPL::ErrorInfo     *error) const;
 
  bool _loadTagFromFrameId(const DPL::TagInfo                  &tagInfo,
                           DPL::ErrorInfo                      *error,
                           DCMTree::Const_TagPtr               &loadedTagPtr,
                           ML_NAMESPACE::DicomMessageCollector &dcmMsgCollector) const;
 
  void _calculateTagValueForNonFoundTags(const DPL::TagInfo &tagInfo,
                                         std::string        &tagValToReturn) const;
 
  void _handleMissingSeriesInstanceUID(const std::string &modality,
                                       std::string       &tagValToReturn) const;
 
  void _handleMissingImagePositionPatient(const std::string &modality,
                                          std::string       &tagValToReturn) const;
 
  void _handleMissingImageOrientationPatient(const std::string &modality,
                                             std::string       &tagValToReturn) const;
 
  bool _applyHardOverWriteTags(DCMTree::RawTagId rawTagId,
                               std::string       &tagValueToReturn) const;
 
  void _getTagValueFromTag(const DPL::TagInfo &tagInfo,
                           const DCMTree::Tag &tag,
                           DPL::ErrorInfo     *error,
                           std::string        &tagValueToReturn, 
                           int                &numValues) const;
 
  DPL::Logger                             &_logger;
 
  enum { DDI_FILE_PATH_NOT_IN_MAP = -1,
         DDI_FILE_LOAD_FAILED     =  0,
         DDI_FILE_LOAD_SUCCESSFUL =  1} DDIFileLoadState;
 
  std::vector<HardOverwriteTag>            _hardOverwriteTags;
 
  
  DirectDicomImportImporterBase           &_importer;
 
  mutable ConstantString                   _frameName;
 
  std::string                              _allowSortingAccordingToDimensionIndexValues;
  
  std::string                              _workaroundImageOrientationPatientTag;
 
  mutable DicomMessageCollector            _dcmMsgCollector;
 
  private:
    
    DirectDicomImportDPLTagValueProvider();
    DirectDicomImportDPLTagValueProvider(const DirectDicomImportDPLTagValueProvider&);
    DirectDicomImportDPLTagValueProvider& operator=(const DirectDicomImportDPLTagValueProvider&);
    
    typedef std::map<std::string, DCMTree::RawTagId> _LocalTagIdMap;
    mutable _LocalTagIdMap _tagIdLookup;
};
 
 
ML_END_NAMESPACE