ViennaLS
Loading...
Searching...
No Matches
pyWrap.hpp
Go to the documentation of this file.
1#include <pybind11/functional.h>
2#include <pybind11/iostream.h>
3#include <pybind11/pybind11.h>
4#include <pybind11/stl.h>
5
6// all header files which define API functions
7#include <lsAdvect.hpp>
12#include <lsCheck.hpp>
13#include <lsCompareChamfer.hpp>
17#include <lsCompareVolume.hpp>
18#include <lsConvexHull.hpp>
19#include <lsDetectFeatures.hpp>
20#include <lsDomain.hpp>
21#include <lsExpand.hpp>
22#include <lsExtrude.hpp>
23#include <lsFileFormats.hpp>
24#include <lsFromMesh.hpp>
25#include <lsFromSurfaceMesh.hpp>
26#include <lsFromVolumeMesh.hpp>
27#include <lsGeometricAdvect.hpp>
29#include <lsGeometries.hpp>
30#include <lsMakeGeometry.hpp>
31#include <lsMarkVoidPoints.hpp>
32#include <lsMaterialMap.hpp>
33#include <lsMesh.hpp>
34#include <lsPointData.hpp>
35#include <lsPrune.hpp>
36#include <lsReader.hpp>
37#include <lsReduce.hpp>
39#include <lsSlice.hpp>
40#include <lsToDiskMesh.hpp>
41#include <lsToMesh.hpp>
43#include <lsToSurfaceMesh.hpp>
44#include <lsToVoxelMesh.hpp>
45#include <lsTransformMesh.hpp>
46#include <lsVTKReader.hpp>
47#include <lsVTKRenderWindow.hpp>
48#include <lsVTKWriter.hpp>
49#include <lsVelocityField.hpp>
50#include <lsVersion.hpp>
52#include <lsWriter.hpp>
53
54#include <vcLogger.hpp>
55#include <vcSmartPointer.hpp>
56
57using namespace viennals;
58namespace py = pybind11;
59
60// always use double for python export
61typedef double T;
62
63PYBIND11_DECLARE_HOLDER_TYPE(TemplateType, SmartPointer<TemplateType>);
64
65// GeometricAdvectDistribution
66template <int D>
68 : public GeometricAdvectDistribution<T, D> {
69 typedef std::array<viennahrle::CoordType, 3> vectorType;
70 typedef std::array<viennahrle::CoordType, 6> boundsType;
71 typedef GeometricAdvectDistribution<T, D> ClassType;
73
74public:
75 bool isInside(const vectorType &initial, const vectorType &candidate,
76 double eps = 0.) const override {
77 PYBIND11_OVERLOAD(bool, ClassType, isInside, initial, candidate, eps);
78 }
79
80 T getSignedDistance(const vectorType &initial, const vectorType &candidate,
81 unsigned long initialPointId) const override {
82 PYBIND11_OVERLOAD_PURE(T, ClassType, getSignedDistance, initial, candidate,
83 initialPointId);
84 }
85
86 boundsType getBounds() const override {
87 PYBIND11_OVERLOAD_PURE(boundsType, ClassType, getBounds);
88 }
89};
90
91template <int D> void bindApi(py::module &module) {
92 // Also wrap hrleGrid so it can be used to create new LevelSets
93 py::class_<viennahrle::Grid<D>>(module, "hrleGrid");
94
95 // Domain
96 py::class_<Domain<T, D>, SmartPointer<Domain<T, D>>>(module, "Domain")
97 // constructors
98 .def(py::init(&SmartPointer<Domain<T, D>>::template New<>))
99 .def(
100 py::init(
101 &SmartPointer<Domain<T, D>>::template New<viennahrle::CoordType>),
102 py::arg("gridDelta") = 1.0)
103 // .def(py::init(
104 // &SmartPointer<Domain<T, D>>::New<viennahrle::CoordType *,
105 // BoundaryConditionEnum *>))
106 .def(py::init([](std::array<viennahrle::CoordType, 2 * D> bounds,
107 std::array<BoundaryConditionEnum, D> bcs,
108 viennahrle::CoordType gridDelta) {
109 return SmartPointer<Domain<T, D>>::New(bounds.data(), bcs.data(),
110 gridDelta);
111 }),
112 py::arg("bounds"), py::arg("boundaryConditions"),
113 py::arg("gridDelta") = 1.0)
114 .def(py::init(&SmartPointer<Domain<T, D>>::template New<
115 std::vector<viennahrle::CoordType>, std::vector<unsigned>,
116 viennahrle::CoordType>),
117 py::arg("bounds"), py::arg("boundaryConditions"),
118 py::arg("gridDelta") = 1.0)
119 // .def(py::init(
120 // &SmartPointer<Domain<T, D>>::New<Domain<T,
121 // D>::PointValueVectorType,
122 // viennahrle::CoordType *,
123 // BoundaryConditionEnum *>))
124 // .def(py::init(&SmartPointer<Domain<T, D>>::New<
125 // Domain<T, D>::PointValueVectorType,
126 // viennahrle::CoordType
127 // *, BoundaryConditionEnum *,
128 // viennahrle::CoordType>))
129 .def(py::init(&SmartPointer<Domain<T, D>>::template New<
130 SmartPointer<Domain<T, D>> &>))
131 .def(py::init(
132 &SmartPointer<Domain<T, D>>::template New<viennahrle::Grid<D> &>))
133 // methods
134 .def("deepCopy", &Domain<T, D>::deepCopy,
135 "Copy lsDomain in this lsDomain.")
136 .def("getNumberOfSegments", &Domain<T, D>::getNumberOfSegments,
137 "Get the number of segments, the level set structure is divided "
138 "into.")
139 .def("getNumberOfPoints", &Domain<T, D>::getNumberOfPoints,
140 "Get the number of defined level set values.")
141 .def("getLevelSetWidth", &Domain<T, D>::getLevelSetWidth,
142 "Get the number of layers of level set points around the explicit "
143 "surface.")
144 .def("setLevelSetWidth", &Domain<T, D>::setLevelSetWidth,
145 "Set the number of layers of level set points which should be "
146 "stored around the explicit surface.")
147 .def("clearMetaData", &Domain<T, D>::clearMetaData,
148 "Clear all metadata stored in the level set.")
149 // allow filehandle to be passed and default to python standard output
150 .def(
151 "print",
152 [](Domain<T, D> &d, py::object fileHandle) {
153 if (!(py::hasattr(fileHandle, "write") &&
154 py::hasattr(fileHandle, "flush"))) {
155 throw py::type_error(
156 "MyClass::read_from_file_like_object(file): incompatible "
157 "function argument: `file` must be a file-like object, but "
158 "`" +
159 (std::string)(py::repr(fileHandle)) + "` provided");
160 }
161 py::detail::pythonbuf buf(fileHandle);
162 std::ostream stream(&buf);
163 d.print(stream);
164 },
165 py::arg("stream") = py::module::import("sys").attr("stdout"));
166
167 // Advect
168 py::class_<Advect<T, D>, SmartPointer<Advect<T, D>>>(module, "Advect")
169 // constructors
170 .def(py::init(&SmartPointer<Advect<T, D>>::template New<>))
171 .def(py::init(&SmartPointer<Advect<T, D>>::template New<
172 SmartPointer<Domain<T, D>> &>))
173 .def(py::init(
174 &SmartPointer<Advect<T, D>>::template New<
175 SmartPointer<Domain<T, D>> &, SmartPointer<VelocityField<T>> &>))
176 // getters and setters
177 .def("insertNextLevelSet", &Advect<T, D>::insertNextLevelSet,
178 "Insert next level set to use for advection.")
179 .def("clearLevelSets", &Advect<T, D>::clearLevelSets,
180 "Clear all level sets used for advection.")
181 .def("setVelocityField", &Advect<T, D>::setVelocityField,
182 "Set the velocity to use for advection.")
183 .def("setAdvectionTime", &Advect<T, D>::setAdvectionTime,
184 "Set the time until when the level set should be advected.")
185 .def("setSingleStep", &Advect<T, D>::setSingleStep, py::arg("singleStep"),
186 "Set whether only a single advection step should be performed.")
187 .def("setTimeStepRatio", &Advect<T, D>::setTimeStepRatio,
188 "Set the maximum time step size relative to grid size. Advection is "
189 "only stable for <0.5.")
190 .def("setCalculateNormalVectors",
192 "Set whether normal vectors are needed for the supplied velocity "
193 "field.")
194 .def("setIgnoreVoids", &Advect<T, D>::setIgnoreVoids,
195 "Set whether voids in the geometry should be ignored during "
196 "advection or not.")
197 .def("setAdaptiveTimeStepping", &Advect<T, D>::setAdaptiveTimeStepping,
198 py::arg("enabled") = true, py::arg("subdivisions") = 20,
199 "Enable/disable adaptive time stepping and set the number of "
200 "subdivisions.")
201 .def(
202 "setSaveAdvectionVelocities",
204 "Set whether the velocities applied to each point should be saved in "
205 "the level set for debug purposes.")
206 .def("setCheckDissipation", &Advect<T, D>::setCheckDissipation,
207 py::arg("check"), "Enable/disable dissipation checking.")
208 .def("setUpdatePointData", &Advect<T, D>::setUpdatePointData,
209 py::arg("update"),
210 "Enable/disable updating point data after advection.")
211 .def("getAdvectedTime", &Advect<T, D>::getAdvectedTime,
212 "Get the time passed during advection.")
213 .def("getNumberOfTimeSteps", &Advect<T, D>::getNumberOfTimeSteps,
214 "Get how many advection steps were performed after the last apply() "
215 "call.")
216 .def("getTimeStepRatio", &Advect<T, D>::getTimeStepRatio,
217 "Get the time step ratio used for advection.")
218 .def("getCurrentTimeStep", &Advect<T, D>::getCurrentTimeStep,
219 "Get the current time step.")
220 .def("getCalculateNormalVectors",
222 "Get whether normal vectors are computed during advection.")
223 .def("setSpatialScheme", &Advect<T, D>::setSpatialScheme,
224 "Set the spatial discretization scheme to use during advection.")
225 .def("setTemporalScheme", &Advect<T, D>::setTemporalScheme,
226 "Set the time integration scheme to use during advection.")
227 .def("setIntegrationScheme", &Advect<T, D>::setIntegrationScheme,
228 "(DEPRECATED, use setSpatialScheme instead) Set the spatial "
229 "discretization scheme to use during advection.")
230 .def("setDissipationAlpha", &Advect<T, D>::setDissipationAlpha,
231 "Set the dissipation value to use for Lax Friedrichs spatial "
232 "discretization.")
233 .def("setUpdatePointData", &Advect<T, D>::setUpdatePointData,
234 "Set whether the point data in the old LS should be translated to "
235 "the advected LS. Defaults to true.")
236 .def(
237 "setVelocityUpdateCallback", &Advect<T, D>::setVelocityUpdateCallback,
238 "Set a callback function that is called after the level set has been "
239 "updated during intermediate time integration steps (e.g. RK2, RK3).")
240 .def("prepareLS", &Advect<T, D>::prepareLS, "Prepare the level-set.")
241 // need scoped release since we are calling a python method from
242 // parallelised C++ code here
243 .def("apply", &Advect<T, D>::apply,
244 py::call_guard<py::gil_scoped_release>(), "Perform advection.");
245
246 py::class_<lsInternal::StencilLocalLaxFriedrichsScalar<T, D, 1>>(
247 module, "StencilLocalLaxFriedrichsScalar")
248 .def_static(
249 "setMaxDissipation",
251 1>::setMaxDissipation,
252 py::arg("maxDissipation"));
253
254 module.def("PrepareStencilLocalLaxFriedrichs",
255 &PrepareStencilLocalLaxFriedrichs<T, D>, py::arg("levelSets"),
256 py::arg("isDepo"));
257
258 module.def("FinalizeStencilLocalLaxFriedrichs",
259 &FinalizeStencilLocalLaxFriedrichs<T, D>, py::arg("levelSets"));
260
261 // BooleanOperation
262 py::class_<BooleanOperation<T, D>, SmartPointer<BooleanOperation<T, D>>>(
263 module, "BooleanOperation")
264 // constructors
265 .def(py::init(&SmartPointer<BooleanOperation<T, D>>::template New<>))
266 .def(py::init(&SmartPointer<BooleanOperation<T, D>>::template New<
267 SmartPointer<Domain<T, D>> &>))
268 .def(
269 py::init(&SmartPointer<BooleanOperation<T, D>>::template New<
270 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
271 // some constructors need lambda to work: seems to be an issue with
272 // implicit move constructor
273 .def(py::init(
274 [](SmartPointer<Domain<T, D>> &domain, BooleanOperationEnum op) {
275 return SmartPointer<BooleanOperation<T, D>>::New(domain, op);
276 }))
277 .def(py::init([](SmartPointer<Domain<T, D>> &domainA,
278 SmartPointer<Domain<T, D>> &domainB,
280 return SmartPointer<BooleanOperation<T, D>>::New(domainA, domainB, op);
281 }))
282 // methods
283 .def("setLevelset", &BooleanOperation<T, D>::setLevelSet,
284 "Set levelset on which the boolean operation should be performed.")
285 .def("setSecondLevelSet", &BooleanOperation<T, D>::setSecondLevelSet,
286 "Set second levelset for boolean operation.")
287 .def("setBooleanOperation", &BooleanOperation<T, D>::setBooleanOperation,
288 "Set which type of boolean operation should be performed.")
289 .def("apply", &BooleanOperation<T, D>::apply,
290 "Perform the boolean operation.");
291
292 py::class_<CalculateCurvatures<T, D>,
293 SmartPointer<CalculateCurvatures<T, D>>>(module,
294 "CalculateCurvatures")
295 // constructors
296 .def(py::init(&SmartPointer<CalculateCurvatures<T, D>>::template New<>))
297 .def(py::init(&SmartPointer<CalculateCurvatures<T, D>>::template New<
298 SmartPointer<Domain<T, D>> &>))
299 // some constructors need lambda to work: seems to be an issue with
300 // implicit move constructor
301 .def(py::init([](SmartPointer<Domain<T, D>> &domain, CurvatureEnum type) {
302 return SmartPointer<CalculateCurvatures<T, D>>::New(domain, type);
303 }))
304 // methods
305 .def("setLevelSet", &CalculateCurvatures<T, D>::setLevelSet,
306 "Set levelset for which to calculate the curvatures.")
307 .def("setCurvatureType", &CalculateCurvatures<T, D>::setCurvatureType,
308 "Set which method to use for calculation: Defaults to mean "
309 "curvature.")
310 .def("setMaxValue", &CalculateCurvatures<T, D>::setMaxValue,
311 "Curvatures will be calculated for all LS values < maxValue.")
313 "Perform normal vector calculation.");
314
315 // CalculateNormalVectors
316 py::class_<CalculateNormalVectors<T, D>,
317 SmartPointer<CalculateNormalVectors<T, D>>>(
318 module, "CalculateNormalVectors")
319 // constructors
320 .def(
321 py::init(&SmartPointer<CalculateNormalVectors<T, D>>::template New<>))
322 .def(py::init(&SmartPointer<CalculateNormalVectors<T, D>>::template New<
323 SmartPointer<Domain<T, D>> &>))
324 // methods
326 "Set levelset for which to calculate normal vectors.")
328 "Set the maximum value for which normals should be calculated.")
330 "Set the method to use for normal calculation.")
332 "Perform normal vector calculation.");
333
334 // CalculateVisibilities
335 py::class_<CalculateVisibilities<T, D>,
336 SmartPointer<CalculateVisibilities<T, D>>>(module,
337 "CalculateVisibilities")
338 .def(py::init(
339 &SmartPointer<CalculateVisibilities<T, D>>::template New<
340 SmartPointer<Domain<T, D>> &, const Vec3D<T> &, std::string>))
342
343 // Check
344 py::class_<Check<T, D>, SmartPointer<Check<T, D>>>(module, "Check")
345 // constructors
346 .def(py::init(&SmartPointer<Check<T, D>>::template New<>))
347 .def(py::init(&SmartPointer<Check<T, D>>::template New<
348 SmartPointer<Domain<T, D>> &>))
349 // methods
350 .def("setLevelSet", &Check<T, D>::setLevelSet,
351 "Set levelset for which to calculate normal vectors.")
352 .def("apply", &Check<T, D>::apply, "Perform check.");
353
354 // PointCloud
355 py::class_<PointCloud<T, D>, SmartPointer<PointCloud<T, D>>>(module,
356 "PointCloud")
357 // constructors
358 .def(py::init(&SmartPointer<PointCloud<T, D>>::template New<
359 const std::vector<VectorType<T, D>> &>))
360 // methods
361 .def("insertNextPoint",
362 (void(PointCloud<T, D>::*)(const VectorType<T, D> &)) &
364
365 // ConvexHull
366 py::class_<ConvexHull<T, D>, SmartPointer<ConvexHull<T, D>>>(module,
367 "ConvexHull")
368 // constructors
369 .def(py::init(&SmartPointer<ConvexHull<T, D>>::template New<>))
370 .def(py::init(&SmartPointer<ConvexHull<T, D>>::template New<
371 SmartPointer<Mesh<T>> &, SmartPointer<PointCloud<T, D>> &>))
372 // methods
373 .def("setMesh", &ConvexHull<T, D>::setMesh,
374 "Set mesh object where the generated mesh should be stored.")
375 .def("setPointCloud", &ConvexHull<T, D>::setPointCloud,
376 "Set point cloud used to generate mesh.")
377 .def("apply", &ConvexHull<T, D>::apply, "Generate Hull.");
378
379 // DetectFeatures
380 py::class_<DetectFeatures<T, D>, SmartPointer<DetectFeatures<T, D>>>(
381 module, "DetectFeatures")
382 // constructors
383 .def(py::init(&SmartPointer<DetectFeatures<T, D>>::template New<>))
384 .def(py::init(&SmartPointer<DetectFeatures<T, D>>::template New<
385 SmartPointer<Domain<T, D>> &>))
386 .def(py::init(&SmartPointer<DetectFeatures<T, D>>::template New<
387 SmartPointer<Domain<T, D>> &, T>))
388 // some constructors need lambda to work: seems to be an issue with
389 // implicit move constructor
390 .def(py::init([](SmartPointer<Domain<T, D>> &domain, T maxValue,
392 return SmartPointer<DetectFeatures<T, D>>::New(domain, maxValue, type);
393 }))
394 .def("setDetectionThreshold",
396 "Set the curvature value above which a point is considered a "
397 "feature.")
398 .def("setDetectionMethod", &DetectFeatures<T, D>::setDetectionMethod,
399 "Set which method to use to detect features. Defaults to Curvature.")
400 .def("apply", &DetectFeatures<T, D>::apply, "Detect features.");
401
402 // GeometricAdvect
403 py::class_<GeometricAdvect<T, D>, SmartPointer<GeometricAdvect<T, D>>>(
404 module, "GeometricAdvect")
405 // constructors
406 .def(py::init(&SmartPointer<GeometricAdvect<T, D>>::template New<>))
407 .def(py::init(
408 &SmartPointer<GeometricAdvect<T, D>>::template New<
409 SmartPointer<Domain<T, D>> &,
410 SmartPointer<
412 // methods
413 .def("setLevelSet", &GeometricAdvect<T, D>::setLevelSet,
414 "Set levelset to advect.")
415 .def(
416 "setAdvectionDistribution",
418 "Set advection distribution to use as kernel for the fast advection.")
419 .def("apply", &GeometricAdvect<T, D>::apply,
420 py::call_guard<py::gil_scoped_release>(), "Perform advection.");
421
422 // GeometricAdvectDistributions
423 py::class_<GeometricAdvectDistribution<T, D>,
424 SmartPointer<GeometricAdvectDistribution<T, D>>,
426 "GeometricAdvectDistribution")
427 // constructors
428 .def(py::init<>())
429 // methods
431 "Check whether passed point is inside the distribution.")
432 .def("getSignedDistance",
434 "Get the signed distance of the passed point to the surface of the "
435 "distribution.")
437 "Get the cartesian bounds of the distribution.")
439 "Prepare the distribution for use with the passed level set.")
441 "Finalize the distribution after use with the level set.");
442
443 py::class_<SphereDistribution<T, D>, SmartPointer<SphereDistribution<T, D>>,
444 GeometricAdvectDistribution<T, D>>(module, "SphereDistribution")
445 // constructors
446 .def(py::init(&SmartPointer<SphereDistribution<T, D>>::template New<T>))
447 // methods
448 .def("isInside", &SphereDistribution<T, D>::isInside,
449 "Check whether passed point is inside the distribution.")
450 .def("getSignedDistance", &SphereDistribution<T, D>::getSignedDistance,
451 "Get the signed distance of the passed point to the surface of the "
452 "distribution.")
453 .def("getBounds", &SphereDistribution<T, D>::getBounds,
454 "Get the cartesian bounds of the distribution.");
455
456 py::class_<BoxDistribution<T, D>, SmartPointer<BoxDistribution<T, D>>,
457 GeometricAdvectDistribution<T, D>>(module, "BoxDistribution")
458 // constructors
459 .def(py::init(&SmartPointer<BoxDistribution<T, D>>::template New<
460 const std::array<T, 3>>))
461 // methods
462 .def("isInside", &BoxDistribution<T, D>::isInside,
463 "Check whether passed point is inside the distribution.")
464 .def("getSignedDistance", &BoxDistribution<T, D>::getSignedDistance,
465 "Get the signed distance of the passed point to the surface of the "
466 "distribution.")
467 .def("getBounds", &BoxDistribution<T, D>::getBounds,
468 "Get the cartesian bounds of the distribution.");
469
470 py::class_<CustomSphereDistribution<T, D>,
471 SmartPointer<CustomSphereDistribution<T, D>>,
473 "CustomSphereDistribution")
474 // constructors
475 .def(py::init(&SmartPointer<CustomSphereDistribution<T, D>>::template New<
476 const std::vector<T> &>))
477 // methods
479 "Check whether passed point is inside the distribution.")
480 .def("getSignedDistance",
482 "Get the signed distance of the passed point to the surface of the "
483 "distribution.")
485 "Get the cartesian bounds of the distribution.");
486
487 // Expand
488 py::class_<Expand<T, D>, SmartPointer<Expand<T, D>>>(module, "Expand")
489 // constructors
490 .def(py::init(&SmartPointer<Expand<T, D>>::template New<>))
491 .def(py::init(&SmartPointer<Expand<T, D>>::template New<
492 SmartPointer<Domain<T, D>> &>))
493 .def(py::init(&SmartPointer<Expand<T, D>>::template New<
494 SmartPointer<Domain<T, D>> &, int>))
495 // methods
496 .def("setLevelSet", &Expand<T, D>::setLevelSet, "Set levelset to expand.")
497 .def("setWidth", &Expand<T, D>::setWidth, "Set the width to expand to.")
498 .def("apply", &Expand<T, D>::apply, "Perform expansion.");
499
500 // FromSurfaceMesh
501 py::class_<FromSurfaceMesh<T, D>, SmartPointer<FromSurfaceMesh<T, D>>>(
502 module, "FromSurfaceMesh")
503 // constructors
504 .def(py::init(&SmartPointer<FromSurfaceMesh<T, D>>::template New<>))
505 .def(py::init(&SmartPointer<FromSurfaceMesh<T, D>>::template New<
506 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &>))
507 .def(py::init(
508 &SmartPointer<FromSurfaceMesh<T, D>>::template New<
509 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &, bool>))
510 // methods
511 .def("setLevelSet", &FromSurfaceMesh<T, D>::setLevelSet,
512 "Set levelset to read into.")
513 .def("setMesh", &FromSurfaceMesh<T, D>::setMesh,
514 "Set the mesh to read from.")
515 .def("setRemoveBoundaryTriangles",
516 static_cast<void (FromSurfaceMesh<T, D>::*)(bool)>(
518 "Set whether to include mesh elements outside of the simulation "
519 "domain.")
520 .def("setRemoveBoundaryTriangles",
521 static_cast<void (FromSurfaceMesh<T, D>::*)(std::array<bool, 3>)>(
523 "Set whether to include mesh elements outside of the simulation "
524 "domain.")
525 .def("apply", &FromSurfaceMesh<T, D>::apply,
526 "Construct a levelset from a surface mesh.");
527
528 // FromVolumeMesh
529 py::class_<FromVolumeMesh<T, D>, SmartPointer<FromVolumeMesh<T, D>>>(
530 module, "FromVolumeMesh")
531 // constructors
532 .def(py::init(&SmartPointer<FromVolumeMesh<T, D>>::template New<>))
533 .def(py::init(&SmartPointer<FromVolumeMesh<T, D>>::template New<
535 SmartPointer<Mesh<T>> &>))
536 .def(py::init(&SmartPointer<FromVolumeMesh<T, D>>::template New<
538 SmartPointer<Mesh<T>> &, bool>))
539 // methods
540 .def("setGrid", &FromVolumeMesh<T, D>::setGrid,
541 "Set the grid used to read in the level sets.")
542 .def("setMesh", &FromVolumeMesh<T, D>::setMesh,
543 "Set the mesh to read from.")
544 .def("setRemoveBoundaryTriangles",
546 "Set whether to include mesh elements outside of the simulation "
547 "domain.")
548 .def("apply", &FromVolumeMesh<T, D>::apply,
549 "Construct a levelset from a volume mesh.");
550
551 // FromMesh
552 py::class_<FromMesh<T, D>, SmartPointer<FromMesh<T, D>>>(module, "FromMesh")
553 .def(py::init(&SmartPointer<FromMesh<T, D>>::template New<>))
554 .def(py::init(&SmartPointer<FromMesh<T, D>>::template New<
555 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &>))
556 .def("setMesh", &FromMesh<T, D>::setMesh, "Set the mesh to read from.")
557 .def("setSortPointList", &FromMesh<T, D>::setSortPointList)
558 .def("apply", &FromMesh<T, D>::apply);
559
560 // lsGeometries
561 // Sphere
562 py::class_<Sphere<T, D>, SmartPointer<Sphere<T, D>>>(module, "Sphere")
563 // constructors
564 .def(py::init(&SmartPointer<Sphere<T, D>>::template New<
565 const std::vector<T> & /*origin*/, T /*radius*/>),
566 py::arg("origin"), py::arg("radius"));
567 // Plane
568 py::class_<Plane<T, D>, SmartPointer<Plane<T, D>>>(module, "Plane")
569 // constructors
570 .def(py::init(&SmartPointer<Plane<T, D>>::template New<
571 const std::vector<T> & /*origin*/,
572 const std::vector<T> & /*normal*/>),
573 py::arg("origin"), py::arg("normal"));
574 // Box
575 py::class_<Box<T, D>, SmartPointer<Box<T, D>>>(module, "Box")
576 // constructors
577 .def(py::init(&SmartPointer<Box<T, D>>::template New<
578 const std::vector<T> & /*minPoint*/,
579 const std::vector<T> & /*maxPoint*/>),
580 py::arg("minPoint"), py::arg("maxPoint"));
581 // Cylinder
582 py::class_<Cylinder<T, D>, SmartPointer<Cylinder<T, D>>>(module, "Cylinder")
583 // constructors
584 .def(
585 py::init(&SmartPointer<Cylinder<T, D>>::template New<
586 const std::vector<T> & /*origin*/,
587 const std::vector<T> & /*axisDirection*/, const T /*height*/,
588 const T /*radius*/, const T /*topRadius*/>),
589 py::arg("origin"), py::arg("axisDirection"), py::arg("height"),
590 py::arg("radius"), py::arg("topRadius") = 0.);
591
592 // MakeGeometry
593 py::class_<MakeGeometry<T, D>, SmartPointer<MakeGeometry<T, D>>>(
594 module, "MakeGeometry")
595 // constructors
596 .def(py::init(&SmartPointer<MakeGeometry<T, D>>::template New<>))
597 .def(py::init(&SmartPointer<MakeGeometry<T, D>>::template New<
598 SmartPointer<Domain<T, D>> &>))
599 .def(
600 py::init(&SmartPointer<MakeGeometry<T, D>>::template New<
601 SmartPointer<Domain<T, D>> &, SmartPointer<Sphere<T, D>> &>))
602 .def(py::init(&SmartPointer<MakeGeometry<T, D>>::template New<
603 SmartPointer<Domain<T, D>> &, SmartPointer<Plane<T, D>> &>))
604 .def(py::init(&SmartPointer<MakeGeometry<T, D>>::template New<
605 SmartPointer<Domain<T, D>> &, SmartPointer<Box<T, D>> &>))
606 .def(py::init(
607 &SmartPointer<MakeGeometry<T, D>>::template New<
608 SmartPointer<Domain<T, D>> &, SmartPointer<Cylinder<T, D>> &>))
609 .def(py::init(
610 &SmartPointer<MakeGeometry<T, D>>::template New<
611 SmartPointer<Domain<T, D>> &, SmartPointer<PointCloud<T, D>> &>))
612 // methods
613 .def("setLevelSet", &MakeGeometry<T, D>::setLevelSet,
614 "Set the levelset in which to create the geometry.")
615 .def("setGeometry",
616 (void(MakeGeometry<T, D>::*)(SmartPointer<Sphere<T, D>>)) &
618 .def("setGeometry",
619 (void(MakeGeometry<T, D>::*)(SmartPointer<Plane<T, D>>)) &
621 .def("setGeometry",
622 (void(MakeGeometry<T, D>::*)(SmartPointer<Box<T, D>>)) &
624 .def("setGeometry",
625 (void(MakeGeometry<T, D>::*)(SmartPointer<Cylinder<T, D>>)) &
627 .def("setGeometry",
628 (void(MakeGeometry<T, D>::*)(SmartPointer<PointCloud<T, D>>)) &
630 .def("setIgnoreBoundaryConditions",
631 (void(MakeGeometry<T, D>::*)(bool)) &
633 .def("setIgnoreBoundaryConditions",
634 (void(MakeGeometry<T, D>::*)(std::array<bool, 3>)) &
636 .def("apply", &MakeGeometry<T, D>::apply, "Generate the geometry.");
637
638 // MarkVoidPoints
639 py::class_<MarkVoidPoints<T, D>, SmartPointer<MarkVoidPoints<T, D>>>(
640 module, "MarkVoidPoints")
641 // constructors
642 .def(py::init(&SmartPointer<MarkVoidPoints<T, D>>::template New<>))
643 .def(py::init(&SmartPointer<MarkVoidPoints<T, D>>::template New<
644 SmartPointer<Domain<T, D>> &>))
645 .def(py::init(&SmartPointer<MarkVoidPoints<T, D>>::template New<
646 SmartPointer<Domain<T, D>> &, bool &>))
647 // methods
648 .def("setLevelSet", &MarkVoidPoints<T, D>::setLevelSet,
649 "Set the levelset to mark void points in.")
650 .def("setReverseVoidDetection",
652 "Reverse the logic of detecting the top surface.")
653 .def("setDetectLargestSurface",
655 "Set that the top surface should be the one with the most connected "
656 "LS points.")
657 .def("setVoidTopSurface", &MarkVoidPoints<T, D>::setVoidTopSurface,
658 "Set the logic by which to choose the surface which is non-void. "
659 "All other connected surfaces will then be marked as void points.")
660 .def("setSaveComponentIds", &MarkVoidPoints<T, D>::setSaveComponentIds,
661 "Save the connectivity information of all LS points in the "
662 "pointData of the level set.")
663 .def("getNumberOfComponents",
665 "Get the number of connected components found in the level set.")
666 .def("apply", &MarkVoidPoints<T, D>::apply, "Mark void points.");
667
668 // Prune
669 py::class_<Prune<T, D>, SmartPointer<Prune<T, D>>>(module, "Prune")
670 // constructors
671 .def(py::init(&SmartPointer<Prune<T, D>>::template New<>))
672 .def(py::init(&SmartPointer<Prune<T, D>>::template New<
673 SmartPointer<Domain<T, D>> &>))
674 // methods
675 .def("setLevelSet", &Prune<T, D>::setLevelSet, "Set levelset to prune.")
676 .def("apply", &Prune<T, D>::apply, "Perform pruning operation.");
677
678 // Reader
679 py::class_<Reader<T, D>, SmartPointer<Reader<T, D>>>(module, "Reader")
680 // constructors
681 .def(py::init(&SmartPointer<Reader<T, D>>::template New<>))
682 .def(py::init(&SmartPointer<Reader<T, D>>::template New<
683 SmartPointer<Domain<T, D>> &>))
684 .def(py::init(&SmartPointer<Reader<T, D>>::template New<
685 SmartPointer<Domain<T, D>> &, std::string>))
686 // methods
687 .def("setLevelSet", &Reader<T, D>::setLevelSet,
688 "Set levelset to write to file.")
689 .def("setFileName", &Reader<T, D>::setFileName,
690 "Set the filename for the output file.")
691 .def("apply", &Reader<T, D>::apply, "Write to file.");
692
693 // Reduce
694 py::class_<Reduce<T, D>, SmartPointer<Reduce<T, D>>>(module, "Reduce")
695 // constructors
696 .def(py::init(&SmartPointer<Reduce<T, D>>::template New<>))
697 .def(py::init(&SmartPointer<Reduce<T, D>>::template New<
698 SmartPointer<Domain<T, D>> &>))
699 .def(py::init(&SmartPointer<Reduce<T, D>>::template New<
700 SmartPointer<Domain<T, D>> &, int>))
701 .def(py::init(&SmartPointer<Reduce<T, D>>::template New<
702 SmartPointer<Domain<T, D>> &, int, bool>))
703 // methods
704 .def("setLevelSet", &Reduce<T, D>::setLevelSet, "Set levelset to reduce.")
705 .def("setWidth", &Reduce<T, D>::setWidth, "Set the width to reduce to.")
706 .def("setNoNewSegment", &Reduce<T, D>::setNoNewSegment,
707 "Set whether the levelset should be segmented anew (balanced across "
708 "cores) after reduction.")
709 .def("apply", &Reduce<T, D>::apply, "Perform reduction.");
710
711 // RemoveStrayPoints
712 py::class_<RemoveStrayPoints<T, D>, SmartPointer<RemoveStrayPoints<T, D>>>(
713 module, "RemoveStrayPoints")
714 // constructors
715 .def(py::init(&SmartPointer<RemoveStrayPoints<T, D>>::template New<>))
716 .def(py::init(&SmartPointer<RemoveStrayPoints<T, D>>::template New<
717 SmartPointer<Domain<T, D>> &>))
718 // methods
719 .def("setLevelSet", &RemoveStrayPoints<T, D>::setLevelSet,
720 "Set levelset for stray point removal.")
721 .def("setVoidTopSurface", &RemoveStrayPoints<T, D>::setVoidTopSurface,
722 "Set the logic by which to choose the surface which should be kept. "
723 "All other LS values will be marked as stray points and removed.")
724 .def("apply", &RemoveStrayPoints<T, D>::apply, "Remove stray points.");
725
726 // ToDiskMesh
727 py::class_<ToDiskMesh<T, D>, SmartPointer<ToDiskMesh<T, D>>>(module,
728 "ToDiskMesh")
729 // constructors
730 .def(py::init(&SmartPointer<ToDiskMesh<T, D>>::template New<>))
731 .def(py::init(&SmartPointer<ToDiskMesh<T, D>>::template New<
732 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &>))
733 // methods
734 .def("setLevelSet", &ToDiskMesh<T, D>::setLevelSet,
735 "Set levelset to mesh.")
736 .def("clearLevelSets", &ToDiskMesh<T, D>::clearLevelSets,
737 "Clear all inserted level sets.")
738 .def("insertNextLevelSet", &ToDiskMesh<T, D>::insertNextLevelSet,
739 "Insert next level set to output in the disk mesh.")
740 .def("setMesh", &ToDiskMesh<T, D>::setMesh, "Set the mesh to generate.")
741 .def("setMaterialMap", &ToDiskMesh<T, D>::setMaterialMap,
742 "Set the material map to use for the disk mesh.")
743 .def("setMaxValue", &ToDiskMesh<T, D>::setMaxValue,
744 "Set the maximum level set value to include in the disk mesh.")
745 .def("apply", &ToDiskMesh<T, D>::apply,
746 "Convert the levelset to a surface mesh.");
747
748 // ToMesh
749 py::class_<ToMesh<T, D>, SmartPointer<ToMesh<T, D>>>(module, "ToMesh")
750 // constructors
751 .def(py::init(&SmartPointer<ToMesh<T, D>>::template New<>))
752 .def(py::init(&SmartPointer<ToMesh<T, D>>::template New<
753 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &>))
754 .def(py::init(
755 &SmartPointer<ToMesh<T, D>>::template New<
756 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &, bool>))
757 .def(py::init(&SmartPointer<ToMesh<T, D>>::template New<
758 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &, bool,
759 bool>))
760 // methods
761 .def("setLevelSet", &ToMesh<T, D>::setLevelSet, "Set levelset to mesh.")
762 .def("setMesh", &ToMesh<T, D>::setMesh, "Set the mesh to generate.")
763 .def("setOnlyDefined", &ToMesh<T, D>::setOnlyDefined,
764 "Set whether only defined points should be output to the mesh.")
765 .def("setOnlyActive", &ToMesh<T, D>::setOnlyActive,
766 "Set whether only level set points <0.5 should be output.")
767 .def("apply", &ToMesh<T, D>::apply,
768 "Convert the levelset to a surface mesh.");
769
770 // ToSurfaceMesh
771 py::class_<ToSurfaceMesh<T, D>, SmartPointer<ToSurfaceMesh<T, D>>>(
772 module, "ToSurfaceMesh")
773 // constructors
774 .def(
775 py::init(
776 &SmartPointer<ToSurfaceMesh<T, D>>::template New<double, double>),
777 py::arg("minNodeDistFactor") = 0.05, py::arg("eps") = 1e-12)
778 .def(py::init(&SmartPointer<ToSurfaceMesh<T, D>>::template New<
779 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &,
780 double, double>),
781 py::arg("domain"), py::arg("mesh"),
782 py::arg("minNodeDistFactor") = 0.05, py::arg("eps") = 1e-12)
783 // methods
784 .def("setLevelSet", &ToSurfaceMesh<T, D>::setLevelSet,
785 "Set levelset to mesh.")
786 .def("setMesh", &ToSurfaceMesh<T, D>::setMesh,
787 "Set the mesh to generate.")
788 .def("setUpdatePointData", &ToSurfaceMesh<T, D>::setUpdatePointData,
789 "Set whether to update point data. Defaults to true.")
790 .def("setSharpCorners", &ToSurfaceMesh<T, D>::setSharpCorners,
791 "Set whether to preserve sharp corners. Defaults to false.")
792 .def("apply", &ToSurfaceMesh<T, D>::apply,
793 "Convert the levelset to a surface mesh.");
794
795 // ToMultiSurfaceMesh
796 py::class_<ToMultiSurfaceMesh<T, D>, SmartPointer<ToMultiSurfaceMesh<T, D>>>(
797 module, "ToMultiSurfaceMesh")
798 // constructors
799 .def(py::init(
800 &SmartPointer<ToMultiSurfaceMesh<T, D>>::template New<double,
801 double>),
802 py::arg("minNodeDistFactor") = 0.05, py::arg("eps") = 1e-12)
803 .def(py::init(&SmartPointer<ToMultiSurfaceMesh<T, D>>::template New<
804 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &,
805 double, double>),
806 py::arg("domain"), py::arg("mesh"),
807 py::arg("minNodeDistFactor") = 0.05, py::arg("eps") = 1e-12)
808 .def(py::init(&SmartPointer<ToMultiSurfaceMesh<T, D>>::template New<
809 std::vector<SmartPointer<Domain<T, D>>> &,
810 SmartPointer<Mesh<T>> &, double, double>),
811 py::arg("domains"), py::arg("mesh"),
812 py::arg("minNodeDistFactor") = 0.05, py::arg("eps") = 1e-12)
813 .def(py::init(&SmartPointer<ToMultiSurfaceMesh<T, D>>::template New<
814 SmartPointer<Mesh<T>> &, double, double>),
815 py::arg("mesh"), py::arg("minNodeDistFactor") = 0.05,
816 py::arg("eps") = 1e-12)
817 // methods
818 .def("insertNextLevelSet", &ToMultiSurfaceMesh<T, D>::insertNextLevelSet,
819 "Insert next level set to output in the mesh.")
820 .def("clearLevelSets", &ToMultiSurfaceMesh<T, D>::clearLevelSets,
821 "Clear all inserted level sets.")
822 .def("setMesh", &ToMultiSurfaceMesh<T, D>::setMesh,
823 "Set the mesh to generate.")
824 .def("setMaterialMap", &ToMultiSurfaceMesh<T, D>::setMaterialMap,
825 "Set the material map to use for the multi surface mesh.")
826 .def("setSharpCorners", &ToMultiSurfaceMesh<T, D>::setSharpCorners,
827 "Set whether to preserve sharp corners. Defaults to false.")
828 .def("apply", &ToMultiSurfaceMesh<T, D>::apply,
829 "Convert the levelset to a surface mesh.");
830
831 // ToVoxelMesh
832 py::class_<ToVoxelMesh<T, D>, SmartPointer<ToVoxelMesh<T, D>>>(module,
833 "ToVoxelMesh")
834 // constructors
835 .def(py::init(&SmartPointer<ToVoxelMesh<T, D>>::template New<>))
836 .def(py::init(&SmartPointer<ToVoxelMesh<T, D>>::template New<
837 SmartPointer<Mesh<T>> &>))
838 .def(py::init(&SmartPointer<ToVoxelMesh<T, D>>::template New<
839 SmartPointer<Domain<T, D>> &, SmartPointer<Mesh<T>> &>))
840 .def(py::init(&SmartPointer<ToVoxelMesh<T, D>>::template New<
841 std::vector<SmartPointer<Domain<T, D>>> &,
842 SmartPointer<Mesh<T>> &>))
843 // methods
844 .def("insertNextLevelSet", &ToVoxelMesh<T, D>::insertNextLevelSet,
845 "Insert next level set to output in the mesh.")
846 .def("clearLevelSets", &ToVoxelMesh<T, D>::clearLevelSets,
847 "Clear all inserted level sets.")
848 .def("setMesh", &ToVoxelMesh<T, D>::setMesh, "Set the mesh to generate.")
849 .def("apply", &ToVoxelMesh<T, D>::apply,
850 "Convert the levelset to a surface mesh.");
851
852 // Writer
853 py::class_<Writer<T, D>, SmartPointer<Writer<T, D>>>(module, "Writer")
854 // constructors
855 .def(py::init(&SmartPointer<Writer<T, D>>::template New<>))
856 .def(py::init(&SmartPointer<Writer<T, D>>::template New<
857 SmartPointer<Domain<T, D>> &>))
858 .def(py::init(&SmartPointer<Writer<T, D>>::template New<
859 SmartPointer<Domain<T, D>> &, std::string>))
860 // methods
861 .def("setLevelSet", &Writer<T, D>::setLevelSet,
862 "Set levelset to write to file.")
863 .def("setFileName", &Writer<T, D>::setFileName,
864 "Set the filename for the output file.")
865 .def("apply", &Writer<T, D>::apply, "Write to file.");
866
867 // CompareSparseField
868 py::class_<CompareSparseField<T, D>, SmartPointer<CompareSparseField<T, D>>>(
869 module, "CompareSparseField")
870 // constructors
871 .def(py::init(&SmartPointer<CompareSparseField<T, D>>::template New<>))
872 .def(
873 py::init(&SmartPointer<CompareSparseField<T, D>>::template New<
874 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
875 // methods
876 .def("setLevelSetExpanded",
878 "Sets the expanded level set for comparison.")
879 .def("setLevelSetIterated",
881 "Sets the iterated level set to compare against the expanded one.")
882 .def("setXRange", &CompareSparseField<T, D>::setXRange,
883 "Set the x-coordinate range to restrict the comparison area")
884 .def("setYRange", &CompareSparseField<T, D>::setYRange,
885 "Set the y-coordinate range to restrict the comparison area")
886 .def("clearXRange", &CompareSparseField<T, D>::clearXRange,
887 "Clear the x-range restriction")
888 .def("clearYRange", &CompareSparseField<T, D>::clearYRange,
889 "Clear the y-range restriction")
890 .def("setZRange", &CompareSparseField<T, D>::setZRange,
891 "Set the z-coordinate range to restrict the comparison area")
892 .def("clearZRange", &CompareSparseField<T, D>::clearZRange,
893 "Clear the z-range restriction")
894 .def("setOutputMesh", &CompareSparseField<T, D>::setOutputMesh,
895 "Set the output mesh where difference values will be stored")
896 .def("setFillIteratedWithDistances",
898 "Set whether to fill the iterated level set with distance values")
899 .def("setExpandedLevelSetWidth",
901 "Set the expansion width for the expanded level set")
902 .def("apply", &CompareSparseField<T, D>::apply,
903 "Apply the comparison and calculate the sum of squared "
904 "differences.")
905 .def("getSumSquaredDifferences",
907 "Return the sum of squared differences calculated by apply().")
908 .def("getSumDifferences", &CompareSparseField<T, D>::getSumDifferences,
909 "Return the sum of absolute differences calculated by apply().")
910 .def("getNumPoints", &CompareSparseField<T, D>::getNumPoints,
911 "Return the number of points used in the comparison.")
912 .def("getNumSkippedPoints",
914 "Return the number of points skipped during comparison.")
915 .def("getRMSE", &CompareSparseField<T, D>::getRMSE,
916 "Calculate the root mean square error from previously computed "
917 "values.");
918
919// WriteVisualizationMesh
920#ifdef VIENNALS_USE_VTK
921 py::class_<WriteVisualizationMesh<T, D>,
922 SmartPointer<WriteVisualizationMesh<T, D>>>(
923 module, "WriteVisualizationMesh")
924 // constructors
925 .def(
926 py::init(&SmartPointer<WriteVisualizationMesh<T, D>>::template New<>))
927 .def(py::init(&SmartPointer<WriteVisualizationMesh<T, D>>::template New<
928 SmartPointer<Domain<T, D>> &>))
929 // methods
930 .def("insertNextLevelSet",
931 &WriteVisualizationMesh<T, D>::insertNextLevelSet,
932 "Insert next level set to convert. Bigger level sets wrapping "
933 "smaller ones, should be inserted last.")
934 .def("setFileName", &WriteVisualizationMesh<T, D>::setFileName,
935 "Set Name of File to write.")
936 .def("setExtractHullMesh",
937 &WriteVisualizationMesh<T, D>::setExtractHullMesh,
938 "Whether to extract a hull mesh. Defaults to false.")
939 .def("setExtractVolumeMesh",
940 &WriteVisualizationMesh<T, D>::setExtractVolumeMesh,
941 " Whether to extract a tetra volume mesh. Defaults to true.")
942 .def("setMetaData", &WriteVisualizationMesh<T, D>::setMetaData,
943 "Set the metadata to be written to the file.")
944 .def("addMetaData",
945 py::overload_cast<const std::string &, T>(
946 &WriteVisualizationMesh<T, D>::addMetaData),
947 "Add a single metadata entry to the file.")
948 .def("addMetaData",
949 py::overload_cast<const std::string &, const std::vector<T> &>(
950 &WriteVisualizationMesh<T, D>::addMetaData),
951 "Add a single metadata entry to the file.")
952 .def("addMetaData",
953 py::overload_cast<
954 const std::unordered_map<std::string, std::vector<T>> &>(
955 &WriteVisualizationMesh<T, D>::addMetaData),
956 "Add metadata to the file.")
957 .def("apply", &WriteVisualizationMesh<T, D>::apply,
958 "Make and write mesh.");
959#endif
960
961 // CompareVolume
962 py::class_<CompareVolume<T, D>, SmartPointer<CompareVolume<T, D>>>(
963 module, "CompareVolume")
964 // constructors
965 .def(py::init(&SmartPointer<CompareVolume<T, D>>::template New<>))
966 .def(
967 py::init(&SmartPointer<CompareVolume<T, D>>::template New<
968 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
969 // methods
970 .def("setLevelSetTarget", &CompareVolume<T, D>::setLevelSetTarget,
971 "Sets the target level set.")
972 .def("setLevelSetSample", &CompareVolume<T, D>::setLevelSetSample,
973 "Sets the sample level set.")
974 .def("setDefaultIncrement", &CompareVolume<T, D>::setDefaultIncrement,
975 "Set default increment value")
976 .def("setXRangeAndIncrement", &CompareVolume<T, D>::setXRangeAndIncrement,
977 "Sets the x-range and custom increment value")
978 .def("setYRangeAndIncrement", &CompareVolume<T, D>::setYRangeAndIncrement,
979 "Sets the y-range and custom increment value")
980 .def("setZRangeAndIncrement", &CompareVolume<T, D>::setZRangeAndIncrement,
981 "Sets the z-range and custom increment value")
982 .def("setOutputMesh", &CompareVolume<T, D>::setOutputMesh,
983 "Set the output mesh where difference areas will be stored")
984 .def("getVolumeMismatch", &CompareVolume<T, D>::getVolumeMismatch,
985 "Returns the computed volume mismatch.")
986 .def("getAreaMismatch", &CompareVolume<T, D>::getAreaMismatch,
987 "Returns the computed area mismatch.")
988 .def("getCustomVolumeMismatch",
990 "Returns the computed volume mismatch, with custom increments "
991 "applied.")
992 .def("getCustomAreaMismatch", &CompareVolume<T, D>::getCustomAreaMismatch,
993 "Returns the computed area mismatch, with custom increments "
994 "applied.")
995 .def("getCellCount", &CompareVolume<T, D>::getCellCount,
996 "Returns the number of cells where the level sets differ.")
997 .def("getCustomCellCount", &CompareVolume<T, D>::getCustomCellCount,
998 "Returns the number of cells where the level sets differ, with "
999 "custom increments applied.")
1000 .def("apply", &CompareVolume<T, D>::apply,
1001 "Computes the volume difference between the two level sets.");
1002
1003 if constexpr (D == 2) {
1004 module.attr("CompareArea") = module.attr("CompareVolume");
1005 }
1006
1007 // CompareChamfer
1008 py::class_<CompareChamfer<T, D>, SmartPointer<CompareChamfer<T, D>>>(
1009 module, "CompareChamfer")
1010 // constructors
1011 .def(py::init(&SmartPointer<CompareChamfer<T, D>>::template New<>))
1012 .def(
1013 py::init(&SmartPointer<CompareChamfer<T, D>>::template New<
1014 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
1015 // methods
1016 .def("setLevelSetTarget", &CompareChamfer<T, D>::setLevelSetTarget,
1017 "Set the target level set.")
1018 .def("setLevelSetSample", &CompareChamfer<T, D>::setLevelSetSample,
1019 "Set the sample level set.")
1020 .def("setOutputMeshTarget", &CompareChamfer<T, D>::setOutputMeshTarget,
1021 "Set output mesh for target surface points with distance data.")
1022 .def("setOutputMeshSample", &CompareChamfer<T, D>::setOutputMeshSample,
1023 "Set output mesh for sample surface points with distance data.")
1024 .def("apply", &CompareChamfer<T, D>::apply,
1025 "Apply the Chamfer distance calculation.")
1026 .def("getForwardDistance", &CompareChamfer<T, D>::getForwardDistance,
1027 "Get the forward distance (average distance from target to "
1028 "sample).")
1029 .def("getBackwardDistance", &CompareChamfer<T, D>::getBackwardDistance,
1030 "Get the backward distance (average distance from sample to "
1031 "target).")
1032 .def("getChamferDistance", &CompareChamfer<T, D>::getChamferDistance,
1033 "Get the Chamfer distance (average of forward and backward).")
1034 .def("getRMSChamferDistance",
1036 "Get the RMS Chamfer distance.")
1037 .def("getMaxDistance", &CompareChamfer<T, D>::getMaxDistance,
1038 "Get the maximum nearest-neighbor distance.")
1039 .def("getNumTargetPoints", &CompareChamfer<T, D>::getNumTargetPoints,
1040 "Get the number of target surface points.")
1041 .def("getNumSamplePoints", &CompareChamfer<T, D>::getNumSamplePoints,
1042 "Get the number of sample surface points.");
1043
1044 // CompareCriticalDimensions
1045 py::class_<CompareCriticalDimensions<T, D>,
1046 SmartPointer<CompareCriticalDimensions<T, D>>>(
1047 module, "CompareCriticalDimensions")
1048 // constructors
1049 .def(py::init(
1050 &SmartPointer<CompareCriticalDimensions<T, D>>::template New<>))
1051 .def(
1052 py::init(&SmartPointer<CompareCriticalDimensions<T, D>>::template New<
1053 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
1054 // methods
1055 .def("setLevelSetTarget",
1057 "Sets the target level set.")
1058 .def("setLevelSetSample",
1060 "Sets the sample level set.")
1062 py::arg("measureDimension"), py::arg("minBounds"),
1063 py::arg("maxBounds"), py::arg("findMaximum") = true,
1064 "Add a generic range specification.")
1066 py::arg("minX"), py::arg("maxX"), py::arg("findMaximum") = true,
1067 "Add an X range to find maximum or minimum Y position.")
1069 py::arg("minY"), py::arg("maxY"), py::arg("findMaximum") = true,
1070 "Add a Y range to find maximum or minimum X position.")
1072 "Clear all range specifications.")
1074 "Set the output mesh where critical dimension locations will be "
1075 "stored.")
1077 "Apply the comparison.")
1078 .def("getNumCriticalDimensions",
1080 "Get the number of critical dimensions compared.")
1081 .def(
1082 "getCriticalDimensionResult",
1083 [](CompareCriticalDimensions<T, D> &self, size_t index) -> py::tuple {
1084 T posRef{}, posCmp{}, diff{};
1085 bool valid =
1086 self.getCriticalDimensionResult(index, posRef, posCmp, diff);
1087 if (valid)
1088 return py::make_tuple(true, posRef, posCmp, diff);
1089 return py::make_tuple(false, T(0), T(0), T(0));
1090 },
1091 py::arg("index"),
1092 "Get a specific critical dimension result. Returns (valid, "
1093 "positionTarget, positionSample, difference).")
1094 .def("getMeanDifference",
1096 "Get mean absolute difference across all valid critical "
1097 "dimensions.")
1098 .def("getMaxDifference",
1100 "Get maximum difference across all valid critical dimensions.")
1102 "Get RMSE across all valid critical dimensions.")
1103 .def("getAllDifferences",
1105 "Get all valid differences as a list.");
1106
1107 // CompareNarrowBand
1108 py::class_<CompareNarrowBand<T, D>, SmartPointer<CompareNarrowBand<T, D>>>(
1109 module, "CompareNarrowBand")
1110 // constructors
1111 .def(py::init(&SmartPointer<CompareNarrowBand<T, D>>::template New<>))
1112 .def(
1113 py::init(&SmartPointer<CompareNarrowBand<T, D>>::template New<
1114 SmartPointer<Domain<T, D>> &, SmartPointer<Domain<T, D>> &>))
1115 // methods
1116 .def("setLevelSetTarget", &CompareNarrowBand<T, D>::setLevelSetTarget,
1117 "Sets the target level set.")
1118 .def("setLevelSetSample", &CompareNarrowBand<T, D>::setLevelSetSample,
1119 "Sets the sample level set.")
1120 .def("setXRange", &CompareNarrowBand<T, D>::setXRange,
1121 "Set the x-coordinate range to restrict the comparison area")
1122 .def("setYRange", &CompareNarrowBand<T, D>::setYRange,
1123 "Set the y-coordinate range to restrict the comparison area")
1124 .def("clearXRange", &CompareNarrowBand<T, D>::clearXRange,
1125 "Clear the x-range restriction")
1126 .def("clearYRange", &CompareNarrowBand<T, D>::clearYRange,
1127 "Clear the y-range restriction")
1128 .def("setZRange", &CompareNarrowBand<T, D>::setZRange,
1129 "Set the z-coordinate range to restrict the comparison area")
1130 .def("clearZRange", &CompareNarrowBand<T, D>::clearZRange,
1131 "Clear the z-range restriction")
1132 .def("setOutputMesh", &CompareNarrowBand<T, D>::setOutputMesh,
1133 "Set the output mesh where difference values will be stored")
1134 .def("setOutputMeshSquaredDifferences",
1136 "Set whether to output squared differences (true) or absolute "
1137 "differences (false)")
1138 .def("apply", &CompareNarrowBand<T, D>::apply,
1139 "Apply the comparison and calculate the sum of squared "
1140 "differences.")
1141 .def("getSumSquaredDifferences",
1143 "Return the sum of squared differences calculated by apply().")
1144 .def("getSumDifferences", &CompareNarrowBand<T, D>::getSumDifferences,
1145 "Return the sum of absolute differences calculated by apply().")
1146 .def("getNumPoints", &CompareNarrowBand<T, D>::getNumPoints,
1147 "Return the number of points used in the comparison.")
1148 .def("getRMSE", &CompareNarrowBand<T, D>::getRMSE,
1149 "Calculate the root mean square error from previously computed "
1150 "values.");
1151}
constexpr int D
Definition Epitaxy.cpp:11
double T
Definition Epitaxy.cpp:12
Definition pyWrap.hpp:68
T getSignedDistance(const vectorType &initial, const vectorType &candidate, unsigned long initialPointId) const override
Definition pyWrap.hpp:80
bool isInside(const vectorType &initial, const vectorType &candidate, double eps=0.) const override
Definition pyWrap.hpp:75
boundsType getBounds() const override
Sets bounds to the bounding box of the distribution.
Definition pyWrap.hpp:86
Stencil Local Lax Friedrichs Discretization Scheme. It uses a stencil of order around active points,...
Definition lsStencilLocalLaxFriedrichsScalar.hpp:33
This class is used to advance level sets over time. Level sets are passed to the constructor in a std...
Definition lsAdvect.hpp:54
void setVelocityField(SmartPointer< VelocityField< T > > passedVelocities)
Set the velocity field used for advection. This should be a concrete implementation of lsVelocityFiel...
Definition lsAdvect.hpp:863
void insertNextLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Pushes the passed level set to the back of the list of level sets used for advection.
Definition lsAdvect.hpp:855
void setVelocityUpdateCallback(std::function< bool(SmartPointer< Domain< T, D > >)> callback)
Set a callback function that is called after the level set has been updated during intermediate time ...
Definition lsAdvect.hpp:965
void setUpdatePointData(bool update)
Set whether the point data in the old LS should be translated to the advected LS. Defaults to true.
Definition lsAdvect.hpp:961
void setSpatialScheme(SpatialSchemeEnum scheme)
Set which spatial discretization scheme should be used out of the ones specified in SpatialSchemeEnum...
Definition lsAdvect.hpp:935
bool getCalculateNormalVectors() const
Get whether normal vectors were calculated.
Definition lsAdvect.hpp:931
void setIgnoreVoids(bool iV)
Set whether level set values, which are not part of the "top" geometrically connected part of values,...
Definition lsAdvect.hpp:898
void clearLevelSets()
Definition lsAdvect.hpp:859
void setCalculateNormalVectors(bool cnv)
Set whether normal vectors should be calculated at each level set point. Defaults to true....
Definition lsAdvect.hpp:890
void apply()
Definition lsAdvect.hpp:1016
void setSingleStep(bool singleStep)
If set to true, only a single advection step will be performed, even if the advection time set with s...
Definition lsAdvect.hpp:878
void prepareLS()
Definition lsAdvect.hpp:972
double getAdvectedTime() const
Get by how much the physical time was advanced during the last apply() call.
Definition lsAdvect.hpp:919
void setTemporalScheme(TemporalSchemeEnum scheme)
Set which time integration scheme should be used.
Definition lsAdvect.hpp:948
void setDissipationAlpha(const double &a)
Set the alpha dissipation coefficient. For lsLaxFriedrichs, this is used as the alpha value....
Definition lsAdvect.hpp:954
void setCheckDissipation(bool check)
Definition lsAdvect.hpp:957
void setIntegrationScheme(IntegrationSchemeEnum scheme)
Definition lsAdvect.hpp:940
double getCurrentTimeStep() const
Return the last applied time step.
Definition lsAdvect.hpp:922
void setAdvectionTime(double time)
Set the time until when the level set should be advected. If this takes more than one advection step,...
Definition lsAdvect.hpp:872
unsigned getNumberOfTimeSteps() const
Get how many advection steps were performed during the last apply() call.
Definition lsAdvect.hpp:925
void setAdaptiveTimeStepping(bool aTS=true, unsigned subdivisions=20)
Set whether adaptive time stepping should be used when approaching material boundaries during etching...
Definition lsAdvect.hpp:903
void setTimeStepRatio(const double &cfl)
Set the CFL condition to use during advection. The CFL condition sets the maximum distance a surface ...
Definition lsAdvect.hpp:884
double getTimeStepRatio() const
Get the value of the CFL number.
Definition lsAdvect.hpp:928
void setSaveAdvectionVelocities(bool sAV)
Set whether the velocities applied to each point should be saved in the level set for debug purposes.
Definition lsAdvect.hpp:915
This class is used to perform boolean operations on two level sets and write the resulting level set ...
Definition lsBooleanOperation.hpp:45
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Set which level set to perform the boolean operation on.
Definition lsBooleanOperation.hpp:290
void setSecondLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Set the level set which will be used to modify the first level set.
Definition lsBooleanOperation.hpp:296
void setBooleanOperation(BooleanOperationEnum passedOperation)
Set which of the operations of BooleanOperationEnum to perform.
Definition lsBooleanOperation.hpp:301
void apply()
Perform operation.
Definition lsBooleanOperation.hpp:319
Concrete implementation of GeometricAdvectDistribution for a rectangular box distribution.
Definition lsGeometricAdvectDistributions.hpp:129
bool isInside(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, double eps) const override
Quick check whether a point relative to the distributions center is inside the distribution....
Definition lsGeometricAdvectDistributions.hpp:136
std::array< viennahrle::CoordType, 6 > getBounds() const override
Sets bounds to the bounding box of the distribution.
Definition lsGeometricAdvectDistributions.hpp:159
T getSignedDistance(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, unsigned long) const override
Returns the signed distance of a point relative to the distributions center. This is the signed manha...
Definition lsGeometricAdvectDistributions.hpp:148
Class describing a square box from one coordinate to another.
Definition lsGeometries.hpp:71
Definition lsCalculateCurvatures.hpp:24
void setCurvatureType(CurvatureEnum passedType)
Definition lsCalculateCurvatures.hpp:46
void setMaxValue(const T passedMaxValue)
Definition lsCalculateCurvatures.hpp:59
void apply()
Definition lsCalculateCurvatures.hpp:61
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCalculateCurvatures.hpp:42
This algorithm is used to compute the normal vectors for all points with level set values <= maxValue...
Definition lsCalculateNormalVectors.hpp:40
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCalculateNormalVectors.hpp:63
void apply()
Definition lsCalculateNormalVectors.hpp:95
void setMethod(NormalCalculationMethodEnum passedMethod)
Definition lsCalculateNormalVectors.hpp:79
void setMaxValue(const T passedMaxValue)
Definition lsCalculateNormalVectors.hpp:67
Definition lsCalculateVisibilities.hpp:10
void apply()
Definition lsCalculateVisibilities.hpp:25
This class is used to find errors in the underlying level set structure, like invalid neighbours of d...
Definition lsCheck.hpp:22
void apply()
Definition lsCheck.hpp:78
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCheck.hpp:66
Calculate Chamfer distance between two level sets by comparing their zero-level-set surfaces....
Definition lsCompareChamfer.hpp:39
unsigned getNumSamplePoints() const
Get the number of sample surface points.
Definition lsCompareChamfer.hpp:329
void apply()
Apply the Chamfer distance calculation.
Definition lsCompareChamfer.hpp:104
T getMaxDistance() const
Get the maximum nearest-neighbor distance.
Definition lsCompareChamfer.hpp:323
T getBackwardDistance() const
Get the backward distance (average distance from sample to target).
Definition lsCompareChamfer.hpp:314
void setOutputMeshSample(SmartPointer< Mesh< T > > passedMesh)
Set output mesh for sample surface points with distance data.
Definition lsCompareChamfer.hpp:99
T getRMSChamferDistance() const
Get the RMS Chamfer distance.
Definition lsCompareChamfer.hpp:320
T getChamferDistance() const
Get the Chamfer distance (average of forward and backward).
Definition lsCompareChamfer.hpp:317
T getForwardDistance() const
Get the forward distance (average distance from target to sample).
Definition lsCompareChamfer.hpp:311
void setOutputMeshTarget(SmartPointer< Mesh< T > > passedMesh)
Set output mesh for target surface points with distance data.
Definition lsCompareChamfer.hpp:94
void setLevelSetTarget(SmartPointer< Domain< T, D > > passedLevelSet)
Set the target level set.
Definition lsCompareChamfer.hpp:84
unsigned getNumTargetPoints() const
Get the number of target surface points.
Definition lsCompareChamfer.hpp:326
void setLevelSetSample(SmartPointer< Domain< T, D > > passedLevelSet)
Set the sample level set.
Definition lsCompareChamfer.hpp:89
Compares critical dimensions (surface positions) between two level sets. Critical dimensions are defi...
Definition lsCompareCriticalDimensions.hpp:33
void apply()
Apply the comparison.
Definition lsCompareCriticalDimensions.hpp:197
std::vector< T > getAllDifferences() const
Get all valid results.
Definition lsCompareCriticalDimensions.hpp:309
void setOutputMesh(SmartPointer< Mesh< T > > passedMesh)
Set the output mesh where critical dimension locations will be stored.
Definition lsCompareCriticalDimensions.hpp:192
bool getCriticalDimensionResult(size_t index, T &positionTarget, T &positionSample, T &difference) const
Get a specific critical dimension result.
Definition lsCompareCriticalDimensions.hpp:259
size_t getNumCriticalDimensions() const
Get the number of critical dimensions compared.
Definition lsCompareCriticalDimensions.hpp:256
void addRange(int measureDimension, const std::array< T, D > &minBounds, const std::array< T, D > &maxBounds, bool findMaximum=true)
Add a generic range specification.
Definition lsCompareCriticalDimensions.hpp:154
void addYRange(T minY, T maxY, bool findMaximum=true)
Add a Y range to find maximum or minimum X position.
Definition lsCompareCriticalDimensions.hpp:177
void clearRanges()
Clear all range specifications.
Definition lsCompareCriticalDimensions.hpp:189
void setLevelSetTarget(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareCriticalDimensions.hpp:145
T getMeanDifference() const
Get mean absolute difference across all valid critical dimensions.
Definition lsCompareCriticalDimensions.hpp:271
T getMaxDifference() const
Get maximum difference across all valid critical dimensions.
Definition lsCompareCriticalDimensions.hpp:284
void addXRange(T minX, T maxX, bool findMaximum=true)
Add an X range to find maximum or minimum Y position.
Definition lsCompareCriticalDimensions.hpp:165
T getRMSE() const
Get RMSE across all valid critical dimensions.
Definition lsCompareCriticalDimensions.hpp:295
void setLevelSetSample(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareCriticalDimensions.hpp:149
Calculate distance measure between two level sets by comparing their SDF values on a narrow band....
Definition lsCompareNarrowBand.hpp:19
void setYRange(T minYRange, T maxYRange)
Set the y-coordinate range to restrict the comparison area.
Definition lsCompareNarrowBand.hpp:164
void setOutputMeshSquaredDifferences(bool value)
Set whether to output squared differences (true) or absolute differences (false).
Definition lsCompareNarrowBand.hpp:207
void setXRange(T minXRange, T maxXRange)
Set the x-coordinate range to restrict the comparison area.
Definition lsCompareNarrowBand.hpp:157
void setOutputMesh(SmartPointer< Mesh< T > > passedMesh, bool outputMeshSquaredDiffs=true)
Set the output mesh where difference values will be stored.
Definition lsCompareNarrowBand.hpp:199
void clearZRange()
Clear the z-range restriction.
Definition lsCompareNarrowBand.hpp:192
void setLevelSetTarget(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareNarrowBand.hpp:148
T getRMSE() const
Calculate the root mean square error from previously computed values.
Definition lsCompareNarrowBand.hpp:387
void setLevelSetSample(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareNarrowBand.hpp:152
unsigned getNumPoints() const
Return the number of points used in the comparison.
Definition lsCompareNarrowBand.hpp:384
void clearYRange()
Clear the y-range restriction.
Definition lsCompareNarrowBand.hpp:178
T getSumSquaredDifferences() const
Return the sum of squared differences calculated by apply().
Definition lsCompareNarrowBand.hpp:378
void apply()
Apply the comparison and calculate the sum of squared differences.
Definition lsCompareNarrowBand.hpp:212
void clearXRange()
Clear the x-range restriction.
Definition lsCompareNarrowBand.hpp:171
T getSumDifferences() const
Definition lsCompareNarrowBand.hpp:381
void setZRange(T minZRange, T maxZRange)
Set the z-coordinate range to restrict the comparison area.
Definition lsCompareNarrowBand.hpp:185
Calculate distance measure between two level sets by comparing their SDF values on a sparse field....
Definition lsCompareSparseField.hpp:34
unsigned getNumPoints() const
Return the number of points used in the comparison.
Definition lsCompareSparseField.hpp:398
T getRMSE() const
Calculate the root mean square error from previously computed values.
Definition lsCompareSparseField.hpp:404
void setXRange(T minXRange, T maxXRange)
Set the x-coordinate range to restrict the comparison area.
Definition lsCompareSparseField.hpp:155
void setExpandedLevelSetWidth(int width)
Set the expansion width for the expanded level set This value will be used if the expanded level set ...
Definition lsCompareSparseField.hpp:209
void setOutputMesh(SmartPointer< Mesh< T > > passedMesh)
Set the output mesh where difference values will be stored.
Definition lsCompareSparseField.hpp:197
void setLevelSetIterated(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareSparseField.hpp:150
unsigned getNumSkippedPoints() const
Return the number of skipped points during the comparison.
Definition lsCompareSparseField.hpp:401
void setYRange(T minYRange, T maxYRange)
Set the y-coordinate range to restrict the comparison area.
Definition lsCompareSparseField.hpp:162
void setLevelSetExpanded(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsCompareSparseField.hpp:146
void setFillIteratedWithDistances(bool fill)
Set whether to fill the iterated level set with distances.
Definition lsCompareSparseField.hpp:202
T getSumSquaredDifferences() const
Return the sum of squared differences calculated by apply().
Definition lsCompareSparseField.hpp:392
T getSumDifferences() const
Return the sum of differences calculated by apply().
Definition lsCompareSparseField.hpp:395
void clearZRange()
Clear the z-range restriction.
Definition lsCompareSparseField.hpp:190
void clearYRange()
Clear the y-range restriction.
Definition lsCompareSparseField.hpp:176
void apply()
Apply the comparison and calculate the sum of squared differences.
Definition lsCompareSparseField.hpp:220
void clearXRange()
Clear the x-range restriction.
Definition lsCompareSparseField.hpp:169
void setZRange(T minZRange, T maxZRange)
Set the z-coordinate range to restrict the comparison area.
Definition lsCompareSparseField.hpp:183
Computes an estimate of the volume/area where two level sets differ. The volume is calculated by iter...
Definition lsCompareVolume.hpp:25
void setOutputMesh(SmartPointer< Mesh< T > > passedMesh)
Set the output mesh where difference areas will be stored for visualization. Each cell in the mesh wi...
Definition lsCompareVolume.hpp:171
unsigned long int getCellCount() const
Returns the number of cells where the level sets differ.
Definition lsCompareVolume.hpp:193
void setXRangeAndIncrement(hrleIndexType minXRange, hrleIndexType maxXRange, unsigned short int Xincrement)
Sets the x-range and custom increment value.
Definition lsCompareVolume.hpp:141
void setLevelSetTarget(SmartPointer< Domain< T, D > > passedLevelSet)
Sets the target level set.
Definition lsCompareVolume.hpp:126
void apply()
Computes the volume/area difference between the two level sets.
Definition lsCompareVolume.hpp:202
double getAreaMismatch() const
Alias for getVolumeMismatch for 2D compatibility.
Definition lsCompareVolume.hpp:181
void setYRangeAndIncrement(hrleIndexType minYRange, hrleIndexType maxYRange, unsigned short int Yincrement)
Sets the y-range and custom increment value.
Definition lsCompareVolume.hpp:150
void setZRangeAndIncrement(hrleIndexType minZRange, hrleIndexType maxZRange, unsigned short int Zincrement)
Sets the z-range and custom increment value.
Definition lsCompareVolume.hpp:159
void setDefaultIncrement(unsigned short int increment)
Set default increment value.
Definition lsCompareVolume.hpp:136
double getCustomVolumeMismatch() const
Returns the computed volume/area mismatch, with custom increments applied.
Definition lsCompareVolume.hpp:184
unsigned long int getCustomCellCount() const
Returns the number of cells where the level sets differ, with custom increments applied.
Definition lsCompareVolume.hpp:197
double getVolumeMismatch() const
Returns the computed volume/area mismatch.
Definition lsCompareVolume.hpp:176
void setLevelSetSample(SmartPointer< Domain< T, D > > passedLevelSet)
Sets the sample level set.
Definition lsCompareVolume.hpp:131
double getCustomAreaMismatch() const
Alias for getCustomVolumeMismatch for 2D compatibility.
Definition lsCompareVolume.hpp:190
This algorithm creates a convex hull mesh from a point cloud. This is done using the gift wrapping ap...
Definition lsConvexHull.hpp:23
void apply()
Definition lsConvexHull.hpp:332
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsConvexHull.hpp:326
void setPointCloud(SmartPointer< PointCloud< T, D > > passedPointCloud)
Definition lsConvexHull.hpp:328
Definition lsGeometricAdvectDistributions.hpp:185
T getSignedDistance(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, unsigned long pointId) const override
Returns the signed distance of a point relative to the distributions center. This is the signed manha...
Definition lsGeometricAdvectDistributions.hpp:198
std::array< viennahrle::CoordType, 6 > getBounds() const override
Sets bounds to the bounding box of the distribution.
Definition lsGeometricAdvectDistributions.hpp:242
Class describing a square box from one coordinate to another.
Definition lsGeometries.hpp:100
This class detects features of the level set function. This class offers two methods to determine fea...
Definition lsDetectFeatures.hpp:26
void apply()
Execute the algorithm.
Definition lsDetectFeatures.hpp:64
void setDetectionThreshold(T threshold)
Definition lsDetectFeatures.hpp:51
void setDetectionMethod(FeatureDetectionEnum passedMethod)
Set which algorithm to use to detect features. The curvature-based algorithm should always be preferr...
Definition lsDetectFeatures.hpp:59
Class containing all information about the level set, including the dimensions of the domain,...
Definition lsDomain.hpp:28
void clearMetaData()
Definition lsDomain.hpp:164
void deepCopy(const SmartPointer< Domain< T, D > > passedDomain)
copy all values of "passedDomain" to this Domain
Definition lsDomain.hpp:125
unsigned getNumberOfSegments() const
returns the number of segments, the levelset is split into. This is useful for algorithm parallelisat...
Definition lsDomain.hpp:154
void print(std::ostream &out=std::cout)
prints basic information and all memebers of the levelset structure
Definition lsDomain.hpp:179
int getLevelSetWidth() const
Definition lsDomain.hpp:159
unsigned getNumberOfPoints() const
returns the number of defined points
Definition lsDomain.hpp:157
void setLevelSetWidth(int width)
Definition lsDomain.hpp:161
Expands the levelSet to the specified number of layers. The largest value in the levelset is thus wid...
Definition lsExpand.hpp:17
void apply()
Apply the expansion to the specified width.
Definition lsExpand.hpp:44
void setWidth(int passedWidth)
Set how far the level set should be extended. Points with value width*0.5 will be added by this algor...
Definition lsExpand.hpp:37
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsExpand.hpp:31
Import the regular grid, on which the level set values are defined, from an explicit Mesh<>....
Definition lsFromMesh.hpp:16
void setMesh(const SmartPointer< Mesh< T > > passedMesh)
Definition lsFromMesh.hpp:34
void setSortPointList(bool passedSortPointList)
Definition lsFromMesh.hpp:36
void apply()
Definition lsFromMesh.hpp:40
Construct a level set from an explicit mesh.
Definition lsFromSurfaceMesh.hpp:15
void setRemoveBoundaryTriangles(bool passedRemoveBoundaryTriangles)
Set whether all triangles outside the domain should be ignored (=true) or whether boundary conditions...
Definition lsFromSurfaceMesh.hpp:227
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsFromSurfaceMesh.hpp:218
void apply()
Definition lsFromSurfaceMesh.hpp:243
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsFromSurfaceMesh.hpp:222
This class creates a level set from a tetrahedral mesh. If the mesh contains a scalar data array call...
Definition lsFromVolumeMesh.hpp:22
typename Domain< T, D >::GridType GridType
Definition lsFromVolumeMesh.hpp:26
void apply()
Definition lsFromVolumeMesh.hpp:56
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsFromVolumeMesh.hpp:48
void setGrid(const GridType &passedGrid)
Definition lsFromVolumeMesh.hpp:43
void setRemoveBoundaryTriangles(bool passedRemoveBoundaryTriangles)
Definition lsFromVolumeMesh.hpp:50
Base class for distributions used by lsGeometricAdvect. All functions are pure virtual and must be im...
Definition lsGeometricAdvectDistributions.hpp:15
virtual void prepare(SmartPointer< Domain< T, D > > domain)
Definition lsGeometricAdvectDistributions.hpp:43
virtual bool isInside(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, double eps) const
Quick check whether a point relative to the distributions center is inside the distribution....
Definition lsGeometricAdvectDistributions.hpp:23
virtual T getSignedDistance(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, unsigned long pointId) const =0
Returns the signed distance of a point relative to the distributions center. This is the signed manha...
virtual void finalize()
Definition lsGeometricAdvectDistributions.hpp:44
virtual std::array< viennahrle::CoordType, 6 > getBounds() const =0
Sets bounds to the bounding box of the distribution.
This class advects the level set according to a given distribution. This distribution is overlayed at...
Definition lsGeometricAdvect.hpp:35
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Set the levelset which should be advected.
Definition lsGeometricAdvect.hpp:76
void apply()
Perform geometrical advection.
Definition lsGeometricAdvect.hpp:95
void setAdvectionDistribution(SmartPointer< GeometricAdvectDistribution< T, D > > passedDist)
Set which advection distribution to use. Must be derived from GeometricAdvectDistribution.
Definition lsGeometricAdvect.hpp:82
Create level sets describing basic geometric forms.
Definition lsMakeGeometry.hpp:27
void setIgnoreBoundaryConditions(bool passedIgnoreBoundaryConditions)
Ignore boundary conditions, meaning the parts of the generated geometry which are outside of the doma...
Definition lsMakeGeometry.hpp:127
void apply()
Definition lsMakeGeometry.hpp:144
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsMakeGeometry.hpp:87
void setGeometry(SmartPointer< Sphere< T, D > > passedSphere)
Set sphere as geometry to be created in the level set.
Definition lsMakeGeometry.hpp:92
This class is used to mark points of the level set which are enclosed in a void.
Definition lsMarkVoidPoints.hpp:28
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsMarkVoidPoints.hpp:95
void setReverseVoidDetection(bool passedReverseVoidDetection)
Set whether the "top" level set should be the most positive(default) connected chain of level set val...
Definition lsMarkVoidPoints.hpp:103
void apply()
Definition lsMarkVoidPoints.hpp:154
void setSaveComponentIds(bool scid)
Set whether the connected component IDs used to generate the void points should be saved....
Definition lsMarkVoidPoints.hpp:150
void setDetectLargestSurface(bool passedDetect)
Set whether the number of points of one connected surface should be used to detect void points....
Definition lsMarkVoidPoints.hpp:113
void setVoidTopSurface(VoidTopSurfaceEnum topSurface)
Set which connected component to use as the top surface and mark all other components as void points.
Definition lsMarkVoidPoints.hpp:119
std::size_t getNumberOfComponents() const
Definition lsMarkVoidPoints.hpp:152
This class holds an explicit mesh, which is always given in 3 dimensions. If it describes a 2D mesh,...
Definition lsMesh.hpp:22
Class describing a plane via a point in it and the plane normal.
Definition lsGeometries.hpp:42
Class describing a point cloud, which can be used to create geometries from its convex hull mesh.
Definition lsGeometries.hpp:145
void insertNextPoint(T *newPoint)
Definition lsGeometries.hpp:154
Removes all level set points, which do not have at least one oppositely signed neighbour (Meaning the...
Definition lsPrune.hpp:17
void apply()
removes all grid points, which do not have at least one opposite signed neighbour returns the number ...
Definition lsPrune.hpp:74
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsPrune.hpp:59
Definition lsReader.hpp:13
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsReader.hpp:26
void apply()
Definition lsReader.hpp:35
void setFileName(std::string passedFileName)
set file name for file to write
Definition lsReader.hpp:31
Reduce the level set size to the specified width. This means all level set points with value <= 0....
Definition lsReduce.hpp:14
void apply()
Reduces the leveleSet to the specified number of layers. The largest value in the levelset is thus wi...
Definition lsReduce.hpp:55
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsReduce.hpp:32
void setWidth(int passedWidth)
Set which level set points should be kept. All points with a level set value >0.5*width will be remov...
Definition lsReduce.hpp:39
void setNoNewSegment(bool passedNoNewSegment)
Set whether to segment the level set after algorithm is finished. This means points will be evenly di...
Definition lsReduce.hpp:44
This algorithm can be used to remove all LS values which are not part of a so-called top surface....
Definition lsRemoveStrayPoints.hpp:17
void setVoidTopSurface(VoidTopSurfaceEnum topSurface)
Set how the algorithm should pick the surface which will not be removed. Defaults to the surface with...
Definition lsRemoveStrayPoints.hpp:33
void apply()
Definition lsRemoveStrayPoints.hpp:37
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsRemoveStrayPoints.hpp:27
Concrete implementation of GeometricAdvectDistribution for a spherical advection distribution.
Definition lsGeometricAdvectDistributions.hpp:50
bool isInside(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, double eps) const override
Quick check whether a point relative to the distributions center is inside the distribution....
Definition lsGeometricAdvectDistributions.hpp:60
std::array< viennahrle::CoordType, 6 > getBounds() const override
Sets bounds to the bounding box of the distribution.
Definition lsGeometricAdvectDistributions.hpp:110
T getSignedDistance(const Vec3D< viennahrle::CoordType > &initial, const Vec3D< viennahrle::CoordType > &candidate, unsigned long) const override
Returns the signed distance of a point relative to the distributions center. This is the signed manha...
Definition lsGeometricAdvectDistributions.hpp:75
Class describing a sphere via origin and radius.
Definition lsGeometries.hpp:15
This class creates a mesh from the level set with all grid points with a level set value <= 0....
Definition lsToDiskMesh.hpp:24
void clearLevelSets()
Definition lsToDiskMesh.hpp:83
void setMesh(SmartPointer< Mesh< N > > passedMesh)
Definition lsToDiskMesh.hpp:70
void setMaterialMap(SmartPointer< MaterialMap > passedMaterialMap)
Definition lsToDiskMesh.hpp:77
void apply()
Definition lsToDiskMesh.hpp:85
void insertNextLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Pushes the passed level set to the back of the list of level sets.
Definition lsToDiskMesh.hpp:66
void setMaxValue(const T passedMaxValue)
Definition lsToDiskMesh.hpp:81
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsToDiskMesh.hpp:61
Extract the regular grid, on which the level set values are defined, to an explicit Mesh<>....
Definition lsToMesh.hpp:19
void setOnlyDefined(bool passedOnlyDefined)
Definition lsToMesh.hpp:43
void setLevelSet(SmartPointer< Domain< T, D > > passedlsDomain)
Definition lsToMesh.hpp:37
void apply()
Definition lsToMesh.hpp:49
void setOnlyActive(bool passedOnlyActive)
Definition lsToMesh.hpp:47
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsToMesh.hpp:41
Definition lsToMultiSurfaceMesh.hpp:11
void apply() override
Definition lsToMultiSurfaceMesh.hpp:236
void setMaterialMap(SmartPointer< MaterialMap > passedMaterialMap)
Definition lsToMultiSurfaceMesh.hpp:232
void clearLevelSets()
Definition lsToMultiSurfaceMesh.hpp:230
void insertNextLevelSet(SmartPointer< lsDomainType > passedLevelSet)
Definition lsToMultiSurfaceMesh.hpp:226
Extract an explicit Mesh<> instance from an lsDomain. The interface is then described by explicit sur...
Definition lsToSurfaceMesh.hpp:25
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsToSurfaceMesh.hpp:95
void setUpdatePointData(bool update)
Definition lsToSurfaceMesh.hpp:97
void setSharpCorners(bool check)
Definition lsToSurfaceMesh.hpp:99
virtual void apply()
Definition lsToSurfaceMesh.hpp:101
void setLevelSet(SmartPointer< lsDomainType > passedlsDomain)
Definition lsToSurfaceMesh.hpp:90
Creates a mesh, which consists only of quads/hexas for completely filled grid cells in the level set....
Definition lsToVoxelMesh.hpp:20
void setMesh(SmartPointer< Mesh< T > > passedMesh)
Definition lsToVoxelMesh.hpp:76
void clearLevelSets()
Definition lsToVoxelMesh.hpp:74
void insertNextLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Push level set to the list of level sets used for output. If more than one are specified,...
Definition lsToVoxelMesh.hpp:70
void apply()
Definition lsToVoxelMesh.hpp:82
Abstract class defining the interface for the velocity field used during advection using lsAdvect.
Definition lsVelocityField.hpp:11
Definition lsWriter.hpp:13
void setFileName(std::string passedFileName)
set file name for file to write
Definition lsWriter.hpp:31
void setLevelSet(SmartPointer< Domain< T, D > > passedLevelSet)
Definition lsWriter.hpp:26
void apply()
Definition lsWriter.hpp:35
Definition lsAdvect.hpp:41
FeatureDetectionEnum
Definition lsDetectFeatures.hpp:16
BooleanOperationEnum
Enumeration for the different types of boolean operations which are supported. When INVERT,...
Definition lsBooleanOperation.hpp:27
CurvatureEnum
Definition lsCalculateCurvatures.hpp:15
void bindApi(py::module &module)
Definition pyWrap.hpp:91
PYBIND11_DECLARE_HOLDER_TYPE(TemplateType, SmartPointer< TemplateType >)