mitkSUVImageFilter.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkSUVImageFilter_h
#define mitkSUVImageFilter_h
 
#include <MitkPETExports.h>
#include <mitkImageToImageFilter.h>
#include <mitkSUVCalculationHelper.h>
#include <mitkSUVInputModel.h>
#include <mitkSUVNormalizationStrategy.h>
#include <optional>
 
namespace mitk
{
  class IPropertyProvider;
 
  class MITKPET_EXPORT SUVImageFilter : public ImageToImageFilter
  {
  public:
    mitkClassMacro(SUVImageFilter, ImageToImageFilter);
    itkFactorylessNewMacro(Self);
 
    itkSetEnumMacro(TargetVariant, SUVVariant);
    itkGetConstMacro(TargetVariant, SUVVariant);
 
    itkSetEnumMacro(DICOMReadPolicy, DICOMReadPolicy);
    itkGetConstMacro(DICOMReadPolicy, DICOMReadPolicy);
 
    // ---- Override fields ---------------------------------------------------
    //
    // Most Set / Get use itk macros. The decay-time and input-model
    // overrides (SetDecayTimeOverrideInSec, SetDecayTimeOverrideMap,
    // GetDecayTimeOverrideMap, SetInputModelOverride, GetInputModelOverride)
    // are hand-written to enforce mutual-exclusion / value validation. All
    // Clear and GetEffective accessors are hand-written.
 
    itkSetMacro(PatientWeightInGram, double);
    itkGetConstMacro(PatientWeightInGram, std::optional<double>);
    void ClearPatientWeightInGram();
    double GetEffectivePatientWeightInGram() const;
 
    itkSetMacro(PatientHeightInCm, double);
    itkGetConstMacro(PatientHeightInCm, std::optional<double>);
    void ClearPatientHeightInCm();
    double GetEffectivePatientHeightInCm() const;
 
    itkSetEnumMacro(PatientSex, Sex);
    itkGetConstMacro(PatientSex, std::optional<Sex>);
    void ClearPatientSex();
    Sex GetEffectivePatientSex() const;
 
    itkSetMacro(InjectedActivityInBq, double);
    itkGetConstMacro(InjectedActivityInBq, std::optional<double>);
    void ClearInjectedActivityInBq();
    double GetEffectiveInjectedActivityInBq() const;
 
    itkSetMacro(HalfLifeInSec, double);
    itkGetConstMacro(HalfLifeInSec, std::optional<double>);
    void ClearHalfLifeInSec();
    double GetEffectiveHalfLifeInSec() const;
 
    void SetDecayTimeOverrideInSec(double value);
    itkGetConstMacro(DecayTimeOverrideInSec, std::optional<double>);
    void ClearDecayTimeOverrideInSec();
 
    void SetDecayTimeOverrideMap(DecayTimeMapType map);
    void ClearDecayTimeOverrideMap();
    const std::optional<DecayTimeMapType>& GetDecayTimeOverrideMap() const;
 
    const DecayCorrectionInfo& GetEffectiveDecayCorrection() const;
 
    itkSetMacro(TracerIndex, int);
    itkGetConstMacro(TracerIndex, std::optional<int>);
    void ClearTracerIndex();
 
    void SetInputModelOverride(SUVInputModel v);
    void ClearInputModelOverride();
    std::optional<SUVInputModel> GetInputModelOverride() const;
    SUVInputModel GetEffectiveInputModel() const;
 
    std::optional<SUVInputModel> GetDetectedInputModel() const noexcept;
 
    void ConfigureFromProperties(const IPropertyProvider *props);
 
  protected:
    SUVImageFilter();
    ~SUVImageFilter() override;
 
    void GenerateData() override;
    void GenerateOutputInformation() override;
 
  private:
    static void RequireConfigured(bool configured, const char *fieldName);
 
    void ProcessTimeStep(const Image *stepIn,
                         Image *dst,
                         TimeStepType dstStep,
                         double injectedActivity,
                         double scaleNumerator,
                         double halfLife,
                         const DecayTimeSliceMapType &sliceMap) const;
 
    SUVVariant m_TargetVariant{SUVVariant::BW};
    DICOMReadPolicy m_DICOMReadPolicy{DICOMReadPolicy::Lenient};
 
    // Override slots: empty == "not set by user, derive from properties".
    std::optional<double> m_PatientWeightInGram;
    std::optional<double> m_PatientHeightInCm;
    std::optional<Sex> m_PatientSex;
    std::optional<double> m_InjectedActivityInBq;
    std::optional<double> m_HalfLifeInSec;
    std::optional<double> m_DecayTimeOverrideInSec;
    std::optional<DecayTimeMapType> m_DecayTimeOverrideMap;
    std::optional<int> m_TracerIndex;
    std::optional<SUVInputModel> m_InputModelOverride;
 
    // Effective values resolved by ConfigureFromProperties().
    std::optional<double> m_EffectivePatientWeightInGram;
    std::optional<double> m_EffectivePatientHeightInCm;
    std::optional<Sex> m_EffectivePatientSex;
    std::optional<double> m_EffectiveInjectedActivityInBq;
    std::optional<double> m_EffectiveHalfLifeInSec;
    std::optional<DecayCorrectionInfo> m_EffectiveDecayCorrection;
    std::optional<SUVInputModel> m_EffectiveInputModel;
 
    // Detected input model: sticky across rollbacks (does not need to
    // round-trip the failure case because classification is a pure
    // function of (props, override, policy)). Drives UI affordances
    // that must remain available even after a configuration failure
    // further downstream (e.g. showing the sex / height combos when
    // the source variant of a pre-normalized input requires them).
    std::optional<SUVInputModel> m_DetectedInputModel;
 
    bool m_Configured{false};
 
    // Modification time captured at the end of the last successful
    // ConfigureFromProperties. GenerateData reconfigures when a later
    // setter bumps GetMTime() past this value, so override changes made
    // after configuration are not silently ignored at Update().
    itk::ModifiedTimeType m_ConfigureMTime{0};
  };
} // namespace mitk
 
#endif