man(7)

πŸ’– NAME πŸ’–

cgalmesh β€” bestie, it turns your 3D volumetric image into a 3D mesh, and it's giving iconic

This one's from the man manual, section 7, so it's a real miscellaneous girly. πŸŽ€


✨ SYNOPSIS ✨

cgalmesh input.inr output.mesh <angle|30> <surf-size|6> <approx|4> <rad-
edge-ratio|3> <tetra-size|8> <randomseed|-1>

okay so you just hand it your files and then a little parade of optional numbers walks behind them, and literally every one of those numbers already has a default so you can absolutely just ghost the extras, no cap 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

The cgalmesh utility is a volume-to-tetrahedral-mesh converter based on the CGAL library (http://cgal.org). Not me hyping up a library but it really can:

  • read a binary, multi-labled or gray-scale based 3D volumetric image 😌
  • and spit out a tetrahedral mesh that conforms to the volume πŸ”₯
  • with each region labeled correspondingly to the volume labels πŸ‘‘
yes bestie, "multi-labled" is spelled exactly like that in the original, I'm not touching it, it's canon πŸ’…

Please see https://doc.cgal.org/latest/Mesh_3/ for details regarding the underlying algorithm. That's the deep lore, go read it if you want the ✨why✨ and not just the πŸ’–whatπŸ’–.


🌸 OPTIONS 🌸

This program accepts the following input parameters:

  • input.inr|(required) β€” The input data file in the INR format. no file, no mesh, it's the main character here πŸ₯Ί
  • output.mesh|(required) β€” The output mesh file in the MEDIT format. this is where your lil tetrahedrons get to live ✨
  • angle|(optional, default: 30) β€” Lower-bound of the angles (in degree) in surface triangles. degrees bestie, not radians, we're not doing that today πŸ“
  • surf-size|(optional, default: 6) β€” Lower-bound of the edge-length (in voxel unit) in surface triangles. measured in voxel units btw 🧚
  • approx|(optional, default: 4) β€” Upper-bound of the deviation distance (in voxel unit) of the surface triangles to the voxelated boundaries. again, voxel units, keep up πŸ“
  • rad-edge-ratio|(optional, default: 3) β€” Upper-bound of the radius-to-edge ratio of the surface triangles. yes it's a ratio, no units needed, we stan a dimensionless queen πŸ’…
  • tetra-size|(optional, default: 8) β€” Lower-bound of the tetrahedron volume (in voxel^3) of the 3D mesh. note the voxel^3, cubed bestie, volume is a three-dimensional situation 😭
  • randomseed|(optional, default: -1) β€” Random number generator seed (large positive integer, -1 to use system clock). so if you want the same vibes twice, feed it a big positive integer; if you want chaos, leave it at -1 and let the clock decide πŸ™ˆ
reminder that every single one of those after the first two is optional and already has a default, so the minimum viable command is literally just the two file names πŸ’–

πŸ”₯ SEE ALSO πŸ”₯

iykyk, the whole friend group 🫢


πŸ‘‘ AUTHOR πŸ‘‘

Qianqian Fang (fangqq@gmail.com) and Peter Varga β€” absolute legends, we thank them for their service πŸ’œ


and that's the whole page bestie!! 🌈 version 1.0, dated 30 June 2020, living in the man(7) manual β€” periodt. πŸ’…βœ¨