mlDirectDicomImport.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 <mlModuleIncludes.h>
#include <mlTimeCounter.h>
 
// Module to convert MultiFileVolumes to ML images, to scan for min/max and to save.
#include "mlMultiFileVolumeListImageOutput.h"
 
// Container for MultiFileVolumeList to be connected to base outputs.
#include "mlMultiFileVolumeListRefCounted.h"
 
// FilListFilter functionality to file file sets before importing them.
#include "mlFileListFilterPlugin.h"
 
// DICOM tree prototypes.
#include <DCMTree_Lib.h>
 
// References DICOM caches to prevent their removal during life time of this.
#include "mlDICOMCachedIOProxies.h"
 
// AddOn for DicomTagDumps.
#include <mlDicomTagDumpFieldAddOn.h>
 
// Configurable message collector class(es).
#include "mlDicomConfigurableMessageFilter.h"
 
// Forward to internally or friend used class.
class MLDirectDicomImportWrapper;
class VolumeBuilderGeneric;
class VolumeBuilderFromDICOMs;
 
ML_START_NAMESPACE
 
// Forwards to internally or only incompletely used classes.
class DirectDicomImportDPLImporter;
class DirectDicomImportImporterBase;
class DirectDicomImportOtherImporter;
class MultiFileVolume;
class MultiFileVolumeListView;
class ProgressLogger;
namespace FileListTools {
  class FileList;
}
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDIRECTDICOMIMPORT_EXPORT DirectDicomImport : public Module
{
public:

  DirectDicomImport ();

  ~DirectDicomImport() override;

  
  bool                                    isStopImportingPressed() const;

  static bool                             isStopImportingPressedCB(void *ddiOpPtr);

  void                                    updateConsole(bool force=true);

  static void                             updateProgressIndicatorCB(void *userData,
                                                                    const std::string &info,
                                                                    float state);

  void                                    updateProgressIndicator(const std::string &info, 
                                                                  float state);
 
protected:
  friend class ::MLDirectDicomImportWrapper;
  friend class DirectDicomImportImporterBase;
  friend class ::VolumeBuilderGeneric;
  friend class ::VolumeBuilderFromDICOMs;
  
  MultiFileVolumeList                     &getNonConstOutVolumes();
  
  const MultiFileVolumeList               &getConstOutVolumes() const;

  void                                    _resetMessageFlags();

  void                                    _writeResultCache();
 

  void                                    handleNotification(Field *field) override;

  void                                    activateAttachments() override;

  virtual DicomConfigurableMessageFilterBaseRefCountedPtr _getMessageCollector();
  
  // ----------------------------------------------------------
  // ----------------------------------------------------------

  virtual void                            calculateOutputImageProperties(int outIndex, 
                                                                         PagedImage* outImg) override;

  virtual void                            calculateOutputSubImage(SubImage *outSubImg, 
                                                                  int outIndex, 
                                                                  SubImage *inSubImgs) override;

 
private:
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  
  void                                    _import();

  void                                    _populateFileList(const std::string              &srcDirPath, 
                                                            const std::vector<std::string> &additionalFiles, 
                                                            FileListTools::FileList        &fileList);

  void                                    _importLabeledFileList(size_t fListIdx, 
                                                                 size_t numFLists, 
                                                                 const FileListTools::FileList& fileList);

  bool                                    _importDirectoriesAndFiles(std::vector<std::string> srcDirPaths, 
                                                                     std::vector<std::string> singleAdditionalFiles,
                                                                     bool interrupted);
  
  void                                    _importDicomAndNonDicomFromFileList(const FileListTools::FileList &fileList, 
                                                                              size_t numVolumesBeforeDicomImports, 
                                                                              bool& interrupted, 
                                                                              size_t& numDCMImports, 
                                                                              size_t& numNonDCMImports);

  void                                    _logPlannedImportFromFileList(const std::vector<std::string>& srcDirPaths, 
                                                                        const std::vector<std::string>& singleAdditionalFiles, 
                                                                        const std::string& srcDirPath);
  
  void                                    _logImportFinishState(bool interrupted, 
                                                                size_t numDCMImports, 
                                                                size_t numNonDCMImports);
 
  
  DCMTree::Const_TreePtr                  _getSelectedDCMTree(bool checkImgProps=false);

  bool                                    _isCachingEnabledAndHasPath() const;
  
  bool                                    _verifyAndOrCreateResultCacheDirectory() const;

  void                                    _updateTreeCacheSizeInformation();
  void                                    _updateTagCacheSizeInformation();
  void                                    _clearCaches();

  void                                    _logDICOMCacheInfos(ProgressLogger &logger, bool forceLog=false);

  bool                                    _flushAndCheckDICOMCacheOverflow(ProgressLogger &logger);

  bool                                    _flushAndCheckDICOMTagCacheOverflow(ProgressLogger &logger);

  bool                                    _flushAndCheckDICOMTreeCacheOverflow(ProgressLogger &logger);
  
  
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  
  MultiFileVolume                         *_updateImageOutputToSelectedIndex();

  void                                    _appendDirectDicomImportFields();

  void                                    _updateInfoFields(bool updateTagDump);

  void                                    _showCurrentIssue();
 
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  
  TimeCounter                       _updateCounter;

  MultiFileVolumeListRefCountedPtr  _outVolumes;

  MultiFileVolumeListImageOutput    _currentDDIOutput;

  MultiFileVolumeListView           *_volumeListView;

  DirectDicomImportDPLImporter      *_dplImporter;

  DirectDicomImportOtherImporter    *_otherImporter;

  MLDICOMCachedIOProxies            _cacheProxies;
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------

  BaseField                 *_outputAccessConnectorFld;

  BaseField                 *_inputFilterPluginFld;

  BaseField                 *_inputMessageFilterPluginFld;

  StringField               *_fullSrcDirPathFld;
 

  StringField               *_fullUserSrcDirPathsFld;

  StringField               *_fullUserSrcDirPathsResolvedFld;

  BoolField                 *_useFullUserSrcDirPathsCommentPrefixFld;

  StringField               *_fullUserSrcDirPathsCommentPrefixFld;
 

  StringField               *_fullTargetPathFld;

  StringField               *_cachePathFld;

  BoolField                 *_useRelativeCachePathsFld;
  
  BoolField                 *_writeSingleVolumeCacheFilesFld;
  
  BoolField                 *_cachePathAutoCreateFld;
  
  StringField               *_cacheFileNameFld;

  StringField               *_consoleFld;

  IntField                  *_consoleSizeInKiloBytesFld;
  
  NotifyField               *_clearConsoleFld;

  IntField                  *_outVolIdxFld;

  NotifyField               *_dplImportFld;

  BoolField                 *_clearAfterImportFld;

  BoolField                 *_clearSingleFrameCacheAfterImportFld;
  
  NotifyField               *_clearSingleFrameCacheFld;
  
  NotifyField               *_clearCacheFld;

  NotifyField               *_clearResultCacheFld;

  NotifyField               *_clearVolumeListFld;

  NotifyField               *_loadResultCacheFld;

  BoolField                 *_preferCacheBeforeImportFld;

  NotifyField               *_saveResultCacheFld;
  
  NotifyField               *_stopImportingFld;

  BoolField                 *_useResultCachingFld;

  ProgressField             *_progressFld;

  StringField               *_progressInfoFld;

  IntField                  *_maxCachedMegaBytesTreeCacheFld;

  IntField                  *_maxCachedMegaBytesTagCacheFld;
  
  BoolField                 *_dicomCacheEditableFld;
  
  BoolField                 *_processingFld;
 
 
  //--------------------------------------------------------------
  //--------------------------------------------------------------
  
  IntField                  *_numVolumesFld;

  IntField                  *_totalSlicesFld;

  IntField                  *_totalTimePointsFld;

  IntField                  *_totalSlicesMultTimePointsFld;

  DoubleField               *_totalVoxelsFld;

  IntField                  *_extFld[6];

  DoubleField               *_numVolVoxelsFld;

  DicomTagDumpFieldAddOn    _dicomTagDumpFieldAddOn;

  StringField               *_volumeInfoDumpFld;

  StringField               *_fileListInfoFld;

  StringField               *_suppressedFilesAndSuffixesFld;

  StringField               *_explicitFileTypesFld;
 

  StringField               *_inputFileListFld;

  StringField               *_inputFileListResolvedFld;

  BoolField                 *_useInputFileListCommentPrefixFld;

  StringField               *_inputFileListCommentPrefixFld;
 

  BoolField                 *_hadWarningsFld;

  BoolField                 *_hadErrorsFld;
  
  BoolField                 *_logDicomCacheInfosFld;
  
  BoolField                 *_warnDicomCacheOverflowsFld;

  ML_MODULE_CLASS_HEADER(DirectDicomImport);
};
 
 
ML_END_NAMESPACE