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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
#include "base_impl.h"
#include "contour_generator.h"
#include "fill_type.h"
#include "line_type.h"
#include "mpl2005.h"
#include "mpl2014.h"
#include "serial.h"
#include "threaded.h"
#include "util.h"
#include "z_interp.h"
#define STRINGIFY(x) #x
#define MACRO_STRINGIFY(x) STRINGIFY(x)
namespace py = pybind11;
static contourpy::LineType mpl20xx_line_type = contourpy::LineType::SeparateCode;
static contourpy::FillType mpl20xx_fill_type = contourpy::FillType::OuterCode;
PYBIND11_MODULE(_contourpy, m) {
m.doc() =
"C++11 extension module wrapped using `pybind11`_.\n\n"
"It should not be necessary to access classes and functions in this extension module "
"directly. Instead, :func:`contourpy.contour_generator` should be used to create "
":class:`~contourpy.ContourGenerator` objects, and the enums "
"(:class:`~contourpy.FillType`, :class:`~contourpy.LineType` and "
":class:`~contourpy.ZInterp`) and :func:`contourpy.max_threads` function are all available "
"in the :mod:`contourpy` module.";
m.attr("__version__") = MACRO_STRINGIFY(CONTOURPY_VERSION);
// asserts are enabled if NDEBUG is 0.
m.attr("NDEBUG") =
#ifdef NDEBUG
1;
#else
0;
#endif
py::enum_<contourpy::FillType>(m, "FillType",
"Enum used for ``fill_type`` keyword argument in :func:`~contourpy.contour_generator`.\n\n"
"This controls the format of filled contour data returned from "
":meth:`~contourpy.ContourGenerator.filled`.")
.value("OuterCode", contourpy::FillType::OuterCode)
.value("OuterOffset", contourpy::FillType::OuterOffset)
.value("ChunkCombinedCode", contourpy::FillType::ChunkCombinedCode)
.value("ChunkCombinedOffset", contourpy::FillType::ChunkCombinedOffset)
.value("ChunkCombinedCodeOffset", contourpy::FillType::ChunkCombinedCodeOffset)
.value("ChunkCombinedOffsetOffset", contourpy::FillType::ChunkCombinedOffsetOffset)
.export_values();
py::enum_<contourpy::LineType>(m, "LineType",
"Enum used for ``line_type`` keyword argument in :func:`~contourpy.contour_generator`.\n\n"
"This controls the format of contour line data returned from "
":meth:`~contourpy.ContourGenerator.lines`.\n\n"
"``LineType.ChunkCombinedNan`` added in version 1.2.0")
.value("Separate", contourpy::LineType::Separate)
.value("SeparateCode", contourpy::LineType::SeparateCode)
.value("ChunkCombinedCode", contourpy::LineType::ChunkCombinedCode)
.value("ChunkCombinedOffset", contourpy::LineType::ChunkCombinedOffset)
.value("ChunkCombinedNan", contourpy::LineType::ChunkCombinedNan)
.export_values();
py::enum_<contourpy::ZInterp>(m, "ZInterp",
"Enum used for ``z_interp`` keyword argument in :func:`~contourpy.contour_generator`\n\n"
"This controls the interpolation used on ``z`` values to determine where contour lines "
"intersect the edges of grid quads, and ``z`` values at quad centres.")
.value("Linear", contourpy::ZInterp::Linear)
.value("Log", contourpy::ZInterp::Log)
.export_values();
m.def("max_threads", &contourpy::Util::get_max_threads,
"Return the maximum number of threads, obtained from "
"``std::thread::hardware_concurrency()``.\n\n"
"This is the number of threads used by a multithreaded ContourGenerator if the kwarg "
"``threads=0`` is passed to :func:`~contourpy.contour_generator`.");
const char* chunk_count_doc = "Return tuple of (y, x) chunk counts.";
const char* chunk_size_doc = "Return tuple of (y, x) chunk sizes.";
const char* corner_mask_doc = "Return whether ``corner_mask`` is set or not.";
const char* create_contour_doc =
"Synonym for :func:`~contourpy.ContourGenerator.lines` to provide backward compatibility "
"with Matplotlib.";
const char* create_filled_contour_doc =
"Synonym for :func:`~contourpy.ContourGenerator.filled` to provide backward compatibility "
"with Matplotlib.";
const char* default_fill_type_doc = "Return the default ``FillType`` used by this algorithm.";
const char* default_line_type_doc = "Return the default ``LineType`` used by this algorithm.";
const char* fill_type_doc = "Return the ``FillType``.";
const char* filled_doc =
"Calculate and return filled contours between two levels.\n\n"
"Args:\n"
" lower_level (float): Lower z-level of the filled contours.\n"
" upper_level (float): Upper z-level of the filled contours.\n"
"Return:\n"
" Filled contour polygons as one or more sequences of numpy arrays. The exact format is "
"determined by the ``fill_type`` used by the ``ContourGenerator``.\n\n"
"Raises a ``ValueError`` if ``lower_level >= upper_level``.\n\n"
"To return filled contours below a ``level`` use ``filled(-np.inf, level)``.\n"
"To return filled contours above a ``level`` use ``filled(level, np.inf)``";
const char* line_type_doc = "Return the ``LineType``.";
const char* lines_doc =
"Calculate and return contour lines at a particular level.\n\n"
"Args:\n"
" level (float): z-level to calculate contours at.\n\n"
"Return:\n"
" Contour lines (open line strips and closed line loops) as one or more sequences of "
"numpy arrays. The exact format is determined by the ``line_type`` used by the "
"``ContourGenerator``.";
const char* quad_as_tri_doc = "Return whether ``quad_as_tri`` is set or not.";
const char* supports_corner_mask_doc =
"Return whether this algorithm supports ``corner_mask``.";
const char* supports_fill_type_doc =
"Return whether this algorithm supports a particular ``FillType``.";
const char* supports_line_type_doc =
"Return whether this algorithm supports a particular ``LineType``.";
const char* supports_quad_as_tri_doc =
"Return whether this algorithm supports ``quad_as_tri``.";
const char* supports_threads_doc =
"Return whether this algorithm supports the use of threads.";
const char* supports_z_interp_doc =
"Return whether this algorithm supports ``z_interp`` values other than ``ZInterp.Linear`` "
"which all support.";
const char* thread_count_doc = "Return the number of threads used.";
const char* z_interp_doc = "Return the ``ZInterp``.";
py::class_<contourpy::ContourGenerator>(m, "ContourGenerator",
"Abstract base class for contour generator classes, defining the interface that they all "
"implement.")
.def("create_contour",
[](py::object /* self */, double level) {return py::make_tuple();},
py::arg("level"), create_contour_doc)
.def("create_filled_contour",
[](py::object /* self */, double lower_level, double upper_level) {return py::make_tuple();},
py::arg("lower_level"), py::arg("upper_level"), create_filled_contour_doc)
.def("filled",
[](py::object /* self */, double lower_level, double upper_level) {return py::make_tuple();},
py::arg("lower_level"), py::arg("upper_level"), filled_doc)
.def("lines",
[](py::object /* self */, double level) {return py::make_tuple();},
py::arg("level"), lines_doc)
.def_property_readonly(
"chunk_count", [](py::object /* self */) {return py::make_tuple(1, 1);},
chunk_count_doc)
.def_property_readonly(
"chunk_size", [](py::object /* self */) {return py::make_tuple(1, 1);}, chunk_size_doc)
.def_property_readonly(
"corner_mask", [](py::object /* self */) {return false;}, corner_mask_doc)
.def_property_readonly(
"fill_type", [](py::object /* self */) {return contourpy::FillType::OuterOffset;},
fill_type_doc)
.def_property_readonly(
"line_type", [](py::object /* self */) {return contourpy::LineType::Separate;},
line_type_doc)
.def_property_readonly(
"quad_as_tri", [](py::object /* self */) {return false;}, quad_as_tri_doc)
.def_property_readonly(
"thread_count", [](py::object /* self */) {return 1;}, thread_count_doc)
.def_property_readonly(
"z_interp", [](py::object /* self */) {return contourpy::ZInterp::Linear;},
z_interp_doc)
.def_property_readonly_static(
"default_fill_type",
[](py::object /* self */) {return contourpy::FillType::OuterOffset;},
default_fill_type_doc)
.def_property_readonly_static(
"default_line_type", [](py::object /* self */) {return contourpy::LineType::Separate;},
default_line_type_doc)
.def_static("supports_corner_mask", []() {return false;}, supports_corner_mask_doc)
.def_static(
"supports_fill_type", [](contourpy::FillType /* fill_type */) {return false;},
py::arg("fill_type"), supports_fill_type_doc)
.def_static(
"supports_line_type", [](contourpy::LineType /* line_type */) {return false;},
py::arg("line_type"), supports_line_type_doc)
.def_static("supports_quad_as_tri", []() {return false;}, supports_quad_as_tri_doc)
.def_static("supports_threads", []() {return false;}, supports_threads_doc)
.def_static("supports_z_interp", []() {return false;}, supports_z_interp_doc);
py::class_<contourpy::Mpl2005ContourGenerator, contourpy::ContourGenerator>(
m, "Mpl2005ContourGenerator",
"ContourGenerator corresponding to ``name=\"mpl2005\"``.\n\n"
"This is the original 2005 Matplotlib algorithm. "
"Does not support any of ``corner_mask``, ``quad_as_tri``, ``threads`` or ``z_interp``. "
"Only supports ``line_type=LineType.SeparateCode`` and ``fill_type=FillType.OuterCode``. "
"Only supports chunking for filled contours, not contour lines.\n\n"
".. warning::\n"
" This algorithm is in ``contourpy`` for historic comparison. No new features or bug "
"fixes will be added to it, except for security-related bug fixes.")
.def(py::init<const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::MaskArray&,
contourpy::index_t,
contourpy::index_t>(),
py::arg("x"),
py::arg("y"),
py::arg("z"),
py::arg("mask"),
py::kw_only(),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("create_contour", &contourpy::Mpl2005ContourGenerator::lines, create_contour_doc)
.def("create_filled_contour", &contourpy::Mpl2005ContourGenerator::filled,
create_filled_contour_doc)
.def("filled", &contourpy::Mpl2005ContourGenerator::filled, filled_doc)
.def("lines", &contourpy::Mpl2005ContourGenerator::lines, lines_doc)
.def_property_readonly(
"chunk_count", &contourpy::Mpl2005ContourGenerator::get_chunk_count, chunk_count_doc)
.def_property_readonly(
"chunk_size", &contourpy::Mpl2005ContourGenerator::get_chunk_size, chunk_size_doc)
.def_property_readonly(
"fill_type", [](py::object /* self */) {return mpl20xx_fill_type;}, fill_type_doc)
.def_property_readonly(
"line_type", [](py::object /* self */) {return mpl20xx_line_type;}, line_type_doc)
.def_property_readonly_static(
"default_fill_type", [](py::object /* self */) {return mpl20xx_fill_type;},
default_fill_type_doc)
.def_property_readonly_static(
"default_line_type", [](py::object /* self */) {return mpl20xx_line_type;},
default_line_type_doc)
.def_static(
"supports_fill_type",
[](contourpy::FillType fill_type) {return fill_type == mpl20xx_fill_type;},
supports_fill_type_doc)
.def_static(
"supports_line_type",
[](contourpy::LineType line_type) {return line_type == mpl20xx_line_type;},
supports_line_type_doc);
py::class_<contourpy::mpl2014::Mpl2014ContourGenerator, contourpy::ContourGenerator>(
m, "Mpl2014ContourGenerator",
"ContourGenerator corresponding to ``name=\"mpl2014\"``.\n\n"
"This is the 2014 Matplotlib algorithm, a replacement of the original 2005 algorithm that "
"added ``corner_mask`` and made the code more maintainable. "
"Only supports ``corner_mask``, does not support ``quad_as_tri``, ``threads`` or "
"``z_interp``. \n"
"Only supports ``line_type=LineType.SeparateCode`` and "
"``fill_type=FillType.OuterCode``.\n\n"
".. warning::\n"
" This algorithm is in ``contourpy`` for historic comparison. No new features or bug "
"fixes will be added to it, except for security-related bug fixes.")
.def(py::init<const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::MaskArray&,
bool,
contourpy::index_t,
contourpy::index_t>(),
py::arg("x"),
py::arg("y"),
py::arg("z"),
py::arg("mask"),
py::kw_only(),
py::arg("corner_mask"),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("create_contour", &contourpy::mpl2014::Mpl2014ContourGenerator::lines,
create_contour_doc)
.def("create_filled_contour", &contourpy::mpl2014::Mpl2014ContourGenerator::filled,
create_filled_contour_doc)
.def("filled", &contourpy::mpl2014::Mpl2014ContourGenerator::filled, filled_doc)
.def("lines", &contourpy::mpl2014::Mpl2014ContourGenerator::lines, lines_doc)
.def_property_readonly(
"chunk_count", &contourpy::mpl2014::Mpl2014ContourGenerator::get_chunk_count,
chunk_count_doc)
.def_property_readonly(
"chunk_size", &contourpy::mpl2014::Mpl2014ContourGenerator::get_chunk_size,
chunk_size_doc)
.def_property_readonly(
"corner_mask", &contourpy::mpl2014::Mpl2014ContourGenerator::get_corner_mask,
corner_mask_doc)
.def_property_readonly(
"fill_type", [](py::object /* self */) {return mpl20xx_fill_type;}, fill_type_doc)
.def_property_readonly(
"line_type", [](py::object /* self */) {return mpl20xx_line_type;}, line_type_doc)
.def_property_readonly_static(
"default_fill_type", [](py::object /* self */) {return mpl20xx_fill_type;},
default_fill_type_doc)
.def_property_readonly_static(
"default_line_type", [](py::object /* self */) {return mpl20xx_line_type;},
default_line_type_doc)
.def_static("supports_corner_mask", []() {return true;}, supports_corner_mask_doc)
.def_static(
"supports_fill_type",
[](contourpy::FillType fill_type) {return fill_type == mpl20xx_fill_type;},
supports_fill_type_doc)
.def_static(
"supports_line_type",
[](contourpy::LineType line_type) {return line_type == mpl20xx_line_type;},
supports_line_type_doc);
py::class_<contourpy::SerialContourGenerator, contourpy::ContourGenerator>(
m, "SerialContourGenerator",
"ContourGenerator corresponding to ``name=\"serial\"``, the default algorithm for "
"``contourpy``.\n\n"
"Supports ``corner_mask``, ``quad_as_tri`` and ``z_interp`` but not ``threads``. "
"Supports all options for ``line_type`` and ``fill_type``.")
.def(py::init<const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::MaskArray&,
bool,
contourpy::LineType,
contourpy::FillType,
bool,
contourpy::ZInterp,
contourpy::index_t,
contourpy::index_t>(),
py::arg("x"),
py::arg("y"),
py::arg("z"),
py::arg("mask"),
py::kw_only(),
py::arg("corner_mask"),
py::arg("line_type"),
py::arg("fill_type"),
py::arg("quad_as_tri"),
py::arg("z_interp"),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("_write_cache", &contourpy::SerialContourGenerator::write_cache)
.def("create_contour", &contourpy::SerialContourGenerator::lines, create_contour_doc)
.def("create_filled_contour", &contourpy::SerialContourGenerator::filled,
create_filled_contour_doc)
.def("filled", &contourpy::SerialContourGenerator::filled, filled_doc)
.def("lines", &contourpy::SerialContourGenerator::lines, lines_doc)
.def_property_readonly(
"chunk_count", &contourpy::SerialContourGenerator::get_chunk_count, chunk_count_doc)
.def_property_readonly(
"chunk_size", &contourpy::SerialContourGenerator::get_chunk_size, chunk_size_doc)
.def_property_readonly(
"corner_mask", &contourpy::SerialContourGenerator::get_corner_mask, corner_mask_doc)
.def_property_readonly(
"fill_type", &contourpy::SerialContourGenerator::get_fill_type, fill_type_doc)
.def_property_readonly(
"line_type", &contourpy::SerialContourGenerator::get_line_type, line_type_doc)
.def_property_readonly(
"quad_as_tri", &contourpy::SerialContourGenerator::get_quad_as_tri, quad_as_tri_doc)
.def_property_readonly(
"z_interp", &contourpy::SerialContourGenerator::get_z_interp, z_interp_doc)
.def_property_readonly_static(
"default_fill_type",
[](py::object /* self */) {return contourpy::SerialContourGenerator::default_fill_type();},
default_fill_type_doc)
.def_property_readonly_static("default_line_type",
[](py::object /* self */) {return contourpy::SerialContourGenerator::default_line_type();},
default_line_type_doc)
.def_static("supports_corner_mask", []() {return true;}, supports_corner_mask_doc)
.def_static(
"supports_fill_type", &contourpy::SerialContourGenerator::supports_fill_type,
supports_fill_type_doc)
.def_static(
"supports_line_type", &contourpy::SerialContourGenerator::supports_line_type,
supports_line_type_doc)
.def_static("supports_quad_as_tri", []() {return true;}, supports_quad_as_tri_doc)
.def_static("supports_z_interp", []() {return true;}, supports_z_interp_doc);
py::class_<contourpy::ThreadedContourGenerator, contourpy::ContourGenerator>(
m, "ThreadedContourGenerator",
"ContourGenerator corresponding to ``name=\"threaded\"``, the multithreaded version of "
":class:`~contourpy._contourpy.SerialContourGenerator`.\n\n"
"Supports ``corner_mask``, ``quad_as_tri`` and ``z_interp`` and ``threads``. "
"Supports all options for ``line_type`` and ``fill_type``.")
.def(py::init<const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::CoordinateArray&,
const contourpy::MaskArray&,
bool,
contourpy::LineType,
contourpy::FillType,
bool,
contourpy::ZInterp,
contourpy::index_t,
contourpy::index_t,
contourpy::index_t>(),
py::arg("x"),
py::arg("y"),
py::arg("z"),
py::arg("mask"),
py::kw_only(),
py::arg("corner_mask"),
py::arg("line_type"),
py::arg("fill_type"),
py::arg("quad_as_tri"),
py::arg("z_interp"),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0,
py::arg("thread_count") = 0)
.def("_write_cache", &contourpy::ThreadedContourGenerator::write_cache)
.def("create_contour", &contourpy::ThreadedContourGenerator::lines, create_contour_doc)
.def("create_filled_contour", &contourpy::ThreadedContourGenerator::filled,
create_filled_contour_doc)
.def("filled", &contourpy::ThreadedContourGenerator::filled, filled_doc)
.def("lines", &contourpy::ThreadedContourGenerator::lines, lines_doc)
.def_property_readonly(
"chunk_count", &contourpy::ThreadedContourGenerator::get_chunk_count, chunk_count_doc)
.def_property_readonly(
"chunk_size", &contourpy::ThreadedContourGenerator::get_chunk_size, chunk_size_doc)
.def_property_readonly(
"corner_mask", &contourpy::ThreadedContourGenerator::get_corner_mask, corner_mask_doc)
.def_property_readonly(
"fill_type", &contourpy::ThreadedContourGenerator::get_fill_type, fill_type_doc)
.def_property_readonly(
"line_type", &contourpy::ThreadedContourGenerator::get_line_type, line_type_doc)
.def_property_readonly(
"quad_as_tri", &contourpy::ThreadedContourGenerator::get_quad_as_tri, quad_as_tri_doc)
.def_property_readonly(
"thread_count", &contourpy::ThreadedContourGenerator::get_thread_count,
thread_count_doc)
.def_property_readonly(
"z_interp", &contourpy::ThreadedContourGenerator::get_z_interp, z_interp_doc)
.def_property_readonly_static(
"default_fill_type",
[](py::object /* self */) {return contourpy::ThreadedContourGenerator::default_fill_type();},
default_fill_type_doc)
.def_property_readonly_static(
"default_line_type",
[](py::object /* self */) {return contourpy::ThreadedContourGenerator::default_line_type();},
default_line_type_doc)
.def_static("supports_corner_mask", []() {return true;}, supports_corner_mask_doc)
.def_static(
"supports_fill_type", &contourpy::ThreadedContourGenerator::supports_fill_type,
supports_fill_type_doc)
.def_static(
"supports_line_type", &contourpy::ThreadedContourGenerator::supports_line_type,
supports_line_type_doc)
.def_static("supports_quad_as_tri", []() {return true;}, supports_quad_as_tri_doc)
.def_static("supports_threads", []() {return true;}, supports_threads_doc)
.def_static("supports_z_interp", []() {return true;}, supports_z_interp_doc);
}
|
