otbSatelliteRSR.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 otbSatelliteRSR_h
#define otbSatelliteRSR_h
 
#include <vector>
#include <utility>
#include <limits>
 
#include "otbSpectralResponse.h"
 
namespace otb
{
template <class TPrecision = double, class TValuePrecision = double>
class SatelliteRSR : public itk::DataObject
{
public:
  typedef SatelliteRSR                  Self;
  typedef itk::DataObject               Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
  ;
  itkTypeMacro(SatelliteRSR, DataObject);
  ;
 
  itkGetConstMacro(NbBands, unsigned int);
  ;
  itkSetMacro(NbBands, unsigned int);
  ;
 
  itkSetMacro(SortBands, bool);
  ;
 
  typedef TPrecision      PrecisionType;
  typedef TValuePrecision ValuePrecisionType;
 
  typedef SpectralResponse<TPrecision, TValuePrecision> SpectralResponseType;
  typedef typename SpectralResponseType::Pointer        SpectralResponsePointerType;
  typedef std::vector<SpectralResponsePointerType>      RSRVectorType;
  typedef typename SpectralResponseType::VectorPairType VectorPairType;
 
  virtual bool Clear();
 
  virtual int Size() const;
 
  void Load(const std::string& filename, ValuePrecisionType coefNormalization = 1.0);
 
  void Load(PrecisionType lambdaMin, PrecisionType lambdaMax, PrecisionType sampling, ValuePrecisionType coefNormalization = 1.0);
 
  struct sort_band
  {
    bool operator()(SpectralResponsePointerType a, SpectralResponsePointerType b)
    {
      PrecisionType aFirstNotNull;
      PrecisionType bFirstNotNull;
 
      typename VectorPairType::const_iterator it = a->GetResponse().begin();
 
      while ((*it).second == 0)
      {
        ++it;
      }
      aFirstNotNull = (*it).first;
 
      typename VectorPairType::const_iterator it2 = b->GetResponse().begin();
 
      while ((*it2).second == 0)
      {
        ++it2;
      }
      bFirstNotNull = (*it2).first;
 
      return aFirstNotNull < bFirstNotNull;
    }
  };
 
  inline ValuePrecisionType operator()(const PrecisionType& lambda, const unsigned int numBand);
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  RSRVectorType& GetRSR()
  {
    return m_RSR;
  }
 
  SpectralResponseType* GetSolarIrradiance()
  {
    return m_SolarIrradiance;
  }
 
protected:
  SatelliteRSR();
 
  // SatelliteRSR( const std::string & filename );
 
  ~SatelliteRSR() override{};
 
  bool m_SortBands;
 
private:
  SatelliteRSR(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  RSRVectorType m_RSR;
 
  SpectralResponsePointerType m_SolarIrradiance;
 
  unsigned int m_NbBands;
};
 
} // end namespace otb
 
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSatelliteRSR.hxx"
#endif
 
#endif