man(7)

💖 cgalsurf — the manual, but make it make sense 💖

hey bestie, this is the man(7) page for cgalsurf 🫶 it's a Unix manual page, section 7, and it's about pulling 3D surfaces out of 3D images. grab a snack, we're doing this. 🍓

✨ NAME ✨

cgalsurf — 3D surface mesh extraction from volumetric image 🦋

✨ SYNOPSIS ✨

cgalsurf input.inr threshold x0 y0 z0 r2 angle surf-size approx maxnode output.off <randomseed> <init-size>

✨ DESCRIPTION ✨

so like, the cgalsurf utility does the thing where it extracts a surface mesh at a specified threshold (that's a level-set, iykyk) out of a volumetric image — and the image can be in binary or gray-scale values. it does this using the CGAL library (http://cgal.org) 💅 and it's adapted based on the 3D surface generation demo in the CGAL package.

if you want the actual tea on the underlying algorithm, go peep https://doc.cgal.org/latest/Surface_mesher/ ✨

✨ OPTIONS ✨

this program accepts the following input parameters — all but the last two parameters are required, no cap:

• input.inr — the input volumetric image in the INR format 💾
• threshold — a number representing the threshold at which the surface is extracted
• x0 — the bounding sphere center's x-coordinate
• y0 — the bounding sphere center's y-coordinate
• z0 — the bounding sphere center's y-coordinate 🙈 (yes bestie, the page literally says y-coordinate here for z0, i'm not making this up, that's what it says)
• r2 — the bounding sphere's radius squared ⭐
• angle — lower-bound of the angles (in degree) in surface triangles
• surf-size — lower-bound of the edge-length (in voxel unit) in surface triangles
• approx — upper-bound of the deviation distance (in voxel unit) of the surface triangles to the voxelated boundaries
• maxnode — upper-bound of the node numbers in the output mesh
• output.off — output surface mesh in the OFF format 📤
• randomseed | (optional, default: -1) — random number generator seed (a large positive integer, or -1 to use the system clock ⏰)
• init-size | (optional) — the number of nodes in the initial surface (sampled on the bounding sphere)

and also, lowkey, these other pages exist if you wanna go down a rabbit hole: cgalmesh(7), cgalsimp2(7), cgalpoly(7), cork(7), meshfix(7), jmeshlib(7) 🌈

✨ AUTHOR ✨

Laurent Rineau, Mariette Yvinec, and Qianqian Fang (fangqq@gmail.com) 👑

okay that's the whole page, you ate that. 💅✨ this was the cgalsurf page from the cgalsurf man page set, version 1.0, dated 30 June 2020. go forth and mesh something iconic, bestie 🎀🦋💖