mlDicomSRSave.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>
#include <mlDicomSaveBase.h>
 
// Tag/Field manager.
#include <DicomTagInterfaces/mlDicomPatientModuleTagInterface.h>
#include <DicomTagInterfaces/mlDicomGeneralStudyModuleTagInterface.h>
#include <DicomTagInterfaces/mlDicomGeneralSeriesModuleTagInterface.h>
#include <DicomTagInterfaces/mlDicomGeneralEquipmentModuleTagInterface.h>
#include <DicomTagInterfaces/mlDicomGeneralImageModuleTagInterface.h>
 
#include <FMEThirdPartyWarningsDisable.h>
#include "dcmtk/config/osconfig.h" 
#include "dcmtk/ofstd/ofstream.h"
#include "dcmtk/dcmdata/dcfilefo.h"
#include <FMEThirdPartyWarningsRestore.h>
 
// DICOM tree etc.
#include <DCMTree_Tree.h>
 
// Forward(s).
class DSRDocument;
class OFCondition;
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
// See above.
//----------------------------------------------------------------------------------
class MLDICOMOUTPUTS_EXPORT DicomSRSave : public DicomSaveBase
{
public:
 
  DicomSRSave();
 
  static OFString     toOFString(std::string str);
  
  static void         checkOFCondition(const OFCondition &cond, const std::string &loc);
 
protected:
 
  
  void        handleNotification(Field *field) override;
 
  void        activateAttachments() override;
 
  std::string _checkConsistency() const override;
 
  void        _inheritFieldValuesFromDCMTree(DCMTree::Const_TreePtr dcmTree) override;
 
  void        _save() override;
 
  
  inline       StringField  &getLongXMLInfoField()        const { return *_longXMLInfoFld          ; }
  inline const BoolField    &getSaveAsDCMField()          const { return *_saveAsDCMFld            ; }
  inline const BoolField    &getSaveAsXMLField()          const { return *_saveAsXMLFld            ; }
  inline       StringField  &getShortInfoField()          const { return *_shortInfoFld            ; }
  
private:
  // ----------------------------------------------------------
  // General tool functions.
  // ----------------------------------------------------------
 
  void _addMainParameterFields();
 
  void _addMainDICOMTagFields();
  
  std::string _setUpTreeContent() override;
 
  void _setUpContentParameters(DSRDocument &doc) const;
 
  void _setUpContentTree(DSRDocument            &doc, 
                         const PagedImage       *inImg, 
                         DCMTree::Const_TreePtr dcmTree) const;
 
  void _doFinalDocumentSettings(DSRDocument &doc) const;
 
  template <typename DCMTK_OBJECT_TYPE>
    void _setBaseTagValues(DCMTK_OBJECT_TYPE &doc) const
    {
      OFString studyIDODStr = toOFString(_generalStudyModule._studyIDFld->getStringValue());
      if (!studyIDODStr.empty()){
        doc.setStudyID(studyIDODStr);
        doc.createNewSeriesInStudy(studyIDODStr);
      }
      doc.setStudyDescription       (toOFString(_generalStudyModule._studyDescriptionFld         ->getStringValue()));
      doc.setSeriesDescription      (toOFString(_generalSeriesModule._seriesDescriptionFld       ->getStringValue()));
      doc.setPatientName            (toOFString(_patientModule._patientsNameFld                  ->getStringValue()));
      doc.setPatientBirthDate       (toOFString(_patientModule._patientBirthDateYearStringFld    ->getStringValue() +
                                                _patientModule._patientBirthDateMonthStringFld   ->getStringValue() +
                                                _patientModule._patientBirthDateDayStringFld     ->getStringValue()));
      doc.setPatientSex             (toOFString(_patientModule._patientSexStringFld              ->getStringValue()));
      doc.setPatientID              (toOFString(_patientModule._patientIDFld                     ->getStringValue()));
    
      doc.setManufacturer           (toOFString(_generalEquipmentModule.manufacturerAddOn          .getValueFld().getStringValue()));
      doc.setManufacturerModelName  (toOFString(_generalEquipmentModule.manufacturersModelNameAddOn.getValueFld().getStringValue()));
      doc.setReferringPhysicianName (toOFString(_generalStudyModule._referringPhysicianNameFld     ->getStringValue()));
      doc.setDeviceSerialNumber     (toOFString(_generalEquipmentModule.deviceSerialNumberAddOn    .getValueFld().getStringValue()));
      doc.setSoftwareVersions       (toOFString(_generalEquipmentModule.softwareVersionsAddOn      .getValueFld().getStringValue()));
      doc.setContentDate            (toOFString(_generalImageModule._contentDateFld                ->getStringValue()));
      doc.setContentTime            (toOFString(_generalImageModule._contentTimeFld                ->getStringValue()));
      doc.setSeriesNumber           (toOFString(_generalSeriesModule._seriesNumberFld              ->getStringValue()));
      doc.setInstanceNumber         (toOFString(_generalImageModule._instanceNumberFld             ->getStringValue()));
      doc.setAccessionNumber        (toOFString(_generalStudyModule._accessionNumberFld            ->getStringValue()));
    }
 
#define _SR_PRINT_DOC_SAVE(A) \
  shortStream << #A << ":" << ((doc.get##A(tmp,-1) == EC_Normal) ? tmp : "") << std::endl;
 
  //----------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------
  template <typename DCMTK_OBJECT_TYPE>
    static void _createDumps(DCMTK_OBJECT_TYPE &doc, 
                             std::string &shortInfo, 
                             std::string &longXMLInfo)
    {
      
      // Create a full XML rendering.
      std::ostringstream fullXMLStream;
      fullXMLStream << "";
      doc.writeXML(fullXMLStream, 0);
      fullXMLStream << std::endl;
      longXMLInfo = fullXMLStream.str();
      
      
      // Compose a short overview string.
      std::ostringstream shortStream;
      shortStream << "DICOM Information from file:" << std::endl;
    
      OFString tmp;
 
      _SR_PRINT_DOC_SAVE(Modality                );
      _SR_PRINT_DOC_SAVE(SOPClassUID             );
      _SR_PRINT_DOC_SAVE(StudyInstanceUID        );
      _SR_PRINT_DOC_SAVE(SeriesInstanceUID       );
      _SR_PRINT_DOC_SAVE(SOPInstanceUID          );
      _SR_PRINT_DOC_SAVE(InstanceCreatorUID      );
      _SR_PRINT_DOC_SAVE(SpecificCharacterSet    );
      _SR_PRINT_DOC_SAVE(PatientName             );
      _SR_PRINT_DOC_SAVE(PatientBirthDate        );
      _SR_PRINT_DOC_SAVE(PatientSex              );
      _SR_PRINT_DOC_SAVE(ReferringPhysicianName  );
      _SR_PRINT_DOC_SAVE(StudyDescription        );
      _SR_PRINT_DOC_SAVE(SeriesDescription       );
      _SR_PRINT_DOC_SAVE(Manufacturer            );
      _SR_PRINT_DOC_SAVE(StudyDate               );
      _SR_PRINT_DOC_SAVE(StudyTime               );
      _SR_PRINT_DOC_SAVE(InstanceCreationDate    );
      _SR_PRINT_DOC_SAVE(InstanceCreationTime    );
      _SR_PRINT_DOC_SAVE(ContentDate             );
      _SR_PRINT_DOC_SAVE(ContentTime             );
      _SR_PRINT_DOC_SAVE(StudyID                 );
      _SR_PRINT_DOC_SAVE(PatientID               );
      _SR_PRINT_DOC_SAVE(SeriesNumber            );
      _SR_PRINT_DOC_SAVE(InstanceNumber          );
      _SR_PRINT_DOC_SAVE(AccessionNumber         );
    
      shortStream << std::endl;
      shortInfo    = shortStream.str();
    }
    
#undef _SR_PRINT_DOC_SAVE
 
  // Module field declarations:
 
  BoolField   *_saveAsHTMLFld;  
 
  StringField *_longHTMLInfoFld;
 
  BoolField   *_saveAsDCMFld;  
 
  BoolField   *_saveAsXMLFld;  
 
  StringField *_shortInfoFld;
 
  StringField *_longXMLInfoFld;
  
  EnumField   *_documentTypeFld;
 
  DicomPatientModuleTagInterface          _patientModule;
  
  DicomGeneralStudyModuleTagInterface     _generalStudyModule;
  
  DicomGeneralSeriesModuleTagInterface    _generalSeriesModule;
  
  DicomGeneralEquipmentModuleTagInterface _generalEquipmentModule;
  
  DicomGeneralImageModuleTagInterface     _generalImageModule;
  
  BoolField   *_completeDocumentFld;
  StringField *_docCompletionDescriptionFld;
 
  BoolField   *_verifyDocumentFld;
  StringField *_verifyDocumentObserverNameFld;
  StringField *_verifyDocumentOrganizationFld;
 
  BoolField   *_finalizeDocumentFld;
 
  BoolField   *_preliminaryFlagFld;
  
  StringField *_documentTitleFld;
 
  StringField *_documentIntroTitleFld;
 
  StringField *_documentIntroFld;
  
  void _addTextSectionFields();
  enum {
    NumDocumentSections = 5
  };
  EnumField     *_codingValueAndMeaningFld[NumDocumentSections];
  StringField   *_codeMeaningFld[NumDocumentSections];
  BoolField     *_openSubSectionFld[NumDocumentSections];
  BoolField     *_closeSubSectionFld[NumDocumentSections];
  StringField   *_subSectionContainerTitleFld[NumDocumentSections];
  StringField   *_subSectionTitleFld[NumDocumentSections];
  StringField   *_subSectionTextFld[NumDocumentSections];
  StringField   *_sectionTextFld[NumDocumentSections];
  
  // Field input connections:
  void _addInputConnectorFields();
 
  enum {
    NumInputConnectorFields = 10
  };
 
  StringField *_inputFld[NumInputConnectorFields];
 
  ML_MODULE_CLASS_HEADER(DicomSRSave);
};
 
ML_END_NAMESPACE