otbMatrixImageFilter.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 otbMatrixImageFilter_h
#define otbMatrixImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "otbMath.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage, class TMatrix = vnl_matrix<typename itk::NumericTraits<typename TInputImage::InternalPixelType>::RealType>>
class ITK_EXPORT MatrixImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, TOutputImage::ImageDimension);
 
  typedef TInputImage InputImageType;
 
  typedef TOutputImage OutputImageType;
 
  typedef MatrixImageFilter Self;
  typedef itk::ImageToImageFilter<InputImageType, OutputImageType> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(MatrixImageFilter, ImageToImageFilter);
 
  typedef typename InputImageType::PixelType          InputPixelType;
  typedef typename OutputImageType::PixelType         OutputPixelType;
  typedef typename InputImageType::InternalPixelType  InputInternalPixelType;
  typedef typename OutputImageType::InternalPixelType OutputInternalPixelType;
 
  // To support complexe...
  typedef typename itk::NumericTraits<InputInternalPixelType>::RealType InputRealType;
  typedef TMatrix                                                       MatrixType;
  typedef vnl_vector<InputRealType>                                     VectorType;
 
  typedef typename OutputImageType::RegionType OutputImageRegionType;
 
  typedef typename InputImageType::SizeType SizeType;
 
 
  void SetMatrix(MatrixType mat)
  {
    m_Matrix = mat;
    this->Modified();
  }
  MatrixType GetMatrix()
  {
    return m_Matrix;
  }
 
  itkGetConstMacro(MatrixByVector, bool);
  itkSetMacro(MatrixByVector, bool);
  itkBooleanMacro(MatrixByVector);
 
protected:
  MatrixImageFilter();
  ~MatrixImageFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateOutputInformation() override;
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
private:
  MatrixImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  MatrixType m_Matrix;
 
  bool m_MatrixByVector;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMatrixImageFilter.hxx"
#endif
 
#endif