otbAtmosphericRadiativeTerms.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbAtmosphericRadiativeTerms_h
#define otbAtmosphericRadiativeTerms_h
 
#include "OTBOpticalCalibrationExport.h"
#include "itkDataObject.h"
#include "itkObjectFactory.h"
#include "itkMacro.h"
#include <vector>
 
namespace otb
{
 
class OTBOpticalCalibration_EXPORT AtmosphericRadiativeTermsSingleChannel : public itk::DataObject
{
public:
  typedef AtmosphericRadiativeTermsSingleChannel Self;
  typedef itk::DataObject                        Superclass;
  typedef itk::SmartPointer<Self>                Pointer;
  typedef itk::SmartPointer<const Self>          ConstPointer;
 
  itkTypeMacro(AtmosphericRadiativeTermsSingleChannel, DataObject);
 
  itkNewMacro(Self);
 
  itkSetMacro(IntrinsicAtmosphericReflectance, double);
  itkGetMacro(IntrinsicAtmosphericReflectance, double);
 
  itkSetMacro(SphericalAlbedo, double);
  itkGetMacro(SphericalAlbedo, double);
 
  itkSetMacro(TotalGaseousTransmission, double);
  itkGetMacro(TotalGaseousTransmission, double);
 
  itkSetMacro(DownwardTransmittance, double);
  itkGetMacro(DownwardTransmittance, double);
 
  itkSetMacro(UpwardTransmittance, double);
  itkGetMacro(UpwardTransmittance, double);
 
  itkSetMacro(UpwardDiffuseTransmittance, double);
  itkGetMacro(UpwardDiffuseTransmittance, double);
 
  itkSetMacro(UpwardDirectTransmittance, double);
  itkGetMacro(UpwardDirectTransmittance, double);
 
  itkSetMacro(UpwardDiffuseTransmittanceForRayleigh, double);
  itkGetMacro(UpwardDiffuseTransmittanceForRayleigh, double);
 
  itkSetMacro(UpwardDiffuseTransmittanceForAerosol, double);
  itkGetMacro(UpwardDiffuseTransmittanceForAerosol, double);
 
  itkSetMacro(WavelengthSpectralBand, double);
  itkGetMacro(WavelengthSpectralBand, double);
 
protected:
  AtmosphericRadiativeTermsSingleChannel();
 
  ~AtmosphericRadiativeTermsSingleChannel() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  AtmosphericRadiativeTermsSingleChannel(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  double m_IntrinsicAtmosphericReflectance;
 
  double m_SphericalAlbedo;
 
  double m_TotalGaseousTransmission;
 
  double m_DownwardTransmittance;
 
  double m_UpwardTransmittance;
 
  double m_UpwardDiffuseTransmittance;
 
  double m_UpwardDirectTransmittance;
 
  double m_UpwardDiffuseTransmittanceForRayleigh;
 
  double m_UpwardDiffuseTransmittanceForAerosol;
 
  double m_WavelengthSpectralBand;
};
 
class OTBOpticalCalibration_EXPORT AtmosphericRadiativeTerms : public itk::DataObject
{
public:
  typedef AtmosphericRadiativeTerms     Self;
  typedef itk::DataObject               Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(AtmosphericRadiativeTerms, DataObject);
 
  itkNewMacro(Self);
 
  typedef AtmosphericRadiativeTermsSingleChannel::Pointer ValueType;
  typedef std::vector<ValueType>                          VectorValueType;
  typedef std::vector<double>                             DataVectorType;
  typedef DataVectorType::size_type                       DataVectorSizeType;
  void SetValues(const VectorValueType& val)
  {
    m_Values = val;
    this->Modified();
  }
  VectorValueType& GetValues()
  {
    return m_Values;
  }
  const VectorValueType& GetValues() const
  {
    return m_Values;
  }
 
  void SetIntrinsicAtmosphericReflectances(const DataVectorType& vect);
  void SetSphericalAlbedos(const DataVectorType& vect);
  void SetTotalGaseousTransmissions(const DataVectorType& vect);
  void SetDownwardTransmittances(const DataVectorType& vect);
  void SetUpwardTransmittances(const DataVectorType& vect);
 
  void SetUpwardDiffuseTransmittances(const DataVectorType& vect);
  void SetUpwardDirectTransmittances(const DataVectorType& vect);
  void SetUpwardDiffuseTransmittancesForRayleigh(const DataVectorType& vect);
  void SetUpwardDiffuseTransmittancesForAerosol(const DataVectorType& vect);
  void SetWavelengthSpectralBand(const DataVectorType& vect);
 
  void SetValueByIndex(unsigned int id, const ValueType& val);
  void SetIntrinsicAtmosphericReflectance(unsigned int id, const double& val);
  void SetSphericalAlbedo(unsigned int id, const double& val);
  void SetTotalGaseousTransmission(unsigned int id, const double& val);
  void SetDownwardTransmittance(unsigned int id, const double& val);
  void SetUpwardTransmittance(unsigned int id, const double& val);
 
  void SetUpwardDiffuseTransmittance(unsigned int id, const double& val);
  void SetUpwardDirectTransmittance(unsigned int id, const double& val);
  void SetUpwardDiffuseTransmittanceForRayleigh(unsigned int id, const double& val);
  void SetUpwardDiffuseTransmittanceForAerosol(unsigned int id, const double& val);
  void SetWavelengthSpectralBand(unsigned int id, const double& val);
 
  DataVectorType GetIntrinsicAtmosphericReflectances() const;
  DataVectorType GetSphericalAlbedos() const;
  DataVectorType GetTotalGaseousTransmissions() const;
  DataVectorType GetDownwardTransmittances() const;
  DataVectorType GetUpwardTransmittances() const;
 
  DataVectorType GetUpwardDiffuseTransmittances() const;
  DataVectorType GetUpwardDirectTransmittances() const;
  DataVectorType GetUpwardDiffuseTransmittancesForRayleigh() const;
  DataVectorType GetUpwardDiffuseTransmittancesForAerosol() const;
  DataVectorType GetWavelengthSpectralBand() const;
 
  double GetIntrinsicAtmosphericReflectance(unsigned int id) const;
  double GetSphericalAlbedo(unsigned int id) const;
  double GetTotalGaseousTransmission(unsigned int id) const;
  double GetDownwardTransmittance(unsigned int id) const;
  double GetUpwardTransmittance(unsigned int id) const;
  double GetUpwardDiffuseTransmittance(unsigned int id) const;
  double GetUpwardDirectTransmittance(unsigned int id) const;
  double GetUpwardDiffuseTransmittanceForRayleigh(unsigned int id) const;
  double GetUpwardDiffuseTransmittanceForAerosol(unsigned int id) const;
  double GetWavelengthSpectralBand(unsigned int id) const;
 
  const ValueType GetValueByIndex(unsigned int id) const;
 
  void ValuesInitialization(DataVectorSizeType nbChannel);
 
protected:
  AtmosphericRadiativeTerms();
 
  ~AtmosphericRadiativeTerms() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  AtmosphericRadiativeTerms(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  VectorValueType m_Values;
 
  bool m_IsInitialized;
};
 
} // end namespace otb
 
#endif