/
FindSurfaceFeatures.h
242 lines (203 loc) · 7.93 KB
/
FindSurfaceFeatures.h
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/* ============================================================================
* Copyright (c) 2009-2016 BlueQuartz Software, LLC
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* Neither the name of BlueQuartz Software, the US Air Force, nor the names of its
* contributors may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The code contained herein was partially funded by the followig contracts:
* United States Air Force Prime Contract FA8650-07-D-5800
* United States Air Force Prime Contract FA8650-10-D-5210
* United States Prime Contract Navy N00173-07-C-2068
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
#pragma once
#include <memory>
#include "SIMPLib/SIMPLib.h"
#include "SIMPLib/Filtering/AbstractFilter.h"
#include "SIMPLib/DataArrays/DataArray.hpp"
#include "Generic/GenericDLLExport.h"
/**
* @brief The FindSurfaceFeatures class. See [Filter documentation](@ref findsurfacefeatures) for details.
*/
class Generic_EXPORT FindSurfaceFeatures : public AbstractFilter
{
Q_OBJECT
#ifdef SIMPL_ENABLE_PYTHON
PYB11_CREATE_BINDINGS(FindSurfaceFeatures SUPERCLASS AbstractFilter)
PYB11_SHARED_POINTERS(FindSurfaceFeatures)
PYB11_FILTER_NEW_MACRO(FindSurfaceFeatures)
PYB11_FILTER_PARAMETER(DataArrayPath, FeatureIdsArrayPath)
PYB11_FILTER_PARAMETER(DataArrayPath, SurfaceFeaturesArrayPath)
PYB11_PROPERTY(DataArrayPath FeatureIdsArrayPath READ getFeatureIdsArrayPath WRITE setFeatureIdsArrayPath)
PYB11_PROPERTY(DataArrayPath SurfaceFeaturesArrayPath READ getSurfaceFeaturesArrayPath WRITE setSurfaceFeaturesArrayPath)
#endif
public:
using Self = FindSurfaceFeatures;
using Pointer = std::shared_ptr<Self>;
using ConstPointer = std::shared_ptr<const Self>;
using WeakPointer = std::weak_ptr<Self>;
using ConstWeakPointer = std::weak_ptr<const Self>;
/**
* @brief Returns a NullPointer wrapped by a shared_ptr<>
* @return
*/
static Pointer NullPointer();
/**
* @brief Creates a new object wrapped in a shared_ptr<>
* @return
*/
static Pointer New();
/**
* @brief Returns the name of the class for FindSurfaceFeatures
*/
QString getNameOfClass() const override;
/**
* @brief Returns the name of the class for FindSurfaceFeatures
*/
static QString ClassName();
~FindSurfaceFeatures() override;
/**
* @brief Setter property for FeatureIdsArrayPath
*/
void setFeatureIdsArrayPath(const DataArrayPath& value);
/**
* @brief Getter property for FeatureIdsArrayPath
* @return Value of FeatureIdsArrayPath
*/
DataArrayPath getFeatureIdsArrayPath() const;
Q_PROPERTY(DataArrayPath FeatureIdsArrayPath READ getFeatureIdsArrayPath WRITE setFeatureIdsArrayPath)
/**
* @brief Setter property for SurfaceFeaturesArrayPath
*/
void setSurfaceFeaturesArrayPath(const DataArrayPath& value);
/**
* @brief Getter property for SurfaceFeaturesArrayPath
* @return Value of SurfaceFeaturesArrayPath
*/
DataArrayPath getSurfaceFeaturesArrayPath() const;
Q_PROPERTY(DataArrayPath SurfaceFeaturesArrayPath READ getSurfaceFeaturesArrayPath WRITE setSurfaceFeaturesArrayPath)
/**
* @brief getCompiledLibraryName Reimplemented from @see AbstractFilter class
*/
QString getCompiledLibraryName() const override;
/**
* @brief getBrandingString Returns the branding string for the filter, which is a tag
* used to denote the filter's association with specific plugins
* @return Branding string
*/
QString getBrandingString() const override;
/**
* @brief getFilterVersion Returns a version string for this filter. Default
* value is an empty string.
* @return
*/
QString getFilterVersion() const override;
/**
* @brief newFilterInstance Reimplemented from @see AbstractFilter class
*/
AbstractFilter::Pointer newFilterInstance(bool copyFilterParameters) const override;
/**
* @brief getGroupName Reimplemented from @see AbstractFilter class
*/
QString getGroupName() const override;
/**
* @brief getSubGroupName Reimplemented from @see AbstractFilter class
*/
QString getSubGroupName() const override;
/**
* @brief getUuid Return the unique identifier for this filter.
* @return A QUuid object.
*/
QUuid getUuid() const override;
/**
* @brief getHumanLabel Reimplemented from @see AbstractFilter class
*/
QString getHumanLabel() const override;
/**
* @brief setupFilterParameters Reimplemented from @see AbstractFilter class
*/
void setupFilterParameters() override;
/**
* @brief readFilterParameters Reimplemented from @see AbstractFilter class
*/
void readFilterParameters(AbstractFilterParametersReader* reader, int index) override;
/**
* @brief execute Reimplemented from @see AbstractFilter class
*/
void execute() override;
/**
* @brief preflight Reimplemented from @see AbstractFilter class
*/
void preflight() override;
signals:
/**
* @brief updateFilterParameters Emitted when the Filter requests all the latest Filter parameters
* be pushed from a user-facing control (such as a widget)
* @param filter Filter instance pointer
*/
void updateFilterParameters(AbstractFilter* filter);
/**
* @brief parametersChanged Emitted when any Filter parameter is changed internally
*/
void parametersChanged();
/**
* @brief preflightAboutToExecute Emitted just before calling dataCheck()
*/
void preflightAboutToExecute();
/**
* @brief preflightExecuted Emitted just after calling dataCheck()
*/
void preflightExecuted();
protected:
FindSurfaceFeatures();
/**
* @brief dataCheck Checks for the appropriate parameter values and availability of arrays
*/
void dataCheck();
/**
* @brief Initializes all the private instance variables.
*/
void initialize();
/**
* @brief find_surfacefeatures Determines which Features intersect the outer surface of a 3D volume.
*/
void find_surfacefeatures();
/**
* @brief find_surfacefeatures2D Determines which Features intersect the outer boundary of a 2D area.
*/
void find_surfacefeatures2D();
private:
std::weak_ptr<DataArray<int32_t>> m_FeatureIdsPtr;
int32_t* m_FeatureIds = nullptr;
std::weak_ptr<DataArray<bool>> m_SurfaceFeaturesPtr;
bool* m_SurfaceFeatures = nullptr;
DataArrayPath m_FeatureIdsArrayPath = {};
DataArrayPath m_SurfaceFeaturesArrayPath = {};
public:
FindSurfaceFeatures(const FindSurfaceFeatures&) = delete; // Copy Constructor Not Implemented
FindSurfaceFeatures(FindSurfaceFeatures&&) = delete; // Move Constructor Not Implemented
FindSurfaceFeatures& operator=(const FindSurfaceFeatures&) = delete; // Copy Assignment Not Implemented
FindSurfaceFeatures& operator=(FindSurfaceFeatures&&) = delete; // Move Assignment Not Implemented
};