otbReduceSpectralResponse.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 otbReduceSpectralResponse_h
#define otbReduceSpectralResponse_h
 
 
#include "itkDataObject.h"
#include <itkObjectFactory.h>
#include <vector>
#include <utility>
#include <limits>
 
namespace otb
{
template <class TSpectralResponse, class TRSR>
class ReduceSpectralResponse : public itk::DataObject
{
 
public:
  typedef ReduceSpectralResponse        Self;
  typedef itk::DataObject               Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef TSpectralResponse InputSpectralResponseType;
  typedef TRSR              InputRSRType;
 
  typedef typename InputSpectralResponseType::PairType PairType;
  typedef typename InputRSRType::Pointer               InputRSRPointerType;
  typedef typename InputSpectralResponseType::Pointer  InputSpectralResponsePointerType;
 
  typedef typename InputRSRType::PrecisionType      PrecisionType;
  typedef typename InputRSRType::ValuePrecisionType ValuePrecisionType;
 
  typedef typename InputSpectralResponseType::VectorPairType VectorPairType;
 
  // TODO need a specific class for the integration of stectral responses (now it is in the functor)
  typedef typename InputRSRType::RSRVectorType     RSRVectorType;
  typedef typename std::vector<ValuePrecisionType> ReduceSpectralResponseVectorType;
  itkNewMacro(Self);
  ;
  itkTypeMacro(ReduceSpectralResponse, DataObject);
  ;
 
  itkGetConstObjectMacro(InputSatRSR, InputRSRType);
  ;
  itkSetObjectMacro(InputSatRSR, InputRSRType);
  ;
 
  itkGetConstObjectMacro(InputSpectralResponse, InputSpectralResponseType);
  ;
  itkSetObjectMacro(InputSpectralResponse, InputSpectralResponseType);
  ;
 
  itkGetObjectMacro(ReduceResponse, InputSpectralResponseType);
  ;
 
  itkSetMacro(ReflectanceMode, bool);
  itkGetConstMacro(ReflectanceMode, bool);
 
  virtual bool Clear();
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  inline ValuePrecisionType operator()(const unsigned int numBand);
 
  void CalculateResponse();
 
  void LoadInputsFromFiles(const std::string& spectralResponseFile, const std::string& RSRFile, const unsigned int nbRSRBands,
                           ValuePrecisionType coefNormSpectre = 1.0, ValuePrecisionType coefNormRSR = 1.0);
 
protected:
  ReduceSpectralResponse();
 
  // ReduceSpectralResponse( const std::string & filename );
 
  ~ReduceSpectralResponse() override{};
 
  // void PrintSelf(std::ostream& os, itk::Indent indent) const;
 
  InputRSRPointerType m_InputSatRSR;
 
  InputSpectralResponsePointerType m_InputSpectralResponse;
 
private:
  ReduceSpectralResponse(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  InputSpectralResponsePointerType m_ReduceResponse;
 
  bool m_ReflectanceMode;
};
 
} // end namespace otb
 
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbReduceSpectralResponse.hxx"
#endif
 
#endif