:py:mod:`illuminate` ==================== .. py:module:: illuminate .. autoapi-nested-parse:: illuminate Inverts complex holography maps to get illumiation distributions over ASKAP antennas. $Author: mcc381 $ Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: illuminate.Aperture illuminate.IntList illuminate.PolList Functions ~~~~~~~~~ .. autoapisummary:: illuminate.get_diag illuminate.set_bounds illuminate.make_port_axis illuminate.make_label_axes illuminate.arg_init illuminate.main Attributes ~~~~~~~~~~ .. autoapisummary:: illuminate.a3_size illuminate.explanation illuminate.fmt .. py:data:: a3_size :value: (16.5, 11.7) .. py:data:: explanation :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ Perform the following steps: - apply taper to i_holo - the holography complex data - note that the tapering option has been omitted; - Pad the data; amount of padding given by pad_factor - create larger array with zeros - making sure it is complex - copy in the map data into the central portion, with shift if necessary to centre the beam - Rotate data array to put the origin at 0,0, ready for transform - Fourier transform to give aperture illumination Usage: To plot amplitudes of all ports AK03, channel 270, SBID 5977 illuminate.py -a 3 -c 270 -o m -s 5977 As before but for phase illuminate.py -a 3 -c 270 -o mp -s 5977 To plot aperture illumination function (amplitude and phase) for beam (or port) 26, AK03, channel 270, SBID 5977 illuminate.py -a 3 -c 270 -o a -s 5977 As previous, but also plot beam amplitude and phase illuminate.py -a 3 -c 270 -o b -s 5977 """ .. raw:: html
.. py:function:: get_diag(x, m, sw=True) .. py:function:: set_bounds(coord, extr) .. py:class:: Aperture(beam_map, pad_factor) Bases: :py:obj:`object` .. py:method:: set_sbid(s) .. py:method:: set_chan(s) .. py:method:: make_taper() :return: .. py:method:: pad_taper(do_centre=True, taper=None) :param do_centre: :param taper: :return: .. py:method:: transform_to_aperture() :return: .. py:method:: get_scales() :return: .. py:method:: prepare_plot_quantities() .. py:method:: summary() .. py:method:: insert_test() .. py:method:: plot_filename(option, plot_num, amppha='') .. py:method:: plot_both(sbid) .. py:method:: plot_aperture(sbid, plot_num) .. py:method:: plot_port(ax, port, **kw) .. py:method:: fix_phase() .. py:function:: make_port_axis(fig, port_pos) .. py:function:: make_label_axes(fig) .. py:function:: arg_init() .. 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() .. py:data:: fmt :value: '%(asctime)s %(levelname)s %(name)s %(message)s'