otbBandMathXImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * Copyright (C) 2005-2020 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 otbBandMathXImageFilter_h
#define otbBandMathXImageFilter_h

#include "itkConstNeighborhoodIterator.h"
#include "itkImageToImageFilter.h"
#include "itkArray.h"

#include "otbStreamingStatisticsVectorImageFilter.h"
#include "otbParserX.h"

#include <vector>
#include <string>


namespace otb
{
template <class TImage>
class ITK_EXPORT BandMathXImageFilter : public itk::ImageToImageFilter<TImage, TImage>
{
public:
  typedef BandMathXImageFilter<TImage> Self;
  typedef itk::ImageToImageFilter<TImage, TImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(BandMathXImageFilter, ImageToImageFilter);

  typedef TImage                                                      ImageType;
  typedef typename ImageType::ConstPointer                            ConstImagePointer;
  typedef typename ImageType::Pointer                                 ImagePointer;
  typedef typename ImageType::RegionType                              ImageRegionType;
  typedef typename itk::ConstNeighborhoodIterator<TImage>::RadiusType RadiusType;
  typedef typename ImageType::PixelType::ValueType                    PixelValueType;
  typedef typename ImageType::PixelType                               PixelType;
  typedef typename ImageType::IndexType                               IndexType;
  typedef typename ImageType::PointType                               OrigineType;
  typedef typename ImageType::SpacingType                             SpacingType;
  typedef ParserX                                                     ParserType;
  typedef typename ParserType::ValueType                              ValueType;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType          DataObjectPointerArraySizeType;

  typedef StreamingStatisticsVectorImageFilter<ImageType>               StreamingStatisticsVectorImageFilterType;
  typedef typename StreamingStatisticsVectorImageFilterType::Pointer    StreamingStatisticsVectorImageFilterPointerType;
  typedef typename StreamingStatisticsVectorImageFilterType::MatrixType MatrixType;

  using Superclass::SetNthInput;
  void SetNthInput(DataObjectPointerArraySizeType idx, const ImageType* image);
  void SetNthInput(DataObjectPointerArraySizeType idx, const ImageType* image, const std::string& varName);

  ImageType* GetNthInput(DataObjectPointerArraySizeType idx);

  void SetManyExpressions(bool flag);

  void SetExpression(const std::string& expression);

  std::string GetExpression(unsigned int IDExpression) const;

  void SetMatrix(const std::string& name, const std::string& definition);

  void SetConstant(const std::string& name, double value);

  void ExportContext(const std::string& filename);

  void ImportContext(const std::string& filename);

  void ClearExpression();

  std::vector<std::string> GetVarNames() const;

  bool GlobalStatsDetected() const
  {
    return !m_StatsVarDetected.empty();
  }

protected:
  BandMathXImageFilter();
  ~BandMathXImageFilter() override;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;

  void GenerateOutputInformation() override;
  void GenerateInputRequestedRegion() override;

  void BeforeThreadedGenerateData() override;
  void ThreadedGenerateData(const ImageRegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
  void AfterThreadedGenerateData() override;

private:
  typedef struct
  {
    std::string name;
    ValueType   value;
    int         type;
    int         info[5];
  } adhocStruct;


  BandMathXImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;

  void AddVariable(adhocStruct&);
  void CheckImageDimensions();
  void PrepareParsers();
  void PrepareParsersGlobStats();
  void OutputsDimensions();

  std::vector<std::string>                      m_Expression;
  std::vector<std::vector<ParserType::Pointer>> m_VParser;
  std::vector<std::vector<adhocStruct>>         m_AImage;
  std::vector<adhocStruct>                      m_VVarName;
  std::vector<adhocStruct>                      m_VAllowedVarNameAuto;
  std::vector<adhocStruct>                      m_VAllowedVarNameAddedByUser;
  std::vector<adhocStruct>                      m_VFinalAllowedVarName; // m_VFinalAllowedVarName = m_VAllowedVarNameAuto + m_VAllowedVarNameAddedByUser
  std::vector<adhocStruct>                      m_VNotAllowedVarName;
  std::vector<unsigned int>                     m_outputsDimensions;

  unsigned int m_SizeNeighbourhood;

  std::vector<int> m_StatsVarDetected; // input image ID for which global statistics have been detected

  std::vector<unsigned int> m_NeighDetected; // input image ID for which neighbourhood have been detected
  std::vector<RadiusType>   m_NeighExtremaSizes;

  long             m_UnderflowCount;
  long             m_OverflowCount;
  itk::Array<long> m_ThreadUnderflow;
  itk::Array<long> m_ThreadOverflow;

  bool m_ManyExpressions;
};

} // end namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBandMathXImageFilter.hxx"
#endif

#endif