1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
* Copyright (C) 2005-2017 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 otbSpectralAngleDistanceImageFilter_h
#define otbSpectralAngleDistanceImageFilter_h
#include "itkImageToImageFilter.h"
namespace otb
{
/** \class SpectralAngleDistanceImageFilter
* \brief This filter implements the computation of the spectral angle
* distance with respect to a reference pixel.
*
* Spectral angle distance is an efficient way to convert spectral information to
* scalar data with respect to a reference pixel. The spectral angle distance
* is defined as:
*
* \f[SA = cos^{-1}\Big(\frac{{\sum_{b=1}^{n_{b}}}r(b)\cdot p(b)}{\sqrt{{\sum_{b=1}^{n_{b}}}r(b)^{2}{\sum_{b=1}^{n_{b}}p(b)^{2}}}}\Big) \f]
* with \f$b\f$ being the spectral band, \f$r\f$ the reference pixel and \f$p\f$
* the current pixel.
*
* Since the spectral angle deals with multi-bands image, the InputImage pixels are supposed to
* support the [] operator, and the input image to support the GetNumberOfComponentsPerPixel() method.
*
* \sa VectorImage
*
* This filter is implemented as a multithreaded filter.
*
* \ingroup IntensityImageFilters
* \ingroup Threading
* \ingroup Streamed
*
* \ingroup OTBImageManipulation
*/
template <class TInputImage, class TOutputImage>
class ITK_EXPORT SpectralAngleDistanceImageFilter
: public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
/** Standard typedefs */
typedef SpectralAngleDistanceImageFilter Self;
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Type macro */
itkNewMacro(Self);
/** Creation through object factory macro */
itkTypeMacro(SpectralAngleDistanceImageFilter, itk::ImageToImageFilter);
/** Template parameters typedefs */
typedef TInputImage InputImageType;
typedef typename InputImageType::ConstPointer InputImageConstPointerType;
typedef typename InputImageType::RegionType InputImageRegionType;
typedef typename InputImageType::PixelType InputPixelType;
typedef TOutputImage OutputImageType;
typedef typename OutputImageType::Pointer OutputImagePointerType;
typedef typename OutputImageType::RegionType OutputImageRegionType;
typedef typename OutputImageType::PixelType OutputPixelType;
/** Get/Set the reference pixel */
itkGetConstReferenceMacro(ReferencePixel, InputPixelType);
itkSetMacro(ReferencePixel, InputPixelType);
protected:
/** Constructor */
SpectralAngleDistanceImageFilter();
/** Destructor */
~SpectralAngleDistanceImageFilter() override {}
/**PrintSelf method */
void PrintSelf(std::ostream& os, itk::Indent indent) const override;
/** SpectralAngleDistanceImageFilter can be implemented as a multithreaded filter.
* Therefore, this implementation provides a ThreadedGenerateData() routine
* which is called for each processing thread. The output image data is
* allocated automatically by the superclass prior to calling
* ThreadedGenerateData(). ThreadedGenerateData can only write to the
* portion of the output image specified by the parameter
* "outputRegionForThread"
*
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
itk::ThreadIdType threadId) override;
void BeforeThreadedGenerateData() override;
private:
SpectralAngleDistanceImageFilter(const Self &); //purposely not implemented
void operator =(const Self&); //purposely not implemented
/** The reference pixel */
InputPixelType m_ReferencePixel;
};
} // End namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSpectralAngleDistanceImageFilter.txx"
#endif
#endif
|
