:py:mod:`array_mean` ==================== .. py:module:: array_mean .. autoapi-nested-parse:: Compute array-wide mean beam shapes from holgraphy data Copyright (C) CSIRO 2018 Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: array_mean.intList array_mean.polList Functions ~~~~~~~~~ .. autoapisummary:: array_mean.shift array_mean.make_gen array_mean.fit_line array_mean.zero_phase array_mean.op_complex_mean array_mean.op_func_mean array_mean.op_func_std array_mean.done_ant array_mean.arg_init array_mean.main Attributes ~~~~~~~~~~ .. autoapisummary:: array_mean.EXPLANATION array_mean.HELPSTART .. py:function:: shift(z, dx, dy) .. py:function:: make_gen(shape) Shape is always 5 long .. py:function:: fit_line(x, y) .. py:function:: zero_phase(complex_image) .. py:function:: op_complex_mean(z) Mean of complex data .. py:function:: op_func_mean(z_in) Mean of squared magnitude .. py:function:: op_func_std(z_in) Standard deviation of squared magnitude .. py:function:: done_ant(err) .. py:data:: EXPLANATION :value: 'TBD.\n' .. py:data:: HELPSTART :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """Provide an SBID for which you have holography measurements and elliptical fits to the beam half-power contours. """ .. raw:: html
.. py:function:: arg_init() Provide essential data for interpreting 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:: main()