Changeset 4318


Ignore:
Timestamp:
Feb 17, 2020 2:03:30 PM (22 months ago)
Author:
toby
Message:

minor table adjustments & finally figure out Angstrom for LaTeX and HTML -- I hope

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIobj.py

    r4315 r4318  
    1515This module defines and/or documents the data structures used in GSAS-II, as well
    1616as provides misc. support routines.
     17
     18.. Next command allows \AA to be used in HTML
     19
     20.. only:: html
     21
     22   html :math:`\\require{mediawiki-texvc}`
    1723
    1824.. _Constraints_table:
     
    168174                                interatomic distances
    169175  \         Cell                (list with 8 items) cell refinement flag (bool)
    170                                 a, b, c, (Angstrom, float)
     176                                a, b, c, (:math:`\\AA`, float)
    171177                                alpha, beta & gamma (degrees, float)
    172                                 volume (:math:`A^3`, float)
     178                                volume (:math:`\AA^3`, float)
    173179  \         Color               (list of (r,b,g) triplets) Colors for atoms
    174180  \         Compare             (dict) Polygon comparison parameters
     
    200206  \         Pawley dmax         (float) minimum Q (as d-space) to use for Pawley extraction
    201207  \         Pawley neg wt       (float) Restraint value for negative Pawley intensities
    202   \         SGData              (object <SGData_table>`) Space group details as a :ref:`space group (SGData)
     208  \         SGData              (object <SGData_table>`) Space group details as a
     209                                :ref:`space group (SGData) <SGData_table>`
    203210                                as defined in :func:`GSASIIspc.SpcGroup`.
    204211  \         SH Texture          (dict) Spherical harmonic preferred orientation parameters
     
    219226\           Plane               (list) Controls for contour density plane display
    220227\           Quaternion          (4 element np.array) Viewing quaternion
    221 \           Zclip               (float) clipping distance in A
     228\           Zclip               (float) clipping distance in :math:`\\AA`
    222229\           Zstep               (float) Step to de/increase Z-clip
    223230\           atomPtrs            (list) positions of x, type, site sym, ADP flag in Draw Atoms
     
    226233\           ballScale           (float) Radius of spheres in ball-and-stick display
    227234\           bondList            (dict) Bonds
    228 \           bondRadius          (float) Radius of binds in A
    229 \           cameraPos           (float) Viewing position in A for plot
    230 \           contourLevel        (float) map contour level in :math:`e/\\unicode{x212B}^3`
     235\           bondRadius          (float) Radius of binds in :math:`\\AA`
     236\           cameraPos           (float) Viewing position in :math:`\\AA` for plot
     237\           contourLevel        (float) map contour level in :math:`e/\\AA^3`
    231238\           contourMax          (float) map contour maximum
    232239\           depthFog            (bool) True if use depthFog on plot - set currently as False
     
    278285                                2. Refinement flags - list of 3 bools
    279286                                3. Microstrain axis - list of 3 ints, [h, k, l]
    280                                 4. Generalized mustrain parameters - list of 2-6
    281                                   floats, depending on space group
    282                                 5. Generalized refinement flags - list of bools,
    283                                   corresponding to the parameters of (4)
     287                                4. Generalized mustrain parameters - list of 2-6 floats, depending on space group
     288                                5. Generalized refinement flags - list of bools, corresponding to the parameters of (4)
    284289\           Pref.Ori.           (list) Preferred Orientation. List of eight parameters.
    285290                                Items marked SH are only used for Spherical Harmonics.
     
    292297                                5. (dict) SH - 
    293298                                6. (list) SH
    294                                 7. (float) SH
     299                                7. (float) SH 
    295300\           Scale               (list of [float, bool]) Phase fraction & refine flag
    296301\           Size                List of crystallite size parameters, in order:
     302
    297303                                0. (str) Type, one of  u'isotropic', u'uniaxial', u'ellipsoidal'
    298304                                1. (list) Isotropic/uniaxial parameters - list of 3 floats
     
    300306                                3. (list) Size axis - list of 3 ints, [h, k, l]
    301307                                4. (list) Ellipsoidal size parameters - list of 6 floats
    302                                 5. (list) Ellipsoidal refinement flags - list of bools,
    303                                   corresponding to the parameters of (4)
     308                                5. (list) Ellipsoidal refinement flags - list of bools, corresponding to the parameters of (4)
    304309\           Use                 (bool) True if this histogram is to be used in refinement
    305310\           newLeBail           (bool) Whether to perform a new LeBail extraction
     
    329334\           AtInfo              (dict) Drad, Color: atom drawing radius & color for each atom type
    330335\           RBname              (str) Name assigned by user to rigid body
    331 \           VectMag             (list) vector magnitudes in A
     336\           VectMag             (list) vector magnitudes in :math:`\\AA`
    332337\           rbXYZ               (list of 3 float Cartesian coordinates for Vector rigid body )
    333338\           rbRef               (list of 3 int & 1 bool) 3 assigned reference atom nos. in rigid body for origin
    334                                  definition, use center of atoms flag
     339                                definition, use center of atoms flag
    335340\           VectRef             (list of bool refinement flags for VectMag values )
    336341\           rbTypes             (list of str) Atom types for each atom in rigid body
     
    392397SGLaue      (str) one of the following 14 Laue classes:
    393398            -1, 2/m, mmm, 4/m, 4/mmm, 3R,
    394               3mR, 3, 3m1, 31m, 6/m, 6/mmm, m3, m3m
     399            3mR, 3, 3m1, 31m, 6/m, 6/mmm, m3, m3m
    395400SGOps       (list) symmetry operations as a list of form
    396401            ``[[M1,T1], [M2,T2],...]``
     
    544549.. tabularcolumns:: |p{1in}|p{1in}|p{4in}|
    545550
    546 ======================  ===============  ===========================================================
    547   key                      sub-key          explanation
    548 ======================  ===============  ===========================================================
     551======================     ===============  ===========================================================
     552  key                       sub-key          explanation
     553======================     ===============  ===========================================================
    549554Comments                    \               (list of str) Text strings extracted from the original powder
    550555                                            data header. These cannot be changed by the user;
     
    621626                                            4. the background values
    622627                                            5. Yobs-Ycalc
    623 ======================  ===============  ===========================================================
     628======================     ===============  ===========================================================
    624629
    625630.. _CWPowder_table:
     
    640645Items not refined are noted as [*]
    641646
    642 .. tabularcolumns:: |p{1in}|p{4in}|
    643 
    644 ======================      ===============  ===========================================================
    645   key                           sub-key        explanation
    646 ======================      ===============  ===========================================================
     647.. tabularcolumns:: |l|p{1in}|p{4in}|
     648
     649========================    ===============  ===========================================================
     650  key                       sub-key           explanation
     651========================    ===============  ===========================================================
    647652Instrument Parameters[0]    Type [*]            (str) Histogram type:
    648653                                                * 'PXC' for constant wavelength x-ray
    649654                                                * 'PNC' for constant wavelength neutron
    650655\                           Bank [*]            (int) Data set number in a multidata file (usually 1)
    651 \                           Lam                 (float) Specifies a wavelength in :math:`\\unicode{x212B}`
     656\                           Lam                 (float) Specifies a wavelength in :math:`\\AA`
    652657\                           Lam1 [*]            (float) Specifies the primary wavelength in
    653                                                 :math:`\\unicode{x212B}`, used in place of Lam
     658                                                :math:`\\AA`, used in place of Lam
    654659                                                when an :math:`\\alpha_1, \\alpha_2`
    655660                                                source is used.
    656661\                           Lam2 [*]            (float) Specifies the secondary wavelength in
    657                                                 :math:`\\unicode{x212B}`, used with Lam1
     662                                                :math:`\\AA`, used with Lam1
    658663\                           I(L2)/I(L1)         (float) Ratio of Lam2 to Lam1, used with Lam1
    659664\                           Zero                (float) Two-theta zero correction in *degrees*
     
    671676\                           Polariz.            (float) Polarization coefficient.
    672677Instrument Parameters[1]                        (empty dict)
    673 ======================  ===============      ===========================================================
     678========================    ===============  ===========================================================
    674679
    675680.. _TOFPowder_table:
     
    690695Items not refined are noted as [*]
    691696
    692 .. tabularcolumns:: |p{1.5in}|p{4in}|
    693 
    694 ======================      ===============  ===========================================================
    695   key                           sub-key         explanation
    696 ======================      ===============  ===========================================================
     697.. tabularcolumns:: |l|p{1.5in}|p{4in}|
     698
     699========================    ===============  ===========================================================
     700  key                        sub-key          explanation
     701========================    ===============  ===========================================================
    697702Instrument Parameters[0]    Type [*]            (str) Histogram type:
    698703                                                * 'PNT' for time of flight neutron
     
    717722                                                of d, alp, bet, d-true; for a reflection alpha & beta are obtained via interpolation
    718723                                                from the d-spacing and these tables. The d-true column is apparently unused.
    719  
    720 ======================      ===============  ===========================================================
     724========================    ===============  ===========================================================
     725
    721726
    722727.. _PowderRefl_table:
     
    738743 0,1,2          h,k,l (float)
    739744 3              (int) multiplicity
    740  4              (float) d-space, :math:`\\unicode{x212B}`
     745 4              (float) d-space, :math:`\\AA`
    741746 5              (float) pos, two-theta
    742747 6              (float) sig, Gaussian width
     
    789794                                            The first and second
    790795                                            values are floats unless otherwise noted.
    791 \                           Lam             (two floats) Specifies a wavelength in :math:`\\unicode{x212B}`
     796\                           Lam             (two floats) Specifies a wavelength in :math:`\\AA`
    792797\                           Type            (two str values) Histogram type :
    793798                                            * 'SXC' for constant wavelength x-ray
     
    821826The columns in that array are documented below.
    822827
     828.. tabularcolumns:: |l|p{4in}|
     829
    823830==========  ====================================================
    824831  index         explanation
     
    826833 0,1,2          (float) h,k,l
    827834 3              (int) multiplicity
    828  4              (float) d-space, :math:`\\unicode{x212B}`
     835 4              (float) d-space, :math:`\\AA`
    829836 5              (float) :math:`F_{obs}^2`
    830837 6              (float) :math:`\sigma(F_{obs}^2)`
     
    834841 10             (float) reflection phase, in degrees
    835842 11             (float) intensity correction for reflection, this times
    836                  :math:`F_{obs}^2` or :math:`F_{calc}^2`
    837                  gives Iobs or Icalc
     843                :math:`F_{obs}^2` or :math:`F_{calc}^2`
     844                gives Iobs or Icalc
    838845==========  ====================================================
    839846
     
    931938\                           type                (str) One of 'PWDR', 'SASD' or 'REFL' for powder, small angle or reflectometry data, respectively.
    932939\                           tilt                (float) The angle the detector normal makes with the incident beam; range -90 to 90.
    933 \                           wavelength          (float) The radiation wavelength (Angstrom) as entered by the user
     940\                           wavelength          (float) The radiation wavelength (:math:`\\AA`) as entered by the user
    934941                                                (or someday obtained from the image header).
    935942Masks                       Arcs                (list: lists) Each entry [2-theta,[azimuth[0],azimuth[1]],thickness] describes an arc mask
     
    23642371
    23652372         * 'pixelSize': size of each pixel in microns (such as ``[200.,200.]``.
    2366          * 'wavelength': wavelength in Angstrom.
     2373         * 'wavelength': wavelength in :math:`\\AA`.
    23672374         * 'distance': distance of detector from sample in cm.
    23682375         * 'center': uncalibrated center of beam on detector (such as ``[204.8,204.8]``.
  • trunk/GSASIIplot.py

    r4301 r4318  
    613613            plotNum = self.plotList.index(label)
    614614            Page = self.nb.GetPage(plotNum)
     615            #def OnKeyTest(event): print('OnKeyTest Up')
     616            #Page.canvas.Bind(wx.EVT_KEY_UP, OnKeyTest)
     617            def OnKeyTest(event):
     618                #event.Skip()
     619                print('OnKeyTest down')
     620                Page.canvas.SetFocus()
     621                wx.PostEvent(Page.canvas,event)
     622            Page.canvas.Bind(wx.EVT_KEY_DOWN, OnKeyTest)
    615623
    616624        Page.plotInvalid = False # plot has just been drawn
  • trunk/docs/source/conf.py

    r4213 r4318  
    206206# Additional stuff for the LaTeX preamble.
    207207#'preamble': '',
     208
     209#this allows \AA to be used in equations
     210'preamble': '\\global\\renewcommand{\\AA}{\\text{\\r{A}}}',
    208211}
    209212
Note: See TracChangeset for help on using the changeset viewer.