OTB  9.0.0
Orfeo Toolbox
otbEstimateInnerProductPCAImageFilter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 #ifndef otbEstimateInnerProductPCAImageFilter_h
22 #define otbEstimateInnerProductPCAImageFilter_h
23 
24 #include "itkImageToImageFilter.h"
26 
27 namespace otb
28 {
36 template <class TInputImage, class TOutputImage>
37 class ITK_EXPORT EstimateInnerProductPCAImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
38 {
39 public:
42  typedef typename itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
43  typedef itk::SmartPointer<Self> Pointer;
44  typedef itk::SmartPointer<const Self> ConstPointer;
45 
47  itkNewMacro(Self);
48 
50  itkTypeMacro(EstimateInnerProductPCAImageFilter, ImageToImageFilter);
51 
53  typedef TInputImage InputImageType;
54  typedef typename InputImageType::Pointer InputImagePointer;
55  typedef typename InputImageType::PixelType InputPixelType;
56  typedef typename InputImageType::RegionType InputImageRegionType;
57  typedef TOutputImage OutputImageType;
58  typedef typename OutputImageType::Pointer OutputImagePointer;
59  typedef typename OutputImageType::RegionType OutputImageRegionType;
60  typedef typename OutputImageType::PixelType OutputPixelType;
61  typedef typename OutputImageType::InternalPixelType OutputInternalPixelType;
62 
67 
71  itkSetMacro(NumberOfPrincipalComponentsRequired, unsigned int);
72  itkGetMacro(NumberOfPrincipalComponentsRequired, unsigned int);
74 
76  itkSetMacro(CenterData, bool);
77  itkGetMacro(CenterData, bool);
78  itkBooleanMacro(CenterData);
80 
81 protected:
84  {
85  }
86 
91  void GenerateOutputInformation(void) override;
92 
96  void BeforeThreadedGenerateData() override;
97 
98  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
99  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
100 
101 private:
102  EstimateInnerProductPCAImageFilter(const Self&) = delete;
103  void operator=(const Self&) = delete;
104 
107 
110 
113 
116 };
117 
118 } // end namespace otb
119 
120 #ifndef OTB_MANUAL_INSTANTIATION
122 #endif
123 
124 #endif
otb::EstimateInnerProductPCAImageFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbEstimateInnerProductPCAImageFilter.h:43
otb::EstimateInnerProductPCAImageFilter::MatrixType
StreamingInnerProductType::MatrixType MatrixType
Definition: otbEstimateInnerProductPCAImageFilter.h:65
otb::EstimateInnerProductPCAImageFilter::StreamingInnerProductPointer
StreamingInnerProductType::Pointer StreamingInnerProductPointer
Definition: otbEstimateInnerProductPCAImageFilter.h:64
otb::EstimateInnerProductPCAImageFilter::InputImageRegionType
InputImageType::RegionType InputImageRegionType
Definition: otbEstimateInnerProductPCAImageFilter.h:56
otb::StreamingInnerProductVectorImageFilter::MatrixType
StatFilterType::MatrixType MatrixType
Definition: otbStreamingInnerProductVectorImageFilter.h:182
otbEstimateInnerProductPCAImageFilter.hxx
otb::EstimateInnerProductPCAImageFilter::OutputImagePointer
OutputImageType::Pointer OutputImagePointer
Definition: otbEstimateInnerProductPCAImageFilter.h:58
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::EstimateInnerProductPCAImageFilter::~EstimateInnerProductPCAImageFilter
~EstimateInnerProductPCAImageFilter() override
Definition: otbEstimateInnerProductPCAImageFilter.h:83
otb::EstimateInnerProductPCAImageFilter::OutputImageRegionType
OutputImageType::RegionType OutputImageRegionType
Definition: otbEstimateInnerProductPCAImageFilter.h:59
otb::EstimateInnerProductPCAImageFilter::Superclass
itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
Definition: otbEstimateInnerProductPCAImageFilter.h:42
otb::EstimateInnerProductPCAImageFilter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbEstimateInnerProductPCAImageFilter.h:44
otb::EstimateInnerProductPCAImageFilter::StreamingInnerProductType
StreamingInnerProductVectorImageFilter< InputImageType > StreamingInnerProductType
Definition: otbEstimateInnerProductPCAImageFilter.h:63
otb::EstimateInnerProductPCAImageFilter::OutputImageType
TOutputImage OutputImageType
Definition: otbEstimateInnerProductPCAImageFilter.h:57
otb::EstimateInnerProductPCAImageFilter::m_InnerProduct
MatrixType m_InnerProduct
Definition: otbEstimateInnerProductPCAImageFilter.h:112
otb::StreamingInnerProductVectorImageFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbStreamingInnerProductVectorImageFilter.h:171
otb::EstimateInnerProductPCAImageFilter::InputImageType
TInputImage InputImageType
Definition: otbEstimateInnerProductPCAImageFilter.h:50
otbStreamingInnerProductVectorImageFilter.h
otb::EstimateInnerProductPCAImageFilter::InputImagePointer
InputImageType::Pointer InputImagePointer
Definition: otbEstimateInnerProductPCAImageFilter.h:54
otb::EstimateInnerProductPCAImageFilter::MatrixObjectType
StreamingInnerProductType::MatrixObjectType MatrixObjectType
Definition: otbEstimateInnerProductPCAImageFilter.h:66
otb::EstimateInnerProductPCAImageFilter
Applies the Inner product to an vector image. Implement the itk::ImagePCAShapeModelEstimator algorith...
Definition: otbEstimateInnerProductPCAImageFilter.h:37
otb::EstimateInnerProductPCAImageFilter::m_CenterData
bool m_CenterData
Definition: otbEstimateInnerProductPCAImageFilter.h:109
otb::EstimateInnerProductPCAImageFilter::m_NumberOfPrincipalComponentsRequired
unsigned int m_NumberOfPrincipalComponentsRequired
Definition: otbEstimateInnerProductPCAImageFilter.h:106
otb::StreamingInnerProductVectorImageFilter
This class streams the whole input image through the PersistentStatisticsImageFilter.
Definition: otbStreamingInnerProductVectorImageFilter.h:165
otb::EstimateInnerProductPCAImageFilter::OutputPixelType
OutputImageType::PixelType OutputPixelType
Definition: otbEstimateInnerProductPCAImageFilter.h:60
otb::EstimateInnerProductPCAImageFilter::m_EigenVectorsOfInnerProductMatrix
MatrixType m_EigenVectorsOfInnerProductMatrix
Definition: otbEstimateInnerProductPCAImageFilter.h:115
otb::StreamingInnerProductVectorImageFilter::MatrixObjectType
StatFilterType::MatrixObjectType MatrixObjectType
Definition: otbStreamingInnerProductVectorImageFilter.h:185
otb::EstimateInnerProductPCAImageFilter::OutputInternalPixelType
OutputImageType::InternalPixelType OutputInternalPixelType
Definition: otbEstimateInnerProductPCAImageFilter.h:61
otb::EstimateInnerProductPCAImageFilter::Self
EstimateInnerProductPCAImageFilter Self
Definition: otbEstimateInnerProductPCAImageFilter.h:41
otb::EstimateInnerProductPCAImageFilter::InputPixelType
InputImageType::PixelType InputPixelType
Definition: otbEstimateInnerProductPCAImageFilter.h:55