:py:mod:`fit_plot` ================== .. py:module:: fit_plot .. autoapi-nested-parse:: Script to read and plot beam fits. Copyright (C) CSIRO 2017 Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: fit_plot.intList fit_plot.polList Functions ~~~~~~~~~ .. autoapisummary:: fit_plot.arg_init fit_plot.show_plot fit_plot.make_gen fit_plot.unlink_wrap fit_plot.main Attributes ~~~~~~~~~~ .. autoapisummary:: fit_plot.explanation fit_plot.HELP_START fit_plot.POSITION fit_plot.AXES fit_plot.SHAPE fit_plot.FOOTPRINT fit_plot.FLAGS fit_plot.GOODNESS fit_plot.STATS fit_plot.SIZESTATS fit_plot.DISHDIAMETER .. py:data:: explanation :value: '' .. py:data:: HELP_START :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """This provides an example that reads and displays beam model parameters. There are several numbered options : 1. POSITION: Plot the mean position difference between antennas over all beams. Select channel, antennas. 2. AXES: Plot major and minor axes of selected beams as a function of frequency. Select beams. 3. SHAPE: Plot the mean axis length and eccentricity of selected beams against frequency. Select beams 4. FOOTPRINT: Plot the fitted ellipses for all beams at a selected frequency, for selected antennas. Select channel 5. FLAGS: Show flagged fits over all antennas, beams vs frequency channels 6. GOODNESS: Show fit residuals over all antennas, beams vs frequency channels 7. SHAPE-STATS: Plot shape statistics over antennas as function of frequency. Select a beam, and the desired set of antennas. 8. SIZE-STATS: Plot shape statistics over frequency as function of beam. Select the desired set of antennas. """ .. raw:: html
.. py:data:: POSITION :value: 1 .. py:data:: AXES :value: 2 .. py:data:: SHAPE :value: 3 .. py:data:: FOOTPRINT :value: 4 .. py:data:: FLAGS :value: 5 .. py:data:: GOODNESS :value: 6 .. py:data:: STATS :value: 7 .. py:data:: SIZESTATS :value: 8 .. py:data:: DISHDIAMETER :value: 12.0 .. py:function:: arg_init() Define the interprestation of command line arguments. .. py:class:: intList(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) Bases: :py:obj:`argparse.Action` Information about how to convert command line strings to Python objects. Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances. Keyword Arguments: - option_strings -- A list of command-line option strings which should be associated with this action. - dest -- The name of the attribute to hold the created object(s) - nargs -- The number of command-line arguments that should be consumed. By default, one argument will be consumed and a single value will be produced. Other values include: - N (an integer) consumes N arguments (and produces a list) - '?' consumes zero or one arguments - '*' consumes zero or more arguments (and produces a list) - '+' consumes one or more arguments (and produces a list) Note that the difference between the default and nargs=1 is that with the default, a single value will be produced, while with nargs=1, a list containing a single value will be produced. - const -- The value to be produced if the option is specified and the option uses an action that takes no values. - default -- The value to be produced if the option is not specified. - type -- A callable that accepts a single string argument, and returns the converted value. The standard Python types str, int, float, and complex are useful examples of such callables. If None, str is used. - choices -- A container of values that should be allowed. If not None, after a command-line argument has been converted to the appropriate type, an exception will be raised if it is not a member of this collection. - required -- True if the action must always be specified at the command line. This is only meaningful for optional command-line arguments. - help -- The help string describing the argument. - metavar -- The name to be used for the option's argument with the help string. If None, the 'dest' value will be used as the name. .. py:method:: __call__(parser, namespace, values, option_string=None) .. py:class:: polList(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) Bases: :py:obj:`argparse.Action` Information about how to convert command line strings to Python objects. Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances. Keyword Arguments: - option_strings -- A list of command-line option strings which should be associated with this action. - dest -- The name of the attribute to hold the created object(s) - nargs -- The number of command-line arguments that should be consumed. By default, one argument will be consumed and a single value will be produced. Other values include: - N (an integer) consumes N arguments (and produces a list) - '?' consumes zero or one arguments - '*' consumes zero or more arguments (and produces a list) - '+' consumes one or more arguments (and produces a list) Note that the difference between the default and nargs=1 is that with the default, a single value will be produced, while with nargs=1, a list containing a single value will be produced. - const -- The value to be produced if the option is specified and the option uses an action that takes no values. - default -- The value to be produced if the option is not specified. - type -- A callable that accepts a single string argument, and returns the converted value. The standard Python types str, int, float, and complex are useful examples of such callables. If None, str is used. - choices -- A container of values that should be allowed. If not None, after a command-line argument has been converted to the appropriate type, an exception will be raised if it is not a member of this collection. - required -- True if the action must always be specified at the command line. This is only meaningful for optional command-line arguments. - help -- The help string describing the argument. - metavar -- The name to be used for the option's argument with the help string. If None, the 'dest' value will be used as the name. .. py:method:: __call__(parser, namespace, values, option_string=None) .. py:function:: show_plot(do_show) .. py:function:: make_gen(shape) Shape is always 5 long .. py:function:: unlink_wrap(dat, lims=[-np.pi, np.pi], thresh=0.95) Iterate over contiguous regions of `dat` (i.e. where it does not jump from near one limit to the other). This function returns an iterator object that yields slice objects, which index the contiguous portions of `dat`. This function implicitly assumes that all points in `dat` fall within `lims`. .. py:function:: main() All the processing starts in here.