mlDicomSaveBase.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLDicomOutputsSystem.h"
 
// ML includes
#include <mlModuleIncludes.h>
 
// DICOM tree etc.
#include <DCMTree_Tree.h>

#include <mlTreeAndVolumeInputFieldAddOn.h>
 
// AddOn for DicomTagDumps.
#include <mlDicomTagDumpFieldAddOn.h>
 
ML_START_NAMESPACE
 
// Forwards
class DicomMessageCollector;
 
//----------------------------------------------------------------------------------
// See above.
//----------------------------------------------------------------------------------
class MLDICOMOUTPUTS_EXPORT DicomSaveBase : public Module
{
public:

  DicomSaveBase(int numInputs=1, int numOutputs=0);

  
  inline const BoolField    &getCopyOtherInputTagsFld()   const { return *_copyOtherInputTagsFld   ; }
  inline       BoolField    &getDumpPrivateTagValuesFld() const { return _dicomTagDumpFieldAddOn.getDumpPrivateTagValuesFld(); }
  inline const StringField  &getFileNameField()           const { return *_fileNameFld             ; }
  inline const NotifyField  &getInheritDICOMTagsFld()     const { return *_inheritDICOMTagsFld     ; }
  inline const BoolField    &getPostBadParamErrorsField() const { return *_postBadParamErrorsFld   ; }
  inline       NotifyField  &getSaveField()               const { return *_saveFld                 ; }
  inline       StringField  &getStatusField()             const { return *_statusFld               ; }
  inline       IntField     &getTagDumpSizeFld()          const { return _dicomTagDumpFieldAddOn.getTagDumpSizeFld(); }
  inline       StringField  &getTagDumpFld()              const { return _dicomTagDumpFieldAddOn.getTagDumpFld(); }

  static std::string checkXYZValues(const ImageVector &ext);
  
  static std::string checkMaximumPixelDataSize(const PagedImage &inImg);
 
protected:

  void                            handleNotification(Field *field) override;

  void                            activateAttachments() override;

  virtual void                    _inheritFieldValuesFromDCMTree(DCMTree::Const_TreePtr dcmTree)=0;

  inline DCMTree::Const_TreePtr   _getCurrentOriginalInputTree() const { return _currentOriginalInputTree; }
  
  inline DCMTree::TreePtr         _getCurrentModifiableTree() const { return _currentModifiableTree; }

  inline PagedImage              *_getCurrentInImg() const { return _currentInImg; }

  inline bool                    &_getAllowNULLInputTree() { return _allowNULLInputTree; }
  
  virtual std::string             _checkConsistency() const=0;

  virtual std::string             _setUpTreeContent() = 0;
 
  
  // Stuff below is sometimes useful in derived classes but mostly not needed:
  //--------------------------------------------------------------------------
  
  virtual DCMTree::Const_TreePtr  _getInputDCMTree(DicomMessageCollector &dcmMsgCollector);
  
  virtual std::string             _getInputImageConfiguration(int                    inputImageConnector,
                                                              DCMTree::Const_TreePtr &originalInputImageTree,
                                                              DCMTree::TreePtr       &resultDcmTree,
                                                              PagedImage             *&inImg);

  virtual void                    _updateInputState();

  virtual void                    _updateTagDump(DCMTree::Const_TreePtr dcmTree);

  virtual void                    _createInputModifierConnector();
  
 
  virtual std::string             _applyInputModifiersIfAvailable(DCMTree::TreePtr     dcmTree,
                                                                  const FieldContainer *treeInfos=nullptr);

  virtual void                    _save();

  TreeAndVolumeInputFieldAddOn _dcmTreeInputFieldAddOn;
  
  DicomTagDumpFieldAddOn       _dicomTagDumpFieldAddOn;
  
private:
  DCMTree::Const_TreePtr       _currentOriginalInputTree;
  
  DCMTree::TreePtr             _currentModifiableTree;

  PagedImage                  *_currentInImg;

  bool                        _allowNULLInputTree;


  BoolField   *_copyOtherInputTagsFld;
  NotifyField *_inheritDICOMTagsFld;

  
  NotifyField *_saveFld;
  StringField *_fileNameFld;  

  BoolField   *_postBadParamErrorsFld;

  StringField *_statusFld;

  BaseField   *_inputModifierListFld;

  ML_MODULE_CLASS_HEADER(DicomSaveBase);
};
 
ML_END_NAMESPACE