otbSpectralResponse.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 otbSpectralResponse_h
#define otbSpectralResponse_h
 
#include "itkDataObject.h"
#include <itkObjectFactory.h>
#include <vector>
#include <utility>
#include <limits>
 
#include "otbVectorImage.h"
#include "itkImageRegionIterator.h"
 
#include "otbAtmosphericCorrectionParameters.h"
 
namespace otb
{
template <class TPrecision = double, class TValuePrecision = double>
class SpectralResponse : public itk::DataObject
{
public:
  typedef SpectralResponse              Self;
  typedef itk::DataObject               Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef TPrecision      PrecisionType;
  typedef TValuePrecision ValuePrecisionType;
 
  typedef std::pair<TPrecision, TValuePrecision> PairType;
  // typedef std::shared_ptr<PairType> PairPointerType;
  typedef typename std::vector<PairType> VectorPairType;
 
  typedef otb::VectorImage<TValuePrecision, 2> ImageType;
  typedef typename ImageType::Pointer         ImagePointerType;
  typedef itk::ImageRegionIterator<ImageType> IteratorType;
 
  typedef otb::FilterFunctionValues                   FilterFunctionValuesType;
  typedef itk::SmartPointer<FilterFunctionValuesType> FilterFunctionValuesPointerType;
 
  typedef std::pair<TPrecision, TPrecision> IntervalType;
  itkNewMacro(Self);
  itkTypeMacro(SpectralResponse, DataObject);
 
 
  itkSetMacro(SensitivityThreshold, TPrecision);
  itkGetConstMacro(SensitivityThreshold, TPrecision);
 
  itkSetMacro(UsePosGuess, bool);
  itkGetConstMacro(UsePosGuess, bool);
 
 
  virtual bool Clear();
 
  virtual unsigned int Size() const;
 
  void Load(const std::string& filename, ValuePrecisionType coefNormalization = 1.0);
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  VectorPairType& GetResponse()
  {
    return m_Response;
  }
 
  void SetResponse(const VectorPairType& resp)
  {
    m_Response = resp;
  }
 
  inline ValuePrecisionType operator()(const PrecisionType& lambda);
 
 
  struct sort_pair
  {
    bool operator()(PairType a, PairType b)
    {
      return a.first < b.first;
    }
  };
 
  // void DropNullReflectance() {}
 
  ImagePointerType GetImage(ImagePointerType image) const;
 
  void SetFromImage(ImagePointerType image);
 
  FilterFunctionValuesPointerType GetFilterFunctionValues(double step = 0.0025);
 
  IntervalType GetInterval()
  {
    if (!m_IntervalComputed)
      this->ComputeInterval();
    return m_Interval;
  }
 
  void SetPosGuessMin(const PrecisionType& lambda);
 
 
protected:
  SpectralResponse();
 
  // SpectralResponse( const std::string & filename );
 
  ~SpectralResponse() override{};
 
  // void PrintSelf(std::ostream& os, itk::Indent indent) const;
 
  VectorPairType m_Response;
 
  TPrecision    m_SensitivityThreshold;
  IntervalType  m_Interval;
  unsigned long m_PosGuess;
  bool          m_IntervalComputed;
  bool          m_UsePosGuess;
  void          ComputeInterval();
 
private:
  SpectralResponse(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSpectralResponse.hxx"
#endif
 
#endif