schiff

Estimate the radiative properties of soft particless
git clone git://git.meso-star.com/schiff.git
Log | Files | Refs | README | LICENSE

schiff-output.5 (9667B)


      1 .\" Copyright (C) 2015, 2016, 2026 Centre National de la Recherche Scientifique
      2 .\" Copyright (C) 2026 Clermont Auvergne INP
      3 .\" Copyright (C) 2026 Institut Mines Télécom Albi-Carmaux
      4 .\" Copyright (C) 2017, 2019-2021, 2026 |Méso|Star> (contact@meso-star.com)
      5 .\" Copyright (C) 2026 Université de Lorraine
      6 .\" Copyright (C) 2026 Université de Toulouse
      7 .\"
      8 .\" This program is free software: you can redistribute it and/or modify
      9 .\" it under the terms of the GNU General Public License as published by
     10 .\" the Free Software Foundation, either version 3 of the License, or
     11 .\" (at your option) any later version.
     12 .\"
     13 .\" This program is distributed in the hope that it will be useful,
     14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     16 .\" GNU General Public License for more details.
     17 .\"
     18 .\" You should have received a copy of the GNU General Public License
     19 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     20 .Dd May 18, 2026
     21 .Dt SCHIFF-OUTPUT 5
     22 .Os
     23 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     24 .Sh NAME
     25 .Nm schiff-output
     26 .Nd schiff's results format
     27 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     28 .Sh DESCRIPTION
     29 The output result of the
     30 .Xr schiff 1
     31 program is a collection of ASCII floating point data.
     32 Each set of floating point values are separated by an empty line.
     33 .Bl -column (invcumul-phase-func-list) (::=) ()
     34 .It Ao Va schiff-output Ac Ta ::= Ta Aq Va cross-sections
     35 .It Ta Ta EMPTY-LINE
     36 .It Ta Ta Aq Va phase-func-desc
     37 .It Ta Ta EMPTY-LINE
     38 .It Ta Ta Aq Va phase-func-list
     39 .It Ta Ta EMPTY-LINE
     40 .It Ta Ta Aq Va cumul-phase-func-list
     41 .It Ta Ta EMPTY-LINE
     42 .It Ta Ta Aq Va invcumul-phase-func-list
     43 .It Ta Ta EMPTY-LINE
     44 .El
     45 .\""""""""""""""""""""""""""""""""""
     46 .Ss Cross sections
     47 The first set is a list of per wavelength cross-sections.
     48 Each line stores the estimated cross-section for a wavelength submitted
     49 by the
     50 .Fl w
     51 option of
     52 .Xr schiff 1 .
     53 .Pp
     54 Its grammar is as follows:
     55 .Bl -column (invcumul-phase-func-list) (::=) ()
     56 .It Ao Va cross-sections Ac Ta ::= Ta
     57 .Aq Va wavelength
     58 .Aq Va extinction
     59 \e
     60 .It Ta Ta
     61 .Aq Va absorption
     62 .Aq Va scattering
     63 .Aq Va area
     64 .It Ta Ta ...
     65 .It \  Ta Ta
     66 .It Ao Va extinction Ac Ta ::= Ta Aq Va estimation
     67 .It Ao Va absorption Ac Ta ::= Ta Aq Va estimation
     68 .It Ao Va scattering Ac Ta ::= Ta Aq Va estimation
     69 .It Ao Va area Ac Ta ::= Ta  Aq Va estimation
     70 .It \  Ta Ta
     71 .It Ao Va estimation Ac Ta ::= Ta
     72 .Aq Va mean-value
     73 .Aq Va standard-error
     74 .It \  Ta Ta
     75 .It Ao Va wavelength Ac Ta ::= Ta Vt real
     76 .It Ao Va mean-value Ac Ta ::= Ta Vt real
     77 .It Ao Va standard-error Ac Ta ::= Ta Vt real
     78 .El
     79 .Pp
     80 A line is a set of 9 reals: a
     81 .Ql wavelength
     82 in vacuum
     83 .Pq in microns ,
     84 followed by the estimations
     85 .Pq i.e., the mean values and standard errors
     86 of the
     87 .Ql extinction ,
     88 .Ql absorption
     89 and
     90 .Ql scattering
     91 cross-sections in square microns per particle, and finally the
     92 estimation of the projected
     93 .Ql area
     94 of the soft particles, also in square microns per particle.
     95 .\""""""""""""""""""""""""""""""""""
     96 .Ss Phase function descriptor
     97 Following the list of cross-sections comes the list of phase function
     98 descriptors.
     99 Each descriptor is a line that gives informations on the
    100 .Bq Bo inverse- Bc Ns cumulative
    101 phase functions.
    102 .Pp
    103 Its grammar is as follows:
    104 .Bl -column (invcumul-phase-func-list) (::=) ()
    105 .It Ao Va phase-funcs-desc Ac Ta ::= Ta
    106 .Aq Va wavelength
    107 .Aq Va theta
    108 \e
    109 .It Ta Ta
    110 .Aq Va pf Ns Pq theta
    111 .Aq Va cdf Ns Pq theta
    112 \e
    113 .It Ta Ta
    114 .Aq Va n
    115 .Aq Va nangles
    116 .Aq Va nangles-inv
    117 .It Ta Ta ...
    118 .It \  Ta Ta
    119 .It Ao Va pf Ns Po theta Pc Ac Ta ::= Ta Aq Va estimation
    120 .It Ao Va cdf Ns Po theta Pc Ac Ta ::= Ta Aq Va estimation
    121 .El
    122 .Pp
    123 The first value of a descriptor is the wavelength in vacuum
    124 .Pq in microns
    125 of the inverse cumulative phase function.
    126 It is followed by
    127 .Ql theta
    128 that is the scattering angle in radians from which the phase function was
    129 analytically computed.
    130 Then come the estimation of the differential cross-section
    131 .Ql pf Ns Pq theta
    132 and its cumulative
    133 .Ql cdf Ns Pq theta
    134 at the angle
    135 .Ql theta .
    136 .Ql n
    137 is the parameter of the model used to analytically evaluate the phase
    138 function for large scattering angles
    139 .Pq i.e. angles greater than Ql theta .
    140 The last 2 values,
    141 .Ql nangles
    142 and
    143 .Ql nangles-inv ,
    144 are integers that correspond to the number of scattering angles
    145 .Pq option Fl a No of Xr schiff 1
    146 and the number of inverse cumulative phase function values
    147 .Pq option Fl A No of Xr schiff 1 .
    148 .\""""""""""""""""""""""""""""""""""
    149 .Ss List of phase functions
    150 The list of phase functions contains as many phase functions as there
    151 are wavelengths associated with the result
    152 .Pq option Fl w No of Xr schiff 1 .
    153 They are sorted in ascending order by their associated wavelengths.
    154 The phase functions are separated from one another by a blank line.
    155 .Bl -column (invcumul-phase-func-list) (::=) ()
    156 .It Ao Va phase-func-list Ac Ta ::= Ta \& \& Aq Va phase-func
    157 .It Ta Ta [\& EMPTY-LINE
    158 .It Ta Ta \& \& Ao Va phase-func Ac \& ] ...
    159 .El
    160 .Pp
    161 A phase function is a list of lines starting with a scattering angle in
    162 radians, followed by an estimate of the phase function's value - that
    163 is, its mean value and standard error.
    164 The number of scattering angles, and thus the number of lines describing
    165 the phase function, is controlled by the
    166 .Fl a
    167 option of
    168 .Xr schiff 1 .
    169 .Bl -column (invcumul-phase-func-list) (::=) ()
    170 .It Ao Va phase-func Ac Ta ::= Ta
    171 .Aq Va angle
    172 .Aq Va estimation
    173 .It Ta Ta ...
    174 .It Ao Va angle Ac Ta ::= Ta Vt real No # \&In [0,PI]
    175 .El
    176 .\""""""""""""""""""""""""""""""""""
    177 .Ss List of cumulative phase functions
    178 The list of cumulative phase functions is formatted in the same way as
    179 the list of phase functions, that is, it contains as many functions as
    180 there are wavelengths associated with the result
    181 .Pq option Fl w No of Xr schiff 1 ,
    182 sorted in ascending order of wavelength, and separated by a blank line.
    183 .Bl -column (invcumul-phase-func-list) (::=) ()
    184 .It Ao Va cumul-phase-func-list Ac Ta ::= Ta \& \& Aq Va cumul-phase-func
    185 .It Ta Ta [\& EMPTY-LINE
    186 .It Ta Ta \& \& Ao Va cumul-phase-func Ac \& ] ...
    187 .El
    188 .Pp
    189 Similarly, a cumulative phase function follows the same data structure
    190 as a phase function, namely as many lines as there are scattering angles
    191 .Pq see the Fl a No option of Xr schiff 1 ,
    192 where each line begins with the value of the scattering angle in radians
    193 followed by the estimate of the cumulative phase function, namely its
    194 mean value and standard error.
    195 .Bl -column (invcumul-phase-func-list) (::=) ()
    196 .It Ao Va cumul-phase-func Ac Ta ::= Ta
    197 .Aq Va angle
    198 .Aq Va estimation
    199 .It Ta Ta ...
    200 .El
    201 .\""""""""""""""""""""""""""""""""""
    202 .Ss List of inverse cumulative phase function
    203 The last data set consists of a list of inverse cumulative phase
    204 functions which, like the previous function lists, contains as many
    205 entries as there are wavelengths used in the calculation
    206 .Pq option Fl w No of Xr schiff 1 .
    207 The functions in this list are sorted in ascending order of these
    208 wavelengths, and separated by a blank line.
    209 .Bl -column (invcumul-phase-func-list) (::=) ()
    210 .It Ao Va invcumul-phase-func-list Ac Ta ::= Ta \
    211 \& \& Aq Va invcumul-phase-func
    212 .It Ta Ta [\& EMPTY-LINE
    213 .It Ta Ta \& \& Ao Va invcumul-phase-func Ac \& ] ...
    214 .El
    215 .Pp
    216 Each function corresponds to a list of lines, the number of which equals
    217 the number of scattering angles used to discretize the function
    218 .Pq option Fl A No in Xr schiff 1 .
    219 Each line of an inverse cumulative phase function contains two values:
    220 the scattering angle in radians
    221 .Pq in Bq 0,PI
    222 and its probability, which is equal to i/(N-1) for the i^th angle
    223 .Pq i in Bq 0,N-1 ,
    224 where N is the number of angles used to discretize the function.
    225 .Bl -column (invcumul-phase-func-list) (::=) ()
    226 .It Ao Va invcumul-phase-func Ac Ta ::= Ta
    227 .Aq Va angle
    228 .Aq Va proba
    229 .It Ta Ta ...
    230 .It \  Ta Ta
    231 .It Ao Va proba Ac Ta ::= Ta Vt real No # \&In [0,1]
    232 .El
    233 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    234 .Sh EXAMPLES
    235 The following output is emitted by the
    236 .Xr schiff 1
    237 program invoked on the wavelengths 0.3 and 0.6 micron.
    238 Note that actually,
    239 .Xr schiff 1
    240 does not write comments, i.e. text preceeded by the hash character
    241 .Pq # .
    242 The comments here are intended to help in the understanding of the data
    243 structure.
    244 .Bl -column -offset Ds
    245 .It 0.3 10.61 0.20 9.51e-3 2.37e-4 10.6 0.20 5.25 0.10 Em # X-sections
    246 .It 0.6 11.15 0.25 4.76e-3 1.19e-4 11.1 0.25 5.25 0.10 Em # X-sections
    247 .It 0.3 0.18 1.37 17.6 7.74 0.73 0.80 1000 2000 Em # Descriptor
    248 .It 0.6 0.26 9.81 5.26 7.65 0.48 2.90 1000 2000 Em # Descriptor
    249 .It 0 520.23 64.2971 Em # Phase function (0.3 micron)
    250 .It 0.00314474 474.315 50.6471
    251 .It     ...
    252 .It 3.13845 0.0196258 0
    253 .It 3.14159 0.0196259 0
    254 .It \&
    255 .It 0 150.183 25.4822 Em # Phase function (0.6 micron)
    256 .It 0.00314474 145.969 23.7955
    257 .It     ...
    258 .It 3.13845 0.00262338 0
    259 .It 3.14159 0.00262338 0
    260 .It \&
    261 .It 0 0 0 Em # Cumulative (0.3 micron)
    262 .It 0.00314474 0.0154297 0.00177366
    263 .It     ...
    264 .It 3.13845 0.999999 0
    265 .It 3.14159 1 0
    266 .It \&
    267 .It 0 0 0 Em # Cumulative (0.6 micron)
    268 .It 0.00314474 0.00460001 0.000765182
    269 .It     ...
    270 .It 3.13845 1 0
    271 .It 3.14159 1 0
    272 .It \&
    273 .It 0 0 Em # Inverse cumulative (0.3 micron)
    274 .It 0.00050025 0.000101956
    275 .It     ...
    276 .It 0.9995 3.05143
    277 .It 1 3.14159
    278 .It \&
    279 .It 0 0 Em # Inverse cumulative (0.6 micron)
    280 .It 0.00050025 0.00034199
    281 .It     ...
    282 .It 0.9995 2.89409
    283 .It 1 3.14159
    284 .El
    285 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    286 .Sh SEE ALSO
    287 .Xr schiff 1
    288 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    289 .Sh HISTORY
    290 .Nm
    291 has been developed as part of
    292 .Li ANR-11-IDEX-0002-02
    293 ALGUE project.