Skip to content

Commit 51081d0

Browse files
author
Emmanuel FARHI
committed
mcxtrace: PowderN: reorder parameters in docdoc
1 parent 2ec44d2 commit 51081d0

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

mcxtrace-comps/samples/PowderN.comp

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -138,28 +138,27 @@
138138
* reflections: [str] Input file for reflections (LAZ LAU CIF, FullProf, ShelX). Use only incoherent scattering if NULL or "".
139139
*
140140
* Optional parameters:
141-
* d_phi: [deg] Angle corresponding to the vertical angular range to focus to, e.g. detector height. 0 for no focusing.
141+
* barns: [1] Flag to indicate if |F|^2 from 'reflections' is in barns or fm^2, (barns=1 for laz/cif, barns=0 for lau type files).
142+
* concentric: [1] Indicate that this component has a hollow geometry and may contain other components. It should then be duplicated after the inside part (only for box, cylinder, sphere).
142143
* d_omega: [deg] Horizontal focus range (only for incoherent scattering), 0 for no focusing.
143-
* tth_sign: [1] Sign of the scattering angle. If 0, the sign is chosen randomly (left and right). ONLY functional in combination with d_phi and ONLY applies to bragg lines.
144-
* focus_flip: [1] Controls the sense of d_phi. If 0 d_phi is measured against the xz-plane. If !=0 d_phi is measured against zy-plane.
145-
* tth_sign: [1] Sign of the scattering angle. If 0, the sign is chosen randomly (left and right).
146-
* pack: [1] Packing factor
144+
* d_phi: [deg] Angle corresponding to the vertical angular range to focus to, e.g. detector height. 0 for no focusing.
147145
* delta_d_d: [1] Global relative Delta_d/d spreading when the 'w' column is not available. Use 0 if ideal.
146+
* density: [g/cm^3] Density of material. rho=density/weight/1e24*N_A.
147+
* DW: [1] Global Debye-Waller factor when the 'DW' column is not available. Use 1 if included in F2.
148+
* focus_flip: [1] Controls the sense of d_phi. If 0 d_phi is measured against the xz-plane. If !=0 d_phi is measured against zy-plane.
148149
* format: [{}] Name of the format, or list of column indexes (see Description). N.b. no quotes!
150+
* geometry: [str] Name of an Object File Format (OFF) or PLY file for complex geometry. The OFF/PLY file may be generated from XYZ coordinates using qhull/powercrust.
151+
* mat_format: [{}] Format of the asorption parameter file.
152+
* material: [Be.txt] File where the material parameters for the absorption may be found. Format is similar to what may be found off the NIST website.
153+
* nb_atoms: [1] Number of sub-unit per unit cell, that is ratio of sigma for chemical formula to sigma per unit cell.
149154
* p_inc: [1] Fraction of incoherently scattered rays.
150-
* p_transmit: [1] Fraction of transmitted (only attenuated) rays.
151155
* p_interact: [1] Fraction of events interacting with sample, e.g. 1-p_transmit-p_inc.
152-
* concentric: [1] Indicate that this component has a hollow geometry and may contain other components. It should then be duplicated after the inside part (only for box, cylinder, sphere).
153-
* geometry: [str] Name of an Object File Format (OFF) or PLY file for complex geometry. The OFF/PLY file may be generated from XYZ coordinates using qhull/powercrust.
154-
* barns: [1] Flag to indicate if |F|^2 from 'reflections' is in barns or fm^2, (barns=1 for laz, barns=0 for lau type files).
156+
* p_transmit: [1] Fraction of transmitted (only attenuated) rays.
157+
* pack: [1] Packing factor
158+
* target_index: [1] Relative index of component to focus incoherent scattering at, e.g. next is +1
159+
* tth_sign: [1] Sign of the scattering angle. If 0, the sign is chosen randomly (left and right). ONLY functional in combination with d_phi and ONLY applies to bragg lines.
155160
* Vc: [AA^3] Volume of unit cell=nb atoms per cell/density of atoms.
156-
* DW: [1] Global Debye-Waller factor when the 'DW' column is not available. Use 1 if included in F2.
157161
* weight: [g/mol] Atomic/molecular weight of material.
158-
* density: [g/cm^3] Density of material. rho=density/weight/1e24*N_A.
159-
* nb_atoms: [1] Number of sub-unit per unit cell, that is ratio of sigma for chemical formula to sigma per unit cell.
160-
* material: [Be.txt] File where the material parameters for the absorption may be found. Format is similar to what may be found off the NIST website.
161-
* mat_format: [{}] Format of the asorption parameter file.
162-
* target_index: [1] Relative index of component to focus incoherent scattering at, e.g. next is +1
163162
*
164163
* CALCULATED PARAMETERS:
165164
* line_info: [struct] Internal structure containing many members/info

0 commit comments

Comments
 (0)