mlDicomGeneralSeriesModuleTagInterface.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLDicomTagInterfacesSystem.h"
#include "mlDicomModifyFieldAddOnBase.h"
#include "mlDicomValueInheritAndCreateTagInterface.h"
#include "mlDicomCopyTagSetInterface.h"
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDICOMTAGINTERFACES_EXPORT DicomGeneralSeriesModuleTagInterface : public DicomModifyFieldAddOnBase 
{
public:
  DicomGeneralSeriesModuleTagInterface(Module &modRef, 
                                       bool useEnhancedSeriesNumber=false,
                                       const std::string &modality="",
                                       bool forceSeriesInstanceUIDAsType1=false);
  
  void        addFields() override;
  
  void        inheritValues(DCMTree::Const_TreePtr dcmTree) override;
  
  std::string applyModifications(DCMTree::TreePtr     dcmTree,
                                 const FieldContainer *treeInfos=nullptr) override;

  FieldAddOnBase::FieldChangeState handleFieldChanges(Field *field) override;

  std::string checkConsistency() const override;

  // NOTE: Although the modality tag is part of the general series module it is not provided 
  //       as field here, because normally it should not be editable by users. DICOM export
  //       modules typically have to set it manually.

  DicomValueInheritAndCreateTagInterface _seriesInstanceUIDAddOn;

  StringField *_seriesNumberFld;
  BoolField   *_inheritSeriesNumberFld;
  
  enum LateralityValues {
    DoNotWriteLateralityTag = 0,   
    WriteEmptyLateralityTag,       
    Left,                          
    Right                          
  };

  enum { NumLateralityEnumerators = 4 };
  
  static const char * const LateralityStringValues[NumLateralityEnumerators];
  
  EnumField   *_lateralityFld;

  BoolField   *_useEmptyLateralityTagIfNotFoundOnInheritanceFld;
  
  enum LateralityChecksValues {
    AsError = 0,  
    AsWarning,    
    Ignore        
  };

  enum { NumLateralityChecksEnumerators = 3 };
  
  static const char * const LateralityChecksStringValues[NumLateralityChecksEnumerators];

  EnumField   *_lateralityChecksFld;
  
  StringField *_seriesDescriptionFld;

  enum BodyPartExaminedValues {
    ABDOMEN=0, ABDOMENPELVIS, ADRENAL, ANKLE, AORTA, ARM, ATLANTOAXIAL, ATLANTOOCCIPITAL, 
    AXILLA, BACK, BLADDER, BRAIN, BREAST, BRONCHUS, BUTTOCK, CALCANEUS, 
    CALF, CAROTID, CARPUS, CEREBELLUM, CERVIX, CHEEK, CHEST, CHESTABDOMEN, 
    CHESTABDPELVIS, CIRCLEOFWILLIS, CLAVICLE, COCCYX, COLON, CORNEA, CORONARYARTERY, CSPINE, 
    CTSPINE, DIGIT, DISTALPHALANX, DUODENUM, EAR, ELBOW, ESOPHAGUS, EXTREMITY, 
    EYE, EYELID, FACE, FEMUR, FIBULA, FINGER, FOOT, FOREFETLOCK, 
    FOREFOOT, FORENAVICULAR, FOREPASTERN, FRONTALSINUS, GALLBLADDER, HAND, HEAD, HEADNECK, 
    HEART, HINDFETLOCK, HINDFOOT, HINDNAVICULAR, HINDPASTERN, HIP, HUMERUS, IAC, 
    ILEUM, ILIUM, JAW, JEJUNUM, KIDNEY, KNEE, LARYNX, LEG, 
    LEGS, LIVER, LSPINE, LSSPINE, LUNG, MAXILLA, MEDIASTINUM, METACARPUS, 
    METATARSUS, MOUTH, NECK, NECKCHEST, NECKCHESTABDOMEN, NECKCHESTABDPELV, NOSE, ORBIT, 
    OVARY, PANCREAS, PAROTID, PATELLA, PELVIS, PENIS, PHARYNX, 
    PROSTATE, RADIUS, RADIUSULNA, RECTUM, RIB, SCALP, SCAPULA, SCLERA, 
    SCROTUM, SHOULDER, SKULL, SPINE, SPLEEN, SSPINE, STERNUM, STIFLE, 
    STOMACH, SUBMANDIBULAR, TAIL, TARSUS, TESTIS, THIGH, THUMB, THYMUS, 
    THYROID, TIBIA, TIBIAFIBULA, TLSPINE, TMJ, TOE, TONGUE, TRACHEA, 
    TSPINE, UGITRACT, ULNA, URETER, URETHRA, URINARYTRACT, UTERUS, VAGINA, 
    VULVA, WHOLEBODY, WING, WRIST, ZYGOMA
  };
  
  enum { NumBodyPartExaminedValues = 140 };
  
  static const char * const BodyPartExaminedStringValues[NumBodyPartExaminedValues];
  
  enum { NumUnpairedBodyPartExaminedValues = 74 };
  
  static const char * const UnpairedBodyPartExaminedStringValues[NumUnpairedBodyPartExaminedValues];
 
  protected:
  BoolField   *_writeBodyPartExaminedFld;
  
  StringField *_bodyPartExaminedFld;
  
  StringField *_bodyPartExaminedValuesFld;
  
  const bool _useEnhancedSeriesNumber;
  
  const std::string _modality;
 
  public:
    DicomCopyTagSetInterface _otherGeneralSeriesTags;
};
 
ML_END_NAMESPACE