otbAtmosphericCorrectionParameters.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 otbAtmosphericCorrectionParameters_h
#define otbAtmosphericCorrectionParameters_h
 
#include "OTBOpticalCalibrationExport.h"
#include "itkObject.h"
#include "itkVariableSizeMatrix.h"
#include "itkVariableLengthVector.h"
#include "otbObjectList.h"
#include "otbFilterFunctionValues.h"
#include <vector>
#include <string>
 
namespace otb
{
class OTBOpticalCalibration_EXPORT AtmosphericCorrectionParameters : public itk::DataObject
{
public:
  typedef AtmosphericCorrectionParameters Self;
  typedef itk::Object                     Superclass;
  typedef itk::SmartPointer<Self>         Pointer;
  typedef itk::SmartPointer<const Self>   ConstPointer;
 
  itkTypeMacro(AtmosphericCorrectionParameters, Object);
 
  itkNewMacro(Self);
 
  typedef enum { NO_AEROSOL = 0, CONTINENTAL = 1, MARITIME = 2, URBAN = 3, DESERTIC = 4 } AerosolModelType;
 
  typedef ObjectList<FilterFunctionValues>                  InternalWavelengthSpectralBandVectorType;
  typedef InternalWavelengthSpectralBandVectorType::Pointer WavelengthSpectralBandVectorType;
 
  itkSetMacro(AtmosphericPressure, double);
  itkGetMacro(AtmosphericPressure, double);
 
  itkSetMacro(WaterVaporAmount, double);
  itkGetMacro(WaterVaporAmount, double);
 
  itkSetMacro(OzoneAmount, double);
  itkGetMacro(OzoneAmount, double);
 
  itkSetEnumMacro(AerosolModel, AerosolModelType);
  itkGetEnumMacro(AerosolModel, AerosolModelType);
 
  itkSetMacro(AerosolOptical, double);
  itkGetMacro(AerosolOptical, double);
 
 
  itkSetMacro(AeronetFileName, std::string);
  itkGetMacro(AeronetFileName, std::string);
 
 
  void ReadAeronetData(const std::string& file, int year, int month, int day, int hour, int minute, double epsi);
 
 
  void UpdateAeronetData(const std::string& file, int year, int month, int day, int hour, int minute, double epsi);
  void UpdateAeronetData(const std::string& file, int year, int month, int day, int hour, int minute)
  {
    this->UpdateAeronetData(file, year, month, day, hour, minute, 0.4);
  }
  void UpdateAeronetData(int year, int month, int day, int hour, int minute, double epsi)
  {
    this->UpdateAeronetData(m_AeronetFileName, year, month, day, hour, minute, epsi);
  }
  void UpdateAeronetData(int year, int month, int day, int hour, int minute)
  {
    this->UpdateAeronetData(m_AeronetFileName, year, month, day, hour, minute, 0.4);
  }
  void UpdateAeronetData(const std::string& file, int year, int hour, int minute)
  {
    this->UpdateAeronetData(file, year, m_Month, m_Day, hour, minute, 0.4);
  }
  void UpdateAeronetData(int year, int hour, int minute)
  {
    this->UpdateAeronetData(m_AeronetFileName, year, m_Month, m_Day, hour, minute, 0.4);
  }
 
  /*void UpdateAeronetData(const std::string& file, int year, int hour, int minute, double epsi) CHRIS
  {
    this->UpdateAeronetData(file, year, m_Month, m_Day, hour, minute, epsi);
  }
  void UpdateAeronetData(const std::string& file, int year, int hour, int minute)
  {
    this->UpdateAeronetData(file, year, m_Month, m_Day, hour, minute, 0.4);
  }*/
 
  AtmosphericCorrectionParameters();
 
  ~AtmosphericCorrectionParameters() override
  {
  }
 
protected:
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  AtmosphericCorrectionParameters(const Self&) = delete;
  void operator=(const Self&) = delete;
  std::string m_AeronetFileName;
 
  int m_Day;
 
  int m_Month;
 
  double m_AtmosphericPressure;
 
  double m_WaterVaporAmount;
 
  double m_OzoneAmount;
 
  AerosolModelType m_AerosolModel;
 
  double m_AerosolOptical;
};
 
} // end namespace otb
 
#endif