Changeset 2987 for branch

Timestamp:

Aug 9, 2017 4:39:05 PM (6 years ago)

Author:

odonnell

Message:

added some HAP documentation to GSASIIobj

File:

• branch/2frame/GSASIIobj.py (modified) (1 diff)

branch/2frame/GSASIIobj.py

@@ -256 +256 @@
                              dict contains the combined phase/histogram
                              parameters for items such as scale factors,
-                             size and strain parameters. (dict)
+                             size and strain parameters. The following are the
+                             keys to the inner dict. (dict)
+\           Babinet          Dictionary with two entries, 'BabA', 'BabU'
+\           Extinction       Extinction parameter (list of float, bool)
+\           HStrain          Hydrostatic strain. List of two lists. The first is
+                             a list of the HStrain parameters (1-3 depending on
+                             unit cell), the second is a list of boolean
+                             refinement parameters (same length)
+\           Histogram        The name of the associated histogram (str)
+\           LeBail           Flag for LeBail extraction (bool)
+\           Mustrain         List of microstrain parameters, in order:
+
+                               0. Type, one of u'generalized', u'isotropic',
+                                  u'uniaxial'
+                               1. Isotropic/uniaxial parameters - list of 3 floats
+                               2. Refinement flags - list of 3 bools
+                               3. Microstrain axis - list of 3 ints, [h, k, l]
+                               4. Generalized mustrain parameters - list of 2-6
+                                  floats, depending on space group
+                               5. Generalized refinement flags - list of bools,
+                                  corresponding to the parameters of (4)
+\           Pref.Ori.        Preferred Orientation. List of eight parameters, in order:
+
+                               0. Type, 'MD' for March-Dollase or 'SH' for
+                                  Spherical Harmonics
+                               1. Value, float
+                               2. Refinement flag, bool
+                               3. Preferred direction, list of ints, [h, k, l]
+                               4. int
+                               5. dict
+                               6. list
+                               7. float
+\           Scale            Phase fraction, list of [float, bool]
+\           Show
+\           Use              bool
+\           newLeBail        Whether to perform a new LeBail extraction
 MCSA            \            Monte-Carlo simulated annealing parameters (dict)
 \