:py:mod:`obs-preamble`
======================
.. py:module:: obs-preamble
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
obs-preamble.WidHt
obs-preamble.TwoFloats
Functions
~~~~~~~~~
.. autoapisummary::
obs-preamble.arg_init
obs-preamble.sky_to_centre_frequency
obs-preamble.prefix
obs-preamble.parset_init
obs-preamble.main
Attributes
~~~~~~~~~~
.. autoapisummary::
obs-preamble.explanation
obs-preamble.description
obs-preamble.label_help
obs-preamble.script_name
obs-preamble.FORMAT_FILE
obs-preamble.FORMAT_CONSOLE
obs-preamble.formatter_console
obs-preamble.formatter_file
obs-preamble.timestr
obs-preamble.console
.. py:data:: explanation
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""
Script obs-preamble
===============
This prepares the preamble section of an observation parset.
The script produces results in several files:
-
.. py:data:: description
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""
This ...
"""
.. raw:: html
.. py:data:: label_help
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""
Name of parset:
.. py:data:: script_name
:value: 'obs-preamble'
.. py:data:: FORMAT_FILE
:value: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
.. py:data:: FORMAT_CONSOLE
:value: '%(name)s - %(levelname)s - %(message)s'
.. py:data:: formatter_console
.. py:data:: formatter_file
.. py:data:: timestr
.. py:data:: console
.. py:function:: arg_init()
.. py:class:: WidHt(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:: TwoFloats(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:: sky_to_centre_frequency(f, z, forward=True)
Given "sky_frequency", the frequency parameter required by the control software, return the
resultant centre frequency.
# Assuming 288 MHz continuum bandwidth (6 48_MHz blocks), and the sky_frequency is 2.5 blocks from
# the lower end,
# return the band centre frequency, adjusted according to the selected zoom mode.
# f - sky_frequency in MHz
# z -zoom out of (1, 2, 4, 8, 16, 32)
:param f: (float) sky_frequency in MHz (or centre frequency)
:param z: (int) zoom out of (1, 2, 4, 8, 16, 32)
:param forward: (bool) Default True. If False, convert from centre to sky_frequency
:return (float) Centre frequency (or sky_frequency)
.. py:function:: prefix(word, pfx)
.. py:function:: parset_init(beam_weights, duration, fp, sky_frequency, corrmode, beamform_pa)
.. py:function:: main()