morphogen 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. morphogen/__init__.py +60 -0
  2. morphogen/__main__.py +7 -0
  3. morphogen/_platform.py +55 -0
  4. morphogen/_public.py +153 -0
  5. morphogen/_utils.py +80 -0
  6. morphogen/_version.py +1 -0
  7. morphogen/analysis/__init__.py +174 -0
  8. morphogen/analysis/anisotropy.py +135 -0
  9. morphogen/analysis/basic.py +38 -0
  10. morphogen/analysis/cells.py +54 -0
  11. morphogen/analysis/connectivity.py +156 -0
  12. morphogen/analysis/correlation.py +195 -0
  13. morphogen/analysis/covariance.py +80 -0
  14. morphogen/analysis/fractal.py +54 -0
  15. morphogen/analysis/measures.py +188 -0
  16. morphogen/analysis/morphology.py +265 -0
  17. morphogen/analysis/particles.py +160 -0
  18. morphogen/analysis/percolation.py +2034 -0
  19. morphogen/analysis/power_laws.py +143 -0
  20. morphogen/analysis/random_sets.py +351 -0
  21. morphogen/analysis/stereology.py +289 -0
  22. morphogen/analysis/surface.py +107 -0
  23. morphogen/analysis/topology.py +92 -0
  24. morphogen/automata/__init__.py +74 -0
  25. morphogen/automata/engine.py +211 -0
  26. morphogen/automata/growth.py +686 -0
  27. morphogen/automata/lattice.py +143 -0
  28. morphogen/automata/reaction.py +255 -0
  29. morphogen/automata/rules.py +353 -0
  30. morphogen/automata/tilings.py +1715 -0
  31. morphogen/cli.py +3526 -0
  32. morphogen/config.py +2167 -0
  33. morphogen/contact/__init__.py +113 -0
  34. morphogen/contact/experiments.py +368 -0
  35. morphogen/contact/hertz.py +104 -0
  36. morphogen/contact/kernels.py +827 -0
  37. morphogen/contact/periodic.py +278 -0
  38. morphogen/contact/problem.py +578 -0
  39. morphogen/contact/surfaces.py +310 -0
  40. morphogen/coupling/__init__.py +43 -0
  41. morphogen/coupling/ageing.py +143 -0
  42. morphogen/coupling/diffusion.py +226 -0
  43. morphogen/coupling/fenicsx.py +484 -0
  44. morphogen/coupling/oxidation.py +447 -0
  45. morphogen/coupling/plates.py +247 -0
  46. morphogen/design/__init__.py +51 -0
  47. morphogen/design/csp.py +616 -0
  48. morphogen/design/frames.py +277 -0
  49. morphogen/design/search.py +287 -0
  50. morphogen/design/tiles.py +336 -0
  51. morphogen/distributions.py +312 -0
  52. morphogen/domain.py +203 -0
  53. morphogen/dynamics/__init__.py +179 -0
  54. morphogen/dynamics/model.py +638 -0
  55. morphogen/dynamics/openradioss.py +643 -0
  56. morphogen/dynamics/results.py +515 -0
  57. morphogen/fracture/__init__.py +170 -0
  58. morphogen/fracture/bulk.py +349 -0
  59. morphogen/fracture/cohesive.py +1614 -0
  60. morphogen/fracture/ductile.py +557 -0
  61. morphogen/fracture/lefm.py +1168 -0
  62. morphogen/fracture/mixed.py +1178 -0
  63. morphogen/fracture/periodic.py +733 -0
  64. morphogen/fracture/phasefield.py +714 -0
  65. morphogen/fracture/phasefield_finite.py +368 -0
  66. morphogen/fracture/surface.py +572 -0
  67. morphogen/fracture/toughness.py +566 -0
  68. morphogen/gpu.py +108 -0
  69. morphogen/gui/__init__.py +8 -0
  70. morphogen/gui/api.py +1927 -0
  71. morphogen/gui/desktop.py +387 -0
  72. morphogen/gui/icon.png +0 -0
  73. morphogen/gui/index.html +1909 -0
  74. morphogen/gui/server.py +229 -0
  75. morphogen/gui/tools/__init__.py +629 -0
  76. morphogen/gui/tools/compare.py +149 -0
  77. morphogen/gui/tools/contact.py +391 -0
  78. morphogen/gui/tools/couplings.py +1085 -0
  79. morphogen/gui/tools/crackfront.py +245 -0
  80. morphogen/gui/tools/design.py +224 -0
  81. morphogen/gui/tools/dynamics.py +824 -0
  82. morphogen/gui/tools/fracture.py +2586 -0
  83. morphogen/gui/tools/interop.py +1654 -0
  84. morphogen/gui/tools/learning.py +595 -0
  85. morphogen/gui/tools/mechanics.py +3881 -0
  86. morphogen/gui/tools/nonlocal_damage.py +1321 -0
  87. morphogen/gui/tools/phasefield.py +215 -0
  88. morphogen/gui/tools/physics.py +597 -0
  89. morphogen/gui/tools/stability.py +1756 -0
  90. morphogen/gui/tools/statistics.py +1408 -0
  91. morphogen/gui/viewer.js +1100 -0
  92. morphogen/homogenization/__init__.py +210 -0
  93. morphogen/homogenization/acoustics.py +566 -0
  94. morphogen/homogenization/amg.py +1005 -0
  95. morphogen/homogenization/apparent.py +1046 -0
  96. morphogen/homogenization/behaviours.cu +2285 -0
  97. morphogen/homogenization/behaviours.py +944 -0
  98. morphogen/homogenization/beremin.py +263 -0
  99. morphogen/homogenization/bifurcation.py +1085 -0
  100. morphogen/homogenization/bloch.py +507 -0
  101. morphogen/homogenization/bounds.py +226 -0
  102. morphogen/homogenization/core.py +458 -0
  103. morphogen/homogenization/coupled.py +1135 -0
  104. morphogen/homogenization/crystal.py +2967 -0
  105. morphogen/homogenization/dilatation.py +454 -0
  106. morphogen/homogenization/elements.py +157 -0
  107. morphogen/homogenization/fatigue.py +768 -0
  108. morphogen/homogenization/fe.py +1739 -0
  109. morphogen/homogenization/fenicsx.py +307 -0
  110. morphogen/homogenization/fft.py +499 -0
  111. morphogen/homogenization/fft_nonlinear.py +391 -0
  112. morphogen/homogenization/finite.py +613 -0
  113. morphogen/homogenization/flow.py +361 -0
  114. morphogen/homogenization/frames.py +1125 -0
  115. morphogen/homogenization/gpu.py +1241 -0
  116. morphogen/homogenization/harmonic.py +427 -0
  117. morphogen/homogenization/identification.py +579 -0
  118. morphogen/homogenization/kernels.py +760 -0
  119. morphogen/homogenization/laws.py +2061 -0
  120. morphogen/homogenization/materials.py +1080 -0
  121. morphogen/homogenization/mfront.py +589 -0
  122. morphogen/homogenization/networks.py +880 -0
  123. morphogen/homogenization/nonlinear.py +2612 -0
  124. morphogen/homogenization/ntfa.py +577 -0
  125. morphogen/homogenization/paths.py +476 -0
  126. morphogen/homogenization/photonic.py +467 -0
  127. morphogen/homogenization/poroelastic.py +212 -0
  128. morphogen/homogenization/porous.py +1120 -0
  129. morphogen/homogenization/postprocess.py +290 -0
  130. morphogen/homogenization/solvers.py +1140 -0
  131. morphogen/homogenization/tensors.py +240 -0
  132. morphogen/homogenization/voxel_fe.py +457 -0
  133. morphogen/homogenization/xfem.py +1016 -0
  134. morphogen/homogenization/zmat.py +1258 -0
  135. morphogen/iga/__init__.py +48 -0
  136. morphogen/iga/analysis.py +508 -0
  137. morphogen/iga/basis.py +214 -0
  138. morphogen/iga/geometry.py +501 -0
  139. morphogen/iga/homogenization.py +219 -0
  140. morphogen/iga/optimization.py +700 -0
  141. morphogen/iga/shapes.py +331 -0
  142. morphogen/image.py +128 -0
  143. morphogen/io/__init__.py +246 -0
  144. morphogen/io/amitex.py +741 -0
  145. morphogen/io/ebsd.py +881 -0
  146. morphogen/io/export.py +196 -0
  147. morphogen/io/geometry.py +158 -0
  148. morphogen/io/medit.py +147 -0
  149. morphogen/io/meshes.py +844 -0
  150. morphogen/io/metaimage.py +97 -0
  151. morphogen/io/mfront.py +1104 -0
  152. morphogen/io/native.py +57 -0
  153. morphogen/io/radioss.py +764 -0
  154. morphogen/io/solvers.py +371 -0
  155. morphogen/io/tables.py +278 -0
  156. morphogen/io/tiff.py +66 -0
  157. morphogen/io/vtk.py +701 -0
  158. morphogen/io/xdmf.py +200 -0
  159. morphogen/kernels/__init__.py +5 -0
  160. morphogen/kernels/annealing.py +192 -0
  161. morphogen/kernels/cells.py +69 -0
  162. morphogen/kernels/collective.py +87 -0
  163. morphogen/kernels/force_biased.py +595 -0
  164. morphogen/kernels/implicit.py +145 -0
  165. morphogen/kernels/leaves.py +132 -0
  166. morphogen/kernels/packing.py +304 -0
  167. morphogen/kernels/raster.py +279 -0
  168. morphogen/kernels/rsa.py +371 -0
  169. morphogen/kernels/union.py +135 -0
  170. morphogen/kernels/watershed.py +190 -0
  171. morphogen/laser/__init__.py +234 -0
  172. morphogen/laser/architectures.py +375 -0
  173. morphogen/laser/bending.py +216 -0
  174. morphogen/laser/cells.py +1694 -0
  175. morphogen/laser/design.py +940 -0
  176. morphogen/laser/figures.py +227 -0
  177. morphogen/laser/heat.py +804 -0
  178. morphogen/laser/materials.py +691 -0
  179. morphogen/laser/mechanics.py +1670 -0
  180. morphogen/laser/metallurgy.py +615 -0
  181. morphogen/laser/patterns.py +828 -0
  182. morphogen/laser/periodic.py +392 -0
  183. morphogen/laser/process.py +362 -0
  184. morphogen/laser/run.py +534 -0
  185. morphogen/laser/solid.py +216 -0
  186. morphogen/laser/specimen.py +200 -0
  187. morphogen/laser/structures.py +708 -0
  188. morphogen/learning/__init__.py +81 -0
  189. morphogen/learning/behaviour.py +398 -0
  190. morphogen/learning/data.py +328 -0
  191. morphogen/learning/learned.cpp +668 -0
  192. morphogen/learning/logarithmic.py +202 -0
  193. morphogen/learning/mfront.py +409 -0
  194. morphogen/learning/networks.py +767 -0
  195. morphogen/learning/run.py +212 -0
  196. morphogen/learning/standard.py +814 -0
  197. morphogen/learning/training.py +235 -0
  198. morphogen/mesh/__init__.py +29 -0
  199. morphogen/mesh/conforming.py +1423 -0
  200. morphogen/mesh/curved.py +600 -0
  201. morphogen/mesh/exact.py +1717 -0
  202. morphogen/mesh/octree.py +350 -0
  203. morphogen/mesh/polycrystal.py +1041 -0
  204. morphogen/mesh/polyhedra.py +677 -0
  205. morphogen/mesh/regularize.py +570 -0
  206. morphogen/mesh/surface.py +97 -0
  207. morphogen/mesh/tetra.py +512 -0
  208. morphogen/mesh/voxel.py +124 -0
  209. morphogen/micromorphic/__init__.py +31 -0
  210. morphogen/micromorphic/damage.py +359 -0
  211. morphogen/micromorphic/ductile.py +534 -0
  212. morphogen/micromorphic/finite.py +220 -0
  213. morphogen/micromorphic/microfoam.py +787 -0
  214. morphogen/micromorphic/space.py +341 -0
  215. morphogen/models/__init__.py +195 -0
  216. morphogen/models/affine.py +384 -0
  217. morphogen/models/automata.py +592 -0
  218. morphogen/models/base.py +500 -0
  219. morphogen/models/boolean.py +310 -0
  220. morphogen/models/bouligand.py +331 -0
  221. morphogen/models/branching.py +241 -0
  222. morphogen/models/combination.py +430 -0
  223. morphogen/models/deadleaves.py +766 -0
  224. morphogen/models/design.py +289 -0
  225. morphogen/models/ebsd.py +206 -0
  226. morphogen/models/fibers.py +1476 -0
  227. morphogen/models/foam.py +594 -0
  228. morphogen/models/gaussian.py +314 -0
  229. morphogen/models/growth.py +459 -0
  230. morphogen/models/hardcore.py +317 -0
  231. morphogen/models/hierarchical.py +269 -0
  232. morphogen/models/honeycomb.py +749 -0
  233. morphogen/models/implicit.py +177 -0
  234. morphogen/models/laminate.py +470 -0
  235. morphogen/models/lattice.py +351 -0
  236. morphogen/models/lattice_field.py +345 -0
  237. morphogen/models/levelset_foam.py +563 -0
  238. morphogen/models/nacre.py +411 -0
  239. morphogen/models/nested.py +924 -0
  240. morphogen/models/osteons.py +374 -0
  241. morphogen/models/pieces.py +167 -0
  242. morphogen/models/planar.py +126 -0
  243. morphogen/models/reconstruction.py +203 -0
  244. morphogen/models/scale_rich.py +1409 -0
  245. morphogen/models/scale_rich_3d.py +1616 -0
  246. morphogen/models/tessellation.py +735 -0
  247. morphogen/models/tiling_field.py +302 -0
  248. morphogen/models/tpms.py +197 -0
  249. morphogen/models/transparent.py +406 -0
  250. morphogen/models/union.py +141 -0
  251. morphogen/optimization/__init__.py +43 -0
  252. morphogen/optimization/cell.py +295 -0
  253. morphogen/optimization/filters.py +115 -0
  254. morphogen/optimization/mma.py +226 -0
  255. morphogen/optimization/run.py +219 -0
  256. morphogen/optimization/topology.py +632 -0
  257. morphogen/orientations.py +568 -0
  258. morphogen/parallel.py +599 -0
  259. morphogen/pipeline.py +978 -0
  260. morphogen/primitives.py +188 -0
  261. morphogen/results.py +564 -0
  262. morphogen/rve/__init__.py +73 -0
  263. morphogen/rve/report.py +627 -0
  264. morphogen/rve/scaling.py +363 -0
  265. morphogen/rve/study.py +1054 -0
  266. morphogen/rve/windows.py +345 -0
  267. morphogen/seeding.py +51 -0
  268. morphogen/settings.py +118 -0
  269. morphogen/stopping.py +48 -0
  270. morphogen/symmetry.py +384 -0
  271. morphogen/templates/activator_inhibitor.yaml +22 -0
  272. morphogen/templates/aggregation.yaml +23 -0
  273. morphogen/templates/boolean_cylinders.yaml +20 -0
  274. morphogen/templates/boolean_spheres.yaml +22 -0
  275. morphogen/templates/bouligand.yaml +28 -0
  276. morphogen/templates/cellular_automaton.yaml +25 -0
  277. morphogen/templates/coated_spheres.yaml +26 -0
  278. morphogen/templates/contact_fibers.yaml +27 -0
  279. morphogen/templates/cox_nanocomposite.yaml +22 -0
  280. morphogen/templates/cross_linked_fibers.yaml +26 -0
  281. morphogen/templates/curved_arcs.yaml +28 -0
  282. morphogen/templates/curved_fibers.yaml +24 -0
  283. morphogen/templates/dead_leaves.yaml +22 -0
  284. morphogen/templates/delaunay_network.yaml +22 -0
  285. morphogen/templates/dense_packing.yaml +22 -0
  286. morphogen/templates/diffusion.yaml +33 -0
  287. morphogen/templates/ebsd.yaml +34 -0
  288. morphogen/templates/ebsd_map.ctf +3087 -0
  289. morphogen/templates/fracture_composite.yaml +42 -0
  290. morphogen/templates/fracture_rubber.yaml +47 -0
  291. morphogen/templates/gaussian_excursion.yaml +17 -0
  292. morphogen/templates/graded_lattice.yaml +24 -0
  293. morphogen/templates/hardcore_fibers.yaml +22 -0
  294. morphogen/templates/hardcore_spheres.yaml +22 -0
  295. morphogen/templates/hierarchical_lattice.yaml +22 -0
  296. morphogen/templates/homogenization_acoustic_foam.yaml +36 -0
  297. morphogen/templates/homogenization_beremin.yaml +50 -0
  298. morphogen/templates/homogenization_cleavage.yaml +51 -0
  299. morphogen/templates/homogenization_cleavage_band.yaml +55 -0
  300. morphogen/templates/homogenization_contact.yaml +43 -0
  301. morphogen/templates/homogenization_crack_closure.yaml +49 -0
  302. morphogen/templates/homogenization_crystal_plasticity.yaml +50 -0
  303. morphogen/templates/homogenization_crystal_plasticity_fft.yaml +52 -0
  304. morphogen/templates/homogenization_crystallization.yaml +30 -0
  305. morphogen/templates/homogenization_debonding.yaml +43 -0
  306. morphogen/templates/homogenization_detwinning.yaml +58 -0
  307. morphogen/templates/homogenization_ductile_damage.yaml +47 -0
  308. morphogen/templates/homogenization_fatigue.yaml +40 -0
  309. morphogen/templates/homogenization_grain_fracture.yaml +56 -0
  310. morphogen/templates/homogenization_gyroid.yaml +30 -0
  311. morphogen/templates/homogenization_intergranular.yaml +43 -0
  312. morphogen/templates/homogenization_interphase.yaml +42 -0
  313. morphogen/templates/homogenization_mixed_loading.yaml +33 -0
  314. morphogen/templates/homogenization_ntfa.yaml +56 -0
  315. morphogen/templates/homogenization_piezoelectric.yaml +27 -0
  316. morphogen/templates/homogenization_polycrystal.yaml +30 -0
  317. morphogen/templates/homogenization_polycrystal_inclusions.yaml +30 -0
  318. morphogen/templates/homogenization_poroelastic.yaml +26 -0
  319. morphogen/templates/homogenization_rubber.yaml +40 -0
  320. morphogen/templates/homogenization_slip_cleavage.yaml +50 -0
  321. morphogen/templates/homogenization_spheres.yaml +31 -0
  322. morphogen/templates/homogenization_transport.yaml +29 -0
  323. morphogen/templates/homogenization_twinning.yaml +54 -0
  324. morphogen/templates/homogenization_viscoelastic.yaml +34 -0
  325. morphogen/templates/homogenization_viscoplastic.yaml +42 -0
  326. morphogen/templates/homogenization_voronoi.yaml +26 -0
  327. morphogen/templates/homogenization_xfem.yaml +23 -0
  328. morphogen/templates/hyperuniform_cells.yaml +24 -0
  329. morphogen/templates/laguerre.yaml +18 -0
  330. morphogen/templates/laser_bending.yaml +35 -0
  331. morphogen/templates/laser_cells.yaml +38 -0
  332. morphogen/templates/laser_corrugated.yaml +36 -0
  333. morphogen/templates/level_set_foam.yaml +29 -0
  334. morphogen/templates/menger_sponge.yaml +17 -0
  335. morphogen/templates/nacre.yaml +25 -0
  336. morphogen/templates/nucleation_growth.yaml +25 -0
  337. morphogen/templates/optimize_auxetic.yaml +29 -0
  338. morphogen/templates/optimize_auxetic_3d.yaml +27 -0
  339. morphogen/templates/optimize_bulk.yaml +23 -0
  340. morphogen/templates/optimize_conductivity.yaml +20 -0
  341. morphogen/templates/osteons.yaml +28 -0
  342. morphogen/templates/penetrable_spheres.yaml +21 -0
  343. morphogen/templates/poisson_fibers.yaml +21 -0
  344. morphogen/templates/random_laminate.yaml +26 -0
  345. morphogen/templates/random_lattice.yaml +27 -0
  346. morphogen/templates/random_walk_fibers.yaml +26 -0
  347. morphogen/templates/reaction_diffusion.yaml +22 -0
  348. morphogen/templates/reconstruction.yaml +22 -0
  349. morphogen/templates/rve_cellular_automaton.yaml +23 -0
  350. morphogen/templates/rve_crystal_plasticity_fft.yaml +51 -0
  351. morphogen/templates/rve_multiphysics.yaml +43 -0
  352. morphogen/templates/rve_poisson_fibers.yaml +22 -0
  353. morphogen/templates/rve_poisson_fibers_fe.yaml +33 -0
  354. morphogen/templates/rve_voronoi_windows.yaml +20 -0
  355. morphogen/templates/scale_rich_network.yaml +29 -0
  356. morphogen/templates/scale_rich_plates.yaml +30 -0
  357. morphogen/templates/sequential_dead_leaves.yaml +25 -0
  358. morphogen/templates/strut_lattice.yaml +21 -0
  359. morphogen/templates/tile_assembly.yaml +28 -0
  360. morphogen/templates/tpms.yaml +19 -0
  361. morphogen/templates/trabecular_bone.yaml +29 -0
  362. morphogen/templates/transparent_dead_leaves.yaml +23 -0
  363. morphogen/templates/vascular_tree.yaml +23 -0
  364. morphogen/templates/voronoi.yaml +20 -0
  365. morphogen/templates/wood.yaml +34 -0
  366. morphogen/templates/workflow.yaml +56 -0
  367. morphogen/texture.py +665 -0
  368. morphogen/theory.py +162 -0
  369. morphogen/viz/__init__.py +12 -0
  370. morphogen/viz/export.py +244 -0
  371. morphogen/viz/figures.py +707 -0
  372. morphogen/viz/png.py +148 -0
  373. morphogen/viz/sections.py +696 -0
  374. morphogen/viz/surfaces.py +1352 -0
  375. morphogen/viz/video.py +904 -0
  376. morphogen/viz/workflow.py +488 -0
  377. morphogen-1.0.0.dist-info/METADATA +2316 -0
  378. morphogen-1.0.0.dist-info/RECORD +381 -0
  379. morphogen-1.0.0.dist-info/WHEEL +4 -0
  380. morphogen-1.0.0.dist-info/entry_points.txt +5 -0
  381. morphogen-1.0.0.dist-info/licenses/LICENSE +674 -0
@@ -0,0 +1,314 @@
1
+ """Excursion sets of stationary Gaussian random fields."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import math
6
+ from dataclasses import dataclass
7
+ from typing import ClassVar
8
+
9
+ import numpy as np
10
+ from scipy import fft as sfft
11
+ from scipy import stats
12
+
13
+ from morphogen import settings, theory
14
+ from morphogen._utils import check_fraction, check_positive, exactly_one
15
+ from morphogen.domain import Domain, Grid
16
+ from morphogen.image import VoxelImage
17
+ from morphogen.models.affine import (
18
+ ANISOTROPY,
19
+ Anisotropy,
20
+ anisotropy_from_config,
21
+ invariant_theory,
22
+ )
23
+ from morphogen.models.base import Microstructure, Model, param, register, register_kind
24
+ from morphogen.seeding import SeedLike, make_rng, seed_from_description
25
+
26
+ #: Spectral cut-off: modes with ``|k| * correlation_length`` above this are dropped
27
+ #: (the Gaussian spectrum is then below exp(-18) of its maximum).
28
+ K_CUTOFF = 6.0
29
+ #: Margin (in correlation lengths) added around non-periodic domains.
30
+ MARGIN = 3.0
31
+
32
+
33
+ def _half_space_modes(n_max: np.ndarray, box: np.ndarray, kmax: float):
34
+ """Integer wave vectors m (one of each pair ±m, m != 0) with |2 pi m / box| <= kmax."""
35
+ axes = [np.arange(-n, n + 1) for n in n_max]
36
+ mx, my, mz = np.meshgrid(*axes, indexing="ij")
37
+ m = np.stack([mx.ravel(), my.ravel(), mz.ravel()], axis=1)
38
+ half = (
39
+ (m[:, 0] > 0)
40
+ | ((m[:, 0] == 0) & (m[:, 1] > 0))
41
+ | ((m[:, 0] == 0) & (m[:, 1] == 0) & (m[:, 2] > 0))
42
+ )
43
+ m = m[half]
44
+ k = 2.0 * np.pi * m / box
45
+ keep = np.einsum("ij,ij->i", k, k) <= kmax * kmax
46
+ return m[keep], k[keep]
47
+
48
+
49
+ @register_kind
50
+ class GaussianField(Microstructure):
51
+ """Phase 1 = {Y > threshold} for a unit-variance Gaussian field Y.
52
+
53
+ Y is a finite sum of Fourier modes on the generation box (the domain if periodic,
54
+ the domain enlarged by 3 correlation lengths otherwise), so the same realization
55
+ can be evaluated exactly at any resolution.
56
+ """
57
+
58
+ kind = "gaussian_field"
59
+
60
+ def __init__(
61
+ self,
62
+ domain,
63
+ correlation_length,
64
+ threshold,
65
+ box_lower,
66
+ box_lengths,
67
+ mode_seed,
68
+ anisotropy=None,
69
+ **kwargs,
70
+ ):
71
+ super().__init__(domain, **kwargs)
72
+ #: The affine anisotropy of the covariance ``rho(|A^-1 h|)`` (None: isotropic)
73
+ self.anisotropy = anisotropy
74
+ self.correlation_length = float(correlation_length)
75
+ self.threshold = float(threshold)
76
+ self.box_lower = np.asarray(box_lower, dtype=float)
77
+ self.box_lengths = np.asarray(box_lengths, dtype=float)
78
+ self.mode_seed = mode_seed
79
+ self._modes = None
80
+
81
+ def modes(self):
82
+ """Integer wave vectors and complex amplitudes C_m: Y(x) = Re sum C_m exp(i k_m.x)."""
83
+ if self._modes is None:
84
+ ell = self.correlation_length
85
+ kmax = K_CUTOFF / ell
86
+ if self.anisotropy is None:
87
+ n_max = np.floor(kmax * self.box_lengths / (2.0 * np.pi)).astype(int)
88
+ m, k = _half_space_modes(n_max, self.box_lengths, kmax)
89
+ else: # the spectrum of Y(A^-1 x) at k is that of Y at A^T k, |A^T k| >= s_min |k|
90
+ reach = kmax / float(self.anisotropy.principal.min())
91
+ n_max = np.floor(reach * self.box_lengths / (2.0 * np.pi)).astype(int)
92
+ m, k = _half_space_modes(n_max, self.box_lengths, reach)
93
+ k = k @ self.anisotropy.matrix
94
+ keep = np.einsum("ij,ij->i", k, k) <= kmax * kmax
95
+ m, k = m[keep], k[keep]
96
+ spectrum = np.exp(-0.5 * ell * ell * np.einsum("ij,ij->i", k, k))
97
+ var = spectrum / spectrum.sum()
98
+ rng = np.random.default_rng(seed_from_description(self.mode_seed))
99
+ a = rng.standard_normal(len(m))
100
+ b = rng.standard_normal(len(m))
101
+ # A cos + B sin = Re[(A - iB) e^{i k.x}]
102
+ amplitudes = np.sqrt(var) * (a - 1j * b)
103
+ self._modes = (m, amplitudes)
104
+ return self._modes
105
+
106
+ def field(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
107
+ """Values of the unit-variance Gaussian field at the voxel centres (float32)."""
108
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
109
+ m, amp = self.modes()
110
+ if len(m) == 0:
111
+ raise ValueError("gaussian_excursion: correlation length too large for the box")
112
+ x0 = grid.origin + 0.5 * grid.spacing - self.box_lower
113
+ aligned = self.domain.periodic and np.all(np.array(grid.shape) > 2 * np.abs(m).max(axis=0))
114
+ if aligned:
115
+ data = self._field_fft(grid, m, amp, x0)
116
+ else:
117
+ data = self._field_separable(grid, m, amp, x0)
118
+ return VoxelImage.from_grid(data, grid, name="field", metadata=self.image_metadata())
119
+
120
+ def _field_fft(self, grid, m, amp, x0):
121
+ # Y_j = Re sum_m C_m e^{i k_m.x0} e^{2 i pi m.j / n}: one inverse FFT on the grid
122
+ k = 2.0 * np.pi * m / self.box_lengths
123
+ coef = amp * np.exp(1j * (k @ x0))
124
+ n = np.array(grid.shape)
125
+ spec = np.zeros(tuple(n), dtype=np.complex128)
126
+ idx = np.mod(m, n)
127
+ np.add.at(spec, (idx[:, 0], idx[:, 1], idx[:, 2]), coef)
128
+ y = sfft.ifftn(spec, workers=settings.workers()) * spec.size
129
+ return np.ascontiguousarray(y.real, dtype=np.float32)
130
+
131
+ def _field_separable(self, grid, m, amp, x0):
132
+ # dense coefficient block, contracted axis by axis with exp(i k_a x_a), the axes of
133
+ # fewest voxels first: a plane contracts its normal first, which keeps the blocks
134
+ # to the size of the plane (x, y, z in turn for a cube)
135
+ n_max = np.abs(m).max(axis=0)
136
+ dense = np.zeros(tuple(2 * n_max + 1), dtype=np.complex128)
137
+ dense[m[:, 0] + n_max[0], m[:, 1] + n_max[1], m[:, 2] + n_max[2]] = amp
138
+ order = [int(a) for a in np.argsort(grid.shape, kind="stable")]
139
+ out = np.transpose(dense, order)
140
+ for axis in order:
141
+ ma = np.arange(-n_max[axis], n_max[axis] + 1)
142
+ xa = x0[axis] + np.arange(grid.shape[axis]) * grid.spacing[axis]
143
+ e = np.exp(2j * np.pi * np.outer(ma, xa) / self.box_lengths[axis])
144
+ out = np.tensordot(out, e, axes=([0], [0])) # contracted axis moves to the end
145
+ return np.ascontiguousarray(np.transpose(out.real, np.argsort(order)), dtype=np.float32)
146
+
147
+ def voxelize(self, shape=None, *, voxel_size=None, grid: Grid | None = None, supersampling=1):
148
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
149
+ ss = int(supersampling)
150
+ if not 1 <= ss <= 6:
151
+ raise ValueError("supersampling must be an integer between 1 and 6")
152
+ if ss == 1:
153
+ data = (self.field(grid=grid).data > self.threshold).astype(np.uint8)
154
+ return VoxelImage.from_grid(data, grid, name="phase", metadata=self.image_metadata())
155
+ fine = Grid(grid.domain, tuple(n * ss for n in grid.shape))
156
+ inside = (self.field(grid=fine).data > self.threshold).astype(np.float32)
157
+ nx, ny, nz = grid.shape
158
+ data = inside.reshape(nx, ss, ny, ss, nz, ss).mean(axis=(1, 3, 5), dtype=np.float32)
159
+ return VoxelImage.from_grid(data, grid, name="fraction", metadata=self.image_metadata())
160
+
161
+ def values_at(self, points) -> np.ndarray:
162
+ """The Gaussian field ``Y`` at points of space (rows): the sum of its modes."""
163
+ from morphogen.kernels.implicit import fourier_points
164
+
165
+ m, amp = self.modes()
166
+ if len(m) == 0:
167
+ raise ValueError("gaussian_excursion: correlation length too large for the box")
168
+ pts = np.ascontiguousarray(points, dtype=float).reshape(-1, 3)
169
+ out = np.empty(len(pts))
170
+ fourier_points(np.ascontiguousarray(m, dtype=np.int64), np.ascontiguousarray(amp.real),
171
+ np.ascontiguousarray(amp.imag), self.box_lengths, self.box_lower, pts,
172
+ out) # fmt: skip
173
+ return out
174
+
175
+ def contains(self, points) -> np.ndarray:
176
+ return self.values_at(points) > self.threshold
177
+
178
+ def level_set_at(self, points, reach: float = np.inf) -> np.ndarray:
179
+ """``(threshold - Y) * correlation_length`` at the points, as :meth:`level_set`."""
180
+ return (self.threshold - self.values_at(points)) * self.correlation_length
181
+
182
+ @property
183
+ def lipschitz(self) -> float:
184
+ """A bound of the slope of :meth:`level_set_at` (three times the root mean square
185
+ of the gradient of ``Y``, times the correlation length)."""
186
+ m, amp = self.modes()
187
+ k = 2.0 * np.pi * m / self.box_lengths
188
+ rms = np.sqrt(np.sum(np.abs(amp) ** 2 * np.einsum("ij,ij->i", k, k)))
189
+ return float(3.0 * rms * self.correlation_length)
190
+
191
+ def level_set(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
192
+ """``(threshold - Y) * correlation_length``: negative in phase 1, roughly a distance
193
+ near the interface."""
194
+ f = self.field(shape, voxel_size=voxel_size, grid=grid)
195
+ data = (self.threshold - f.data) * np.float32(self.correlation_length)
196
+ return f.with_data(data.astype(np.float32), name="level_set")
197
+
198
+ def summary(self) -> dict:
199
+ return {"n_modes": len(self.modes()[0])}
200
+
201
+ def _geometry(self) -> dict:
202
+ out = {
203
+ "correlation_length": self.correlation_length,
204
+ "threshold": self.threshold,
205
+ "box_lower": self.box_lower.tolist(),
206
+ "box_lengths": self.box_lengths.tolist(),
207
+ "mode_seed": self.mode_seed,
208
+ }
209
+ if self.anisotropy is not None:
210
+ out["anisotropy"] = self.anisotropy.to_config()
211
+ return out
212
+
213
+ @classmethod
214
+ def _from_geometry(cls, domain, geometry, **kwargs):
215
+ return cls(
216
+ domain,
217
+ geometry["correlation_length"],
218
+ geometry["threshold"],
219
+ geometry["box_lower"],
220
+ geometry["box_lengths"],
221
+ geometry["mode_seed"],
222
+ anisotropy_from_config(geometry.get("anisotropy")),
223
+ **kwargs,
224
+ )
225
+
226
+
227
+ @register
228
+ @dataclass(frozen=True)
229
+ class GaussianExcursion(Model):
230
+ """Excursion set {Y > threshold} of a Gaussian field with covariance exp(-h^2 / 2 l^2).
231
+
232
+ Give the volume fraction ``p`` of the excursion (threshold ``Phi^-1(1 - p)``) or the
233
+ threshold itself. Periodic boxes should be at least ~10 correlation lengths wide. An
234
+ ``anisotropy`` puts the metric of :mod:`morphogen.models.affine` in the covariance,
235
+ ``rho(|A^-1 h|)``: correlation lengths ``s_i l`` along its principal axes, in periodic
236
+ boxes too, whatever the axes (the modes of the box weighted by the spectrum at
237
+ ``A^T k``).
238
+ """
239
+
240
+ name = "gaussian_excursion"
241
+ phases: ClassVar[dict[int, str]] = {0: "phase 0", 1: "excursion"}
242
+
243
+ correlation_length: float = param(
244
+ 1.0, doc="Correlation length l of the Gaussian covariance", unit="length"
245
+ )
246
+ volume_fraction: float | None = param(
247
+ None, doc="Volume fraction of the excursion", kind="fraction"
248
+ )
249
+ threshold: float | None = param(None, doc="Level of the excursion {Y > threshold}")
250
+ anisotropy: Anisotropy | None = param(None, doc=ANISOTROPY, kind="anisotropy", kw_only=True)
251
+
252
+ def _validate(self) -> None:
253
+ check_positive(self.correlation_length, "correlation_length")
254
+ exactly_one("volume_fraction", self.volume_fraction, "threshold", self.threshold)
255
+ if self.volume_fraction is not None:
256
+ check_fraction(self.volume_fraction, "volume_fraction")
257
+
258
+ @property
259
+ def level(self) -> float:
260
+ if self.threshold is not None:
261
+ return self.threshold
262
+ return float(stats.norm.isf(self.volume_fraction))
263
+
264
+ def generate(self, domain: Domain, seed: SeedLike = None) -> GaussianField:
265
+ rng, seed_info = make_rng(seed)
266
+ ell = self.correlation_length
267
+ a = None if self.anisotropy is None or self.anisotropy.is_identity else self.anisotropy
268
+ reach = ell if a is None else ell * float(a.principal.max())
269
+ if domain.periodic:
270
+ lower, lengths = domain.lower, domain.lengths
271
+ else:
272
+ lower = domain.lower - MARGIN * reach
273
+ lengths = domain.lengths + 2.0 * MARGIN * reach
274
+ # the modes are drawn from a child seed so that they can be regenerated lazily
275
+ mode_seed = {"entropy": int(rng.integers(0, 2**63)), "spawn_key": []}
276
+ return GaussianField(
277
+ domain, ell, self.level, lower, lengths, mode_seed, a, model=self, seed=seed_info
278
+ )
279
+
280
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
281
+ lam = self.level
282
+ p = float(stats.norm.sf(lam))
283
+ # second spectral moment -rho''(0) of the covariance: 1 / l^2
284
+ lam2 = 1.0 / self.correlation_length**2
285
+ g = math.exp(-0.5 * lam**2)
286
+ out = {
287
+ "threshold": lam,
288
+ "volume_fraction": p,
289
+ "specific_surface": 2.0 / math.pi * math.sqrt(lam2) * g,
290
+ # Adler's Gaussian kinematic formulae: 2 pi times the Euler density of the
291
+ # plane sections, and the Euler density of the excursion
292
+ "mean_curvature_density": lam2 / math.sqrt(2.0 * math.pi) * lam * g,
293
+ "euler_density": lam2**1.5 / (4.0 * math.pi**2) * (lam**2 - 1.0) * g,
294
+ "integral_range": self.integral_range(),
295
+ "variance_exponent": 1.0,
296
+ }
297
+ if self.anisotropy is not None and not self.anisotropy.is_identity:
298
+ out = invariant_theory(out)
299
+ return out
300
+
301
+ def covariance(self, h) -> np.ndarray:
302
+ """C(h) = P(Y(x) > l, Y(x + h) > l) with rho(h) = exp(-h^2 / 2 l^2)."""
303
+ h = np.asarray(h, dtype=float)
304
+ rho = np.exp(-0.5 * (h / self.correlation_length) ** 2)
305
+ return theory.bivariate_normal_upper(self.level, rho)
306
+
307
+ def integral_range(self) -> float:
308
+ lam = self.level
309
+ p = float(stats.norm.sf(lam))
310
+
311
+ def f(h):
312
+ return float(self.covariance(h)) - p * p
313
+
314
+ return theory.radial_integral(f, 8.0 * self.correlation_length) / (p * (1.0 - p))