Changeset 981 for trunk/GSASIIobj.py


Ignore:
Timestamp:
Jul 7, 2013 9:58:08 AM (8 years ago)
Author:
toby
Message:

introduce regress option; fix esd printing; more docs; new Mac app with drag & drop for open; control reset of ref list on load

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIobj.py

    r963 r981  
    125125=============  ===============  ====================================================
    126126
    127 Phase Tree Item
     127Phase Tree Items
    128128----------------
    129129
     
    272272            Asymmetric unit coordinates [X is (x,y,z)]
    273273            are transformed using
    274             :math:`X\prime = M_n*X+T_n`
     274            :math:`X^\prime = M_n*X+T_n`
    275275SGSys       symmetry unit cell: type one of
    276276            'triclinic', 'monoclinic', 'orthorhombic',
     
    315315cia+2...cia+6     U11, U22, U33, U12, U13, U23
    316316==============   ====================================================
     317
     318Powder Diffraction Tree Items
     319-----------------------------
     320
     321.. _Powder_table:
     322
     323.. index::
     324   single: Powder data object description
     325   single: Data object descriptions; Powder Data
     326
     327Every powder diffraction histogram is stored in the GSAS-II data tree
     328with a top-level entry named beginning with the string "PWDR ". The
     329diffraction data for that information are directly associated with
     330that tree item and there are a series of children to that item. The
     331routine :func:`~GSASII.GSASII.GetUsedHistogramsAndPhasesfromTree` will
     332load this information into a dictionary where the child tree name is
     333used as a key, and the information in the main entry is assigned
     334a key of ``Data``, as outlined below.
     335
     336.. tabularcolumns:: |l|l|p{4in}|
     337
     338======================  ===============  ====================================================
     339  key                      sub-key        explanation
     340======================  ===============  ====================================================
     341Limits                       \            A list of two two element lists, as [[Ld,Hd],[L,H]]
     342                                          where L and Ld are the current and default lowest
     343                                          two-theta value to be used and
     344                                          where H and Hd are the current and default highest
     345                                          two-theta value to be used.
     346Reflection Lists              \           A dict with an entry for each phase in the
     347                                          histogram. The contents of each dict item
     348                                          is a list or reflections as described in the
     349                                          :ref:`Powder Reflections <PowderRefl_table>`
     350                                          description.
     351Instrument Parameters         \           A list containing two dicts where the possible
     352                                          keys in each dict are listed below. The value
     353                                          for each item is a list containing three values:
     354                                          the initial value, the current value and a
     355                                          refinement flag which can have a value of
     356                                          True, False or 0 where 0 indicates a value that
     357                                          cannot be refined. The first and second
     358                                          values are floats unless otherwise noted.
     359                                          Items in the first dict are noted as [1]
     360\                         Lam             Specifies a wavelength in Angstroms [1]
     361\                         Lam1            Specifies the primary wavelength in
     362                                          Angstrom, when an alpha1, alpha2
     363                                          source is used [1]
     364\                         Lam2            Specifies the secondary wavelength in
     365                                          Angstrom, when an alpha1, alpha2
     366                                          source is used [1]
     367                          I(L2)/I(L1)     Ratio of Lam2 to Lam1 [1]           
     368\                         Type            Histogram type (str) [1]:
     369                                           * 'PXC' for constant wavelength x-ray
     370                                           * 'PNC' for constant wavelength neutron
     371                                           * 'PNT' for time of flight neutron
     372\                         Zero            Two-theta zero correction in *degrees* [1]
     373\                         Azimuth         Azimuthal setting angle for data recorded
     374                                          with differing setting angles [1]
     375\                         U, V, W         Cagliotti profile coefficients
     376                                          for Gaussian instrumental broadening, where the
     377                                          FWHM goes as
     378                                          :math:`U \\tan^2\\theta + V \\tan\\theta + W` [1]
     379\                         X, Y            Cauchy (Lorentzian) instrumental broadening
     380                                          coefficients [1]
     381\                         SH/L            Variant of the Finger-Cox-Jephcoat asymmetric
     382                                          peak broadening ratio. Note that this is the
     383                                          average between S/L and H/L where S is
     384                                          sample height, H is the slit height and
     385                                          L is the goniometer diameter. [1]
     386\                         Polariz.        Polarization coefficient. [1]
     387wtFactor                      \           A weighting factor to increase or decrease
     388                                          the leverage of data in the histogram (float).
     389                                          A value of 1.0 weights the data with their
     390                                          standard uncertainties and a larger value
     391                                          increases the weighting of the data (equivalent
     392                                          to decreasing the uncertainties).
     393Sample Parameters             \           Specifies a dict with parameters that describe how
     394                                          the data were collected, as listed
     395                                          below. Refinable parameters are a list containing
     396                                          a float and a bool, where the second value
     397                                          specifies if the value is refined, otherwise
     398                                          the value is a float unless otherwise noted.
     399\                         Scale           The histogram scale factor (refinable)
     400\                         Absorption      The sample absorption coefficient as
     401                                          :math:`\\mu r` where r is the radius
     402                                          (refinable).
     403\                         DisplaceX,      Sample displacement from goniometer center
     404                          DisplaceY       where Y is along the beam direction and
     405                                          X is perpendicular. Units are :math:`\\mu m`
     406                                          (refinable).
     407\                         Phi, Chi,       Goniometer sample setting angles, in degrees.
     408                          Omega
     409\                         Gonio. radius   Radius of the diffractometer in mm
     410\                         InstrName       A name for the instrument, used in preparing
     411                                          a CIF (str).
     412\                         Force,          Variables that describe how the measurement
     413                          Temperature,    was performed. Not used directly in
     414                          Humidity,       any computations.
     415                          Pressure,
     416                          Voltage
     417\                         ranId           The random-number Id for the histogram
     418                                          (same value as where top-level key is ranId)
     419\                         Type            Type of diffraction data, may be 'Debye-Scherrer'
     420                                          or 'Bragg-Brentano' (str).
     421\                         Diffuse         not in use?
     422hId                           \           The number assigned to the histogram when
     423                                          the project is loaded or edited (can change)
     424ranId                         \           A random number id for the histogram
     425                                          that does not change
     426Background                    \           The background is stored as a list with where
     427                                          the first item in the list is list and the second
     428                                          item is a dict. The list contains the background
     429                                          function and its coefficients; the dict contains
     430                                          Debye diffuse terms and background peaks.
     431                                          (TODO: this needs to be expanded.)
     432Data                          \           The data consist of a list of 6 np.arrays
     433                                          containing in order:
     434
     435                                           1. the x-postions (two-theta in degrees),
     436                                           2. the intensity values (Yobs),
     437                                           3. the weights for each Yobs value
     438                                           4. the computed intensity values (Ycalc)
     439                                           5. the background values
     440                                           6. Yobs-Ycalc
     441======================  ===============  ====================================================
     442
     443Powder Reflection Data Structure
     444--------------------------------
     445
     446.. _PowderRefl_table:
     447
     448.. index::
     449   single: Powder reflection object description
     450   single: Data object descriptions; Powder Reflections
     451   
     452For every phase in a histogram, the ``Reflection Lists`` value is a list of
     453reflections. The items in that list are documented below.
     454
     455==========  ====================================================
     456  index         explanation
     457==========  ====================================================
     458 0,1,2       h,k,l (float)
     459 3           multiplicity
     460 4           d-space, Angstrom
     461 5           pos, two-theta
     462 6           sig, Gaussian width
     463 7           gam, Lorenzian width
     464 8           Fobs**2
     465 9           Fcalc**2
     466 10          reflection phase, in degrees
     467 11          the equivalent reflections as a (m x 3)
     468             np.array, where m is 0.5 * multiplicity. Note
     469             that Freidel pairs, (-h,-k-,l), are not
     470             included.
     471 12          phase shift for each of the equivalent
     472             reflections as a length (m) array
     473 13          intensity correction for reflection, this times
     474             Fobs**2 or Fcalc**2 gives Iobs or Icalc
     475 14          dict with the form factor (f or b) by atom type
     476             symbol at the reflection position.
     477==========  ====================================================
    317478
    318479
Note: See TracChangeset for help on using the changeset viewer.