otbInnerProductPCAImageFilter.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 otbInnerProductPCAImageFilter_h
#define otbInnerProductPCAImageFilter_h
 
#include "otbImage.h"
#include "otbMacro.h"
#include "otbEstimateInnerProductPCAImageFilter.h"
#include "otbNormalizeInnerProductPCAImageFilter.h"
#include "otbMeanFunctor.h"
#include "otbImageToVectorImageCastFilter.h"
#include "otbConcatenateVectorImageFilter.h"
#include "otbImageToVectorImageCastFilter.h"
 
namespace otb
{
template <class TInputImage, class TOutputImage>
class ITK_EXPORT InnerProductPCAImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef InnerProductPCAImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(InnerProductPCAImageFilter, ImageToImageFilter);
 
  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;
 
  typedef EstimateInnerProductPCAImageFilter<InputImageType, OutputImageType> EstimatePCAFilterType;
  typedef typename EstimatePCAFilterType::Pointer EstimatePCAFilterPointer;
  typedef NormalizeInnerProductPCAImageFilter<OutputImageType, OutputImageType> NormalizePCAFilterType;
  typedef typename NormalizePCAFilterType::Pointer NormalizePCAFilterPointer;
 
  typedef Image<typename InputImageType::InternalPixelType> InternalImageType;
  typedef Functor::MeanFunctor<typename InputImageType::PixelType, typename InternalImageType::PixelType> MeanFunctorType;
  typedef itk::UnaryFunctorImageFilter<InputImageType, InternalImageType, MeanFunctorType> MeanFilterType;
  typedef typename MeanFilterType::Pointer MeanFilterPointer;
  typedef ImageToVectorImageCastFilter<InternalImageType, OutputImageType> CastFilterType;
  typedef typename CastFilterType::Pointer CastFilterPointer;
  typedef ConcatenateVectorImageFilter<OutputImageType, OutputImageType, OutputImageType> ConcatenateFilterType;
  typedef typename ConcatenateFilterType::Pointer ConcatenateFilterPointer;
 
  itkSetMacro(NumberOfPrincipalComponentsRequired, unsigned int);
  itkGetMacro(NumberOfPrincipalComponentsRequired, unsigned int);
 
  itkSetMacro(GenerateMeanComponent, bool);
  itkGetMacro(GenerateMeanComponent, bool);
  itkBooleanMacro(GenerateMeanComponent);
 
  itkSetMacro(CenterData, bool);
  itkGetMacro(CenterData, bool);
  itkBooleanMacro(CenterData);
 
  otbSetObjectMemberMacro(NormalizePCAFilter, UseUnbiasedEstimator, bool);
  otbGetObjectMemberMacro(NormalizePCAFilter, UseUnbiasedEstimator, bool);
 
protected:
  void GenerateData(void) override;
 
  InnerProductPCAImageFilter();
 
  ~InnerProductPCAImageFilter() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateOutputInformation() override;
 
private:
  InnerProductPCAImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  unsigned int m_NumberOfPrincipalComponentsRequired;
 
  EstimatePCAFilterPointer m_EstimatePCAFilter;
 
  NormalizePCAFilterPointer m_NormalizePCAFilter;
 
  bool m_CenterData;
 
  bool m_GenerateMeanComponent;
 
  MeanFilterPointer        m_MeanFilter;
  CastFilterPointer        m_CastFilter;
  ConcatenateFilterPointer m_ConcatenateFilter;
};
 
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbInnerProductPCAImageFilter.hxx"
#endif
 
#endif