suvm-voxelize.1 (2898B)
1 .\" Copyright (C) 2020-2023, 2025-2026 |Méso|Star> (contact@meso-star.com) 2 .\" 3 .\" This program is free software: you can redistribute it and/or modify 4 .\" it under the terms of the GNU General Public License as published by 5 .\" the Free Software Foundation, either version 3 of the License, or 6 .\" (at your option) any later version. 7 .\" 8 .\" This program is distributed in the hope that it will be useful, 9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of 10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 .\" GNU General Public License for more details. 12 .\" 13 .\" You should have received a copy of the GNU General Public License 14 .\" along with this program. If not, see <http://www.gnu.org/licenses/>. 15 .Dd February 20, 2025 16 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 17 .Dt SUVM-VOXELIZE 1 18 .Os 19 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 20 .Sh NAME 21 .Nm suvm-voxelize 22 .Nd voxelize a tetrahedral mesh 23 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 24 .Sh SYNOPSIS 25 .Nm 26 .Op Fl hnv 27 .Op Fl d Ar x , Ns Ar y , Ns Ar z 28 .Op Fl o Ar output 29 .Op Ar input 30 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 31 .Sh DESCRIPTION 32 .Nm 33 voxelize a tetrahedral mesh stored in the 34 .Xr smsh 5 35 file format. 36 Generated voxels are parallelepipeds saved in VTK format. 37 Each voxel stores the number of tetrahedra covering it. 38 .Pp 39 If input is not defined, the mesh is read from standard input. 40 .Pp 41 The options are as follows: 42 .Bl -tag -width Ds 43 .It Fl d Ar x , Ns Ar y , Ns Ar z 44 definition of voxelization along the 3 axes. 45 Default is 64,64,64. 46 .It Fl h 47 Display short help and exit. 48 .It Fl n 49 pre-calculate tetrahedron normals. 50 This should speed up voxelization speed by calculating normals once and 51 for all, rather than re-evaluating them each time a tetrahedron is 52 tested against a voxel. 53 On the other hand, the memory space used to store normals increases the 54 memory footprint. 55 .It Fl o Ar output 56 Output file. 57 Voxels are stored in VTK format. 58 If not defined, data is written to standard output. 59 .It Fl v 60 Make 61 .Nm 62 verbose. 63 .El 64 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 65 .Sh EXIT STATUS 66 .Ex -std 67 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 68 .Sh EXAMPLES 69 Voxelize 70 .Pa volumic_mesh.smsh 71 and save the results in 72 .Pa voxels.vtk : 73 .Bd -literal -offset Ds 74 suvm-voxelize -o voxels.vtk volumic_mesh.smsh 75 .Ed 76 .Pp 77 Same as above but with a voxelization definition of 256^3: 78 .Bd -literal -offset Ds 79 suvm-voxelize -d256,256,256 -o voxels.vtk volumic_mesh.smsh 80 .Ed 81 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 82 .Sh SEE ALSO 83 .Xr smsh 5 84 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 85 .Sh STANDARDS 86 .Rs 87 .%B The VTK User's Guide 88 .%O Simple Legacy Formats 89 .%I Kitware, Inc 90 .%N 11 91 .%D 2010 92 .%P 470--482 93 .Re