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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright (C) 1999-2011 Insight Software Consortium
* 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 otbBandMathXImageFilter_h
#define otbBandMathXImageFilter_h
#include "itkConstNeighborhoodIterator.h"
#include "itkImageToImageFilter.h"
#include "itkArray.h"
#include "otbStreamingStatisticsVectorImageFilter.h"
#include "otbParserX.h"
#include <vector>
namespace otb
{
/** \class BandMathXImageFilter
* \brief Performs mathematical operations on the input images
* according to the formula specified by the user.
*
* This filter is based on the mathematical parser library muParserX.
* The built in functions and operators list is available at:
* http://articles.beltoforion.de/article.php?a=muparserx.
*
* In order to use this filter, at least one input image is to be
* set. An associated variable name can be specified or not by using
* the corresponding SetNthInput method. For the jth (j=1..T) input image, if
* no associated variable name has been specified, a default variable
* name is given by concatenating the prefix "im" with the
* corresponding input index plus one (for instance, im1 is related to the first input).
* If the jth input image is multidimensional, then the variable imj represents a vector whose components are related to its bands.
* In order to access the kth band, the variable observes the following pattern : imjbk.
*
* \sa Parser
*
* \ingroup Streamed
* \ingroup Threaded
*
* \ingroup OTBMathParserX
*/
template< class TImage >
class ITK_EXPORT BandMathXImageFilter
: public itk::ImageToImageFilter< TImage , TImage >
{
public:
/** Standard class typedefs. */
typedef BandMathXImageFilter< TImage > Self;
typedef itk::ImageToImageFilter< TImage , TImage> Superclass;
typedef itk::SmartPointer< Self > Pointer;
typedef itk::SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(BandMathXImageFilter, ImageToImageFilter);
/** Some convenient typedefs. */
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 for statistic computing. */
typedef StreamingStatisticsVectorImageFilter<ImageType> StreamingStatisticsVectorImageFilterType;
typedef typename StreamingStatisticsVectorImageFilterType::Pointer StreamingStatisticsVectorImageFilterPointerType;
typedef typename StreamingStatisticsVectorImageFilterType::MatrixType MatrixType;
/** Set the nth filter input with or without a specified associated variable name */
using Superclass::SetNthInput;
void SetNthInput( DataObjectPointerArraySizeType idx, const ImageType * image);
void SetNthInput( DataObjectPointerArraySizeType idx, const ImageType * image, const std::string& varName);
/** Return a pointer on the nth filter input */
ImageType * GetNthInput(DataObjectPointerArraySizeType idx);
/** Set an expression to be parsed */
void SetManyExpressions(bool flag);
/** Set an expression to be parsed */
void SetExpression(const std::string& expression);
/** Return the nth expression to be parsed */
std::string GetExpression(int) const;
/** Set a matrix (or a vector) */
void SetMatrix(const std::string& name, const std::string& definition);
/** Set a constant */
void SetConstant(const std::string& name, double value);
/** Export constants and expressions to a given filename */
void ExportContext(const std::string& filename);
/** Import constants and expressions from a given filename */
void ImportContext(const std::string& filename);
/** Return the variable and constant names */
std::vector<std::string> GetVarNames() const;
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 :
bool globalStatsDetected() const
{
return (m_StatsVarDetected.size()>0);
}
typedef struct {
std::string name;
ValueType value;
int type;
int info[5];
} adhocStruct;
BandMathXImageFilter(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
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.txx"
#endif
#endif
|
