Changeset 3271


Ignore:
Timestamp:
Feb 10, 2018 5:07:35 PM (4 years ago)
Author:
toby
Message:

improve plot docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIplot.py

    r3270 r3271  
    5656:class:`G2PlotMpl` (2-D matplotlib),
    5757:class:`G2Plot3D` (3-D matplotlib), and
    58 :class:`G2PlotOgl` (OpenGL).
    59 These tabbed plot objects share a common parent class, which defines a number
    60 of special attributes (variables), which have these uses:
     58:class:`G2PlotOgl` (OpenGL). Note that two :class:`G2PlotNoteBook` methods are
     59potentially used to determine how plot updates after a refinement are handled:
     60
     61============================================     ========================================================
     62class method                                      description
     63============================================     ========================================================
     64:meth:`~G2PlotNoteBook.RegisterRedrawRoutine`     This specifies a function
     65                                                  to redraw the plot after the data tree has been
     66                                                  reloaded. Be sure this updates data
     67                                                  objects with new values from the tree, when needed.
     68                                                 
     69:meth:`~G2PlotNoteBook.SetNoDelete`               Use this to indicate that a plot does not need to be
     70                                                  updated after a refinement and should not be closed.
     71============================================     ========================================================
     72
     73These two methods define the following attributes (variables) in the plot tab classes:
    6174
    6275======================    ===============     ============================================================
     
    6477======================    ===============     ============================================================
    6578replotFunction              None               Defines a routine to be called to update the plot
    66                                                after a refinement (unless None). Do not define
    67                                                this to use functions that take significant time
    68                                                to complete (also see
     79                                               after a refinement (unless None). Use
     80                                               :meth:`G2PlotNoteBook.RegisterRedrawRoutine`
     81                                               to define this (and replotArgs & replotKwArgs).
     82                                               Plotting functions that take significant time
     83                                               to complete should probably not use this.)
    6984replotArgs                  []                 Defines the positional arguments to be supplied to
    7085                                               the replotFunction function or method.
    7186replotKwArgs                {}                 Defines the keyword arguments to be supplied to
    72                                                the replotFunction function or method. (Implemented,
    73                                                but not currently used.)
     87                                               the replotFunction function or method.
     88plotRequiresRedraw         True                If set to True, after a refinement, the plot will be
     89                                               closed (in :func:`GSASIIdataGUI.GSASII.CleanupOldPlots`)
     90                                               if it was not updated after the refinement. Set this to
     91                                               False using :meth:`G2PlotNoteBook.SetNoDelete`
     92                                               for plots that should not be deleted or do
     93                                               not change based on refinement results.
    7494plotInvalid                 False              Used to track if a plot has been updated. Set to False
    7595                                               in :meth:`G2PlotNoteBook.FindPlotTab` when a plot is
     
    7898                                               plotInvalid to False for all plots before any routines
    7999                                               are called.
    80 plotRequiresRedraw         True                If set to True, after a refinement, the plot will be
    81                                                closed (in :func:`GSASIIdataGUI.GSASII.CleanupOldPlots`)
    82                                                if it was not updated after the refinement. Set this to
    83                                                False using :meth:`G2PlotNoteBook.SetNoDelete`
    84                                                for plots that should not be deleted or do
    85                                                not change based on refinement results.
    86100======================    ===============     ============================================================
    87101
Note: See TracChangeset for help on using the changeset viewer.