htrdr-materials.5 (3069B)
1 .\" Copyright (C) 2018-2019, 2022-2025 Centre National de la Recherche Scientifique 2 .\" Copyright (C) 2020-2022 Institut Mines Télécom Albi-Carmaux 3 .\" Copyright (C) 2022-2025 Institut Pierre-Simon Laplace 4 .\" Copyright (C) 2022-2025 Institut de Physique du Globe de Paris 5 .\" Copyright (C) 2018-2025 |Méso|Star> (contact@meso-star.com) 6 .\" Copyright (C) 2022-2025 Observatoire de Paris 7 .\" Copyright (C) 2022-2025 Université de Reims Champagne-Ardenne 8 .\" Copyright (C) 2022-2025 Université de Versaille Saint-Quentin 9 .\" Copyright (C) 2018-2019, 2022-2025 Université Paul Sabatier 10 .\" 11 .\" This program is free software: you can redistribute it and/or modify 12 .\" it under the terms of the GNU General Public License as published by 13 .\" the Free Software Foundation, either version 3 of the License, or 14 .\" (at your option) any later version. 15 .\" 16 .\" This program is distributed in the hope that it will be useful, 17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of 18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 .\" GNU General Public License for more details. 20 .\" 21 .\" You should have received a copy of the GNU General Public License 22 .\" along with this program. If not, see <http://www.gnu.org/licenses/>. 23 .Dd October 5, 2023 24 .Dt HTRDR-MATERIALS 5 25 .Os 26 .Sh NAME 27 .Nm htrdr-materials 28 .Nd materials list format 29 .Sh DESCRIPTION 30 A 31 .Nm 32 file lists materials in plain text. 33 Each line of the file gives the name of the material. 34 For opaque materials, the material name is followed by the path to a 35 file storing the spectral properties of the associated Bidirectional 36 Reflectance Distribution Function 37 .Pq BRDF , 38 saved in 39 .Xr mrumtl 5 40 format. 41 The material temperature is defined as the last parameter in the line, 42 after the BRDF file mentioned above. 43 .Pp 44 The material name can be composed of any character except spaces and 45 tabs. 46 The path to the 47 .Xr mrumtl 5 48 file must be a valid absolute path in the file system. 49 .Pp 50 Text after the 51 .Li \&# 52 character is considered a comment and is therefore ignored, as are empty 53 lines. 54 .Pp 55 The file format is as follows: 56 .Bl -column (htrdr-materials) (::=) () 57 .It Ao Va htrdr-materials Ac Ta ::= Ta Ao Va material Ac 58 .It Ta Ta Va ... 59 .It Ao Va material Ac Ta ::= Ta Ao Va name Ac Ao Va properties Ac 60 .It Ao Va properties Ac Ta ::= Ta Li none No \&| 61 .Aq Va brdf 62 .Aq Va temperature 63 .It Ao Va brdf Ac Ta ::= Ta Pa path 64 # mrumtl file 65 .It Ao Va temperature Ac Ta ::= Ta Va real 66 # In Kelvin 67 .El 68 .Sh EXAMPLES 69 The following file lists 3 materials. 70 The first, 71 .Va grass , 72 has its spectral BRDF defined in file 73 .Pa A001.mrumtl . 74 The second, named 75 .Va sand , 76 has its spectral properties recorded in file 77 .Pa B002.mrumtl . 78 Both materials have a temperature of 79 .Va 300 80 Kelvin. 81 The final material is a semi-transparent material named 82 .Va air 83 with no additional properties defined in this file: 84 .Bd -literal -offset -Ds 85 grass /opt/materials/A001.mrumtl 300 86 sand /opt/materials/B002.mrumtl 300 87 air none 88 .Ed 89 .Sh SEE ALSO 90 .Xr mrumtl 5 91 .Sh HISTORY 92 The 93 .Nm 94 format was first developed for the 95 .Xr htrdr 1 96 program.