mlDicomModifyMultiFileVolumeExport.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once

#include "MLDicomModifySystem.h"

#include <mlModuleIncludes.h>

#include <mlDicomModifyList.h>

#include <mlDicomTree.h>

#include <mlTreeAndVolumeInputFieldAddOn.h>

#include "mlDICOMCachedIOFileHandle.h"

#include <mlZTUFileNameSet.h>

#include <mlStringLineMultiField.h>

#include <mlDICOMCachedIOProxies.h>
 
ML_START_NAMESPACE

class ZTUFileNameSet;
class ProgressLogger;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class ML_DICOM_MODIFY_EXPORT DicomModifyMultiFileVolumeExport : public Module
{
public:
 
  DicomModifyMultiFileVolumeExport();
 
protected:

  void activateAttachments() override;

  void handleNotification(Field *field) override;
  
  const ZTUFileNameSet *_getInputVolumeFileSet(Matrix4 *w2vMatrix   = nullptr,
                                               bool    *validMatrix = nullptr) const;

  bool _requiresModifications() const;

  DICOMTagTools::ZTUIndex _getZTUPos(const DICOMCachedIOFileHandle &fileHandle,
                                     const ZTUFileNameSet          &fileSet,
                                     DicomMessageCollector         &dcmMsgCollector);

  DICOMTagTools::ZTUVector _getZTUSuppressions(std::string          &parseInfo,
                                               const ZTUFileNameSet &inFileSet) const;

  void _export();

  void _exportFilteredDicomBaseObject(DCMTree::Const_TreePtr inDCMTree,
                                      std::string            &oldToNewSOPInstanceUIDList,
                                      const Matrix4          *w2vMatrix,
                                      DicomMessageCollector  &dcmMsgCollector);

  void _exportFilteredFileSet(const std::vector<DICOMCachedIOFileHandle> &allFiles,
                              std::string                                &oldToNewSOPInstanceUIDList,
                              const Matrix4                              *w2vMatrix,
                              const ZTUFileNameSet                       &originalInFileSet,
                              DicomMessageCollector                      &dcmMsgCollector);

  void _createExportTree(const DICOMCachedIOFileHandle &inOrigFilePath,
                         DCMTree::Const_TreePtr        inDCMTree, 
                         DICOMCachedIOFileHandle       &recentMFFileHandle,
                         DCMTree::Const_TreePtr        &recentMFTree,
                         DCMTree::TreePtr              &modifiableExportTree,
                         DCMTree::Const_TreePtr        &constExportTree,
                         DicomMessageCollector         &dcmMsgCollector);

  void _appendExportedPath(const DICOMCachedIOFileHandle &pathOfNewlyExportedFile);

  void _exportFile(const DICOMCachedIOFileHandle &inOrigFilePath, 
                   DCMTree::Const_TreePtr        inDCMTree, 
                   size_t                        inFileIdx,
                   BaseField                     *inFilterBase,
                   const std::string             &dstDirBase,
                   const std::string             &dstFileNameSuffix,
                   std::string                   &oldSOPInstanceUID,
                   std::string                   &newSOPInstanceUID,
                   DICOMCachedIOFileHandle       &recentMFFileHandle,
                   DCMTree::Const_TreePtr        &recentMFTree,
                   const Matrix4                 *w2vMatrix,
                   const DICOMTagTools::ZTUIndex *ztuPos,
                   DicomMessageCollector         &dcmMsgCollector);

  std::string _applyDCMTreeChanges(DCMTree::TreePtr dcmTree,
                                   std::string      &oldSOPInstanceUID,
                                   std::string      &newSOPInstanceUID);

  void _setUpImageTypeTag(DCMTree::TreePtr dcmTree,
                          std::string      &errStr);

  static std::string _filterDCMTree(DCMTree::TreePtr              dcmTree,
                                    BaseField                     *inFilterBase,
                                    const Matrix4                 *w2vMatrix,
                                    const DICOMTagTools::ZTUIndex *ztuPos);

  void _saveDCMTree(DCMTree::Const_TreePtr        dcmTree,
                    const DICOMCachedIOFileHandle &srcFilePath,
                    size_t                        fileIdx,
                    const std::string             &dstDirBase,
                    const std::string             &dstFileNameSuffix,
                    std::string                   &dstFilePath,
                    DicomMessageCollector         &dcmMsgCollector);
 
private:

  MLDICOMCachedIOProxies _cacheProxies;

  TreeAndVolumeInputFieldAddOn _dcmTreeInputFieldAddOn;
 
  
  BaseField              *_inputDicomModifierFld;
 
  
  StringLineMultiField   *_ztuFrameSuppressionsFld;

  StringField            *_destinationDirectoryFld;

  StringField            *_destinationFileNameSuffixFld;

  BoolField              *_handleAllIssuesAsErrorFld;

  BoolField              *_postErrorsToMLErrorHandlerFld;
  
  NotifyField            *_exportFld;

  NotifyField            *_stopExportingFld = nullptr;
  
  ProgressLogger         _progressLogger;

  BoolField              *_isExportingFld = nullptr;

  ProgressField          *_progressFld = nullptr;
 
  // StudyInstanceUID:
  StringField            *_studyInstanceUIDFld;

  NotifyField            *_createNewStudyInstanceUIDFld;
  
  BoolField              *_modifyStudyInstanceUIDFld;
 
  
  // SeriesInstanceUID:
  StringField            *_seriesInstanceUIDFld;

  NotifyField            *_createNewSeriesInstanceUIDFld;

  BoolField              *_modifySeriesInstanceUIDFld;
 
 
  // SOPInstanceUID:
  BoolField              *_modifySOPInstanceUIDFld;
 
  
  // ImageTypeUID:
  EnumField              *_imageTypeValue1And2Fld;

  StringField            *_imageTypeValue3Fld;

  BoolField              *_modifyImageTypeValue3Fld;

  StringField            *_imageTypeValue4Fld;

  BoolField              *_modifyImageTypeValue4Fld;

  BoolField              *_modifyImageTypeFld;
 

  StringField            *_assignmentOfSOPInstanceUIDsFld;
  
  StringField            *_exportedFramePathsFld = nullptr;
 
  
  StringField            *_statusFld;
  
  ML_MODULE_CLASS_HEADER(DicomModifyMultiFileVolumeExport);
 
};
 
ML_END_NAMESPACE