Changeset 4198 for trunk/GSASIIobj.py


Ignore:
Timestamp:
Dec 9, 2019 2:30:49 PM (23 months ago)
Author:
toby
Message:

doc improvements; new scripting options (rev. sequential & set background file)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIobj.py

    r4136 r4198  
    1616as provides misc. support routines.
    1717
    18 Constraints Tree Item
    19 ----------------------
    20 
    2118.. _Constraints_table:
    2219
     
    2421   single: Constraints object description
    2522   single: Data object descriptions; Constraints
     23
     24Constraints Tree Item
     25----------------------
    2626
    2727Constraints are stored in a dict, separated into groups.
     
    9797      :math:`newvar = m_1 \\times var_1 + m_2 \\times var_2 + ...`
    9898
    99 Covariance Tree Item
    100 --------------------
    101 
    10299.. _Covariance_table:
    103100
     
    105102   single: Covariance description
    106103   single: Data object descriptions; Covariance
     104
     105Covariance Tree Item
     106--------------------
    107107
    108108The Covariance tree item has results from the last least-squares run. They
     
    140140=============  ===============  ====================================================
    141141
    142 Phase Tree Items
    143 ----------------
    144 
    145142.. _Phase_table:
    146143
     
    148145   single: Phase object description
    149146   single: Data object descriptions; Phase
     147
     148Phase Tree Items
     149----------------
    150150
    151151Phase information is stored in the GSAS-II data tree as children of the
     
    297297==========  ===============  ====================================================
    298298
    299 Rigid Body Objects
    300 ------------------
    301 
    302299.. _RBData_table:
    303300
     
    305302   single: Rigid Body Data description
    306303   single: Data object descriptions; Rigid Body Data
     304
     305Rigid Body Objects
     306------------------
    307307
    308308Rigid body descriptions are available for two types of rigid bodies: 'Vector'
     
    345345==========  ===============  ====================================================
    346346
    347 Space Group Objects
    348 -------------------
    349 
    350347.. _SGData_table:
    351348
     
    353350   single: Space Group Data description
    354351   single: Data object descriptions; Space Group Data
     352
     353Space Group Objects
     354-------------------
    355355
    356356Space groups are interpreted by :func:`GSASIIspc.SpcGroup`
     
    416416
    417417
    418 Atom Records
    419 ------------
    420 
    421418.. _Atoms_table:
    422419
     
    425422   single: Data object descriptions; Atoms record
    426423
     424Atom Records
     425------------
    427426
    428427If ``phasedict`` points to the phase information in the data tree, then
     
    455454==============   ====================================================
    456455
    457 Drawing Atom Records
    458 --------------------
    459 
    460456.. _Drawing_atoms_table:
    461457
     
    464460   single: Data object descriptions; Drawing atoms record
    465461
     462Drawing Atom Records
     463--------------------
    466464
    467465If ``phasedict`` points to the phase information in the data tree, then
     
    493491==============   ====================================================
    494492
    495 Powder Diffraction Tree Items
    496 -----------------------------
    497 
    498493.. _Powder_table:
    499494
     
    501496   single: Powder data object description
    502497   single: Data object descriptions; Powder Data
     498
     499Powder Diffraction Tree Items
     500-----------------------------
    503501
    504502Every powder diffraction histogram is stored in the GSAS-II data tree
     
    627625======================  ===============  ====================================================
    628626
    629 Powder Reflection Data Structure
    630 --------------------------------
    631 
    632627.. _PowderRefl_table:
    633628
     
    635630   single: Powder reflection object description
    636631   single: Data object descriptions; Powder Reflections
     632
     633Powder Reflection Data Structure
     634--------------------------------
    637635
    638636For every phase in a histogram, the ``Reflection Lists`` value is a dict
     
    656654==========  ====================================================
    657655
    658 Single Crystal Tree Items
    659 -------------------------
    660 
    661656.. _Xtal_table:
    662657
     
    664659   single: Single Crystal data object description
    665660   single: Data object descriptions; Single crystal data
     661
     662Single Crystal Tree Items
     663-------------------------
    666664
    667665Every single crystal diffraction histogram is stored in the GSAS-II data tree
     
    714712======================  ===============  ====================================================
    715713
    716 Single Crystal Reflection Data Structure
    717 ----------------------------------------
    718 
    719714.. _XtalRefl_table:
    720715
     
    722717   single: Single Crystal reflection object description
    723718   single: Data object descriptions; Single Crystal Reflections
     719
     720Single Crystal Reflection Data Structure
     721----------------------------------------
    724722
    725723For every single crystal a histogram, the ``'Data'`` item contains
     
    744742==========  ====================================================
    745743
    746 Image Data Structure
    747 --------------------
    748 
    749744.. _Image_table:
    750745
     
    752747   image: Image data object description
    753748   image: Image object descriptions
     749
     750Image Data Structure
     751--------------------
    754752
    755753Every 2-dimensional image is stored in the GSAS-II data tree
     
    871869======================  ======================  ====================================================
    872870
     871.. _parmDict_table:
     872
     873.. index::
     874   single: Parameter dictionary
     875
    873876Parameter Dictionary
    874877-------------------------
    875 
    876 .. _parmDict_table:
    877 
    878 .. index::
    879    single: Parameter dictionary
    880878
    881879The parameter dictionary contains all of the variable parameters for the refinement.
Note: See TracChangeset for help on using the changeset viewer.