otbBandMathImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * 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 otbBandMathImageFilter_h
#define otbBandMathImageFilter_h
 
#include "itkInPlaceImageFilter.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkArray.h"
 
#include "otbParser.h"
#include <string>
 
namespace otb
{
template <class TImage>
class ITK_EXPORT BandMathImageFilter : public itk::InPlaceImageFilter<TImage>
{
public:
  typedef BandMathImageFilter<TImage>     Self;
  typedef itk::InPlaceImageFilter<TImage> Superclass;
  typedef itk::SmartPointer<Self>         Pointer;
  typedef itk::SmartPointer<const Self>   ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(BandMathImageFilter, InPlaceImageFilter);
 
  typedef TImage                                             ImageType;
  typedef typename ImageType::ConstPointer                   ImagePointer;
  typedef typename ImageType::RegionType                     ImageRegionType;
  typedef typename ImageType::PixelType                      PixelType;
  typedef typename ImageType::IndexType                      IndexType;
  typedef typename ImageType::PointType                      OrigineType;
  typedef typename ImageType::SpacingType                    SpacingType;
  typedef Parser                                             ParserType;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  using Superclass::SetNthInput;
  void SetNthInput(DataObjectPointerArraySizeType idx, const ImageType* image);
  void SetNthInput(DataObjectPointerArraySizeType idx, const ImageType* image, const std::string& varName);
 
  void SetNthInputName(DataObjectPointerArraySizeType idx, const std::string& expression);
 
  void SetExpression(const std::string& expression);
 
  std::string GetExpression() const;
 
  std::string GetNthInputName(DataObjectPointerArraySizeType idx) const;
 
  ImageType* GetNthInput(DataObjectPointerArraySizeType idx);
 
protected:
  BandMathImageFilter();
  ~BandMathImageFilter() override;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void BeforeThreadedGenerateData() override;
  void ThreadedGenerateData(const ImageRegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
  void AfterThreadedGenerateData() override;
 
private:
  BandMathImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  std::string                      m_Expression;
  std::vector<ParserType::Pointer> m_VParser;
  std::vector<std::vector<double>> m_AImage;
  std::vector<std::string>         m_VVarName;
  unsigned int                     m_NbVar;
 
  SpacingType m_Spacing;
  OrigineType m_Origin;
 
  long             m_UnderflowCount;
  long             m_OverflowCount;
  itk::Array<long> m_ThreadUnderflow;
  itk::Array<long> m_ThreadOverflow;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBandMathImageFilter.hxx"
#endif
 
#endif