:py:mod:`tile_trial`
====================

.. py:module:: tile_trial


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   tile_trial.Celpos
   tile_trial.WidHt
   tile_trial.TwoFloats



Functions
~~~~~~~~~

.. autoapisummary::

   tile_trial.arg_init
   tile_trial.float_pair
   tile_trial.sky_to_centre_frequency
   tile_trial.prefix
   tile_trial.parset_init
   tile_trial.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   tile_trial.explanation
   tile_trial.description
   tile_trial.label_help
   tile_trial.script_name
   tile_trial.FORMAT_FILE
   tile_trial.FORMAT_CONSOLE
   tile_trial.formatter_console
   tile_trial.formatter_file
   tile_trial.timestr
   tile_trial.console


.. py:data:: explanation
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        
        Script tile_sky
        ===============
        This tiles the sky in the fashion described by Aaron Robotham (UWA), that is tiles arranged along small circles
        over a declination band and a polar-cap using the same scheme but centred on the SCP and limited in extent to minimse
        overlap with the dec-band section.
        
        The script will transform any tiling into other coordinates, so that the requested survey parameters can 
        be expressed as equatorial  ("J2000"), Galactic  ("GALAC") or Magellanic ("MAGEL")
        (see http://adsabs.harvard.edu/abs/2008ApJ...679..432N).
        
        The script produces results in several files:
         - <label>.parset  - observing parset; gives the required entries for each tile and its interleaves; at present this
            parset may need editing before submission as an ASKAP observation;
         - <label>.ann - kvis annotations file that shows the tile locations and names on a kvis-displayed image
         - <label>_footprint.sh - shell script that can be run to produce plan-footprint.py output for each tile;
         
        The tiling is controlled with these inputs:
        1. -m lat1,lat2  the latitude margins of the small-circle section - (default values [-72,72])
        2. -c {J2000,GALAC,MAGEL} specifies the coordinate frame - (default is J2000)
        3. -r Origin of the tiling in the chosen coordinates (lon,lat) - (default is [0.0,0.0]
        4. -p the beam spacing (pitch) - (default is 0.9 deg)
        5. -n the name of the footprint - (default is square_6x6)
        
        
        For a given tiling, a subset of the tiles can be chosen using the "horizontal" and "vertical" limit parameters:
        1. -H th1, th2 give the longitude limits
        2. -V ph1, ph2 give the latitude limits.
        
        
        """

    .. raw:: html

        </details>

   

.. py:data:: description
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        Description goes here
        
        """

    .. raw:: html

        </details>

   

.. py:data:: label_help
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        Name of region being tiled. This is used to name all auxilliary output files:
            kvis annotations file <LABEL>.ann
            plot file <LABEL>.png;
            Shell script for running footprint-plan.py on all tiles <LABEL>_footprint.sh;
            Observing parset <LABEL>.parset (can be overridden with the -o option).
        
        The label is also used in naming fields in the parset.
        """

    .. raw:: html

        </details>

   

.. py:data:: script_name
   :value: 'tile_sky'

   

.. 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:: Celpos(option_strings, dest, nargs=None, **kwargs)

   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:: 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:function:: float_pair(arg)


.. 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)


.. py:function:: prefix(word, pfx)


.. py:function:: parset_init(beam_weights, duration, fp, sky_frequency, corrmode, beamform_pa)


.. py:function:: main()