options.rst

Options

This page details all the available options. This information is also available on the command line by invoking goquartical or goquartical help. The following is broken up by configuration section.

Note

These options can be specified either via command line or .yaml file e.g.:

input_ms.path=path/to.ms

or

input_ms:
    path: path/to.ms

input_ms

Options pertaining to the input measurement set.

.. jinja:: input_ms

    {% for k, v in input_ms.items() %}

    {{"{}".format("input_ms." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

input_model

Options pertaining to the input model.

.. jinja:: input_model

    {% for k, v in input_model.items() %}

    {{"{}".format("input_model." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

output

Options pertaining to output.

.. jinja:: output

    {% for k, v in output.items() %}

    {{"{}".format("output." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

mad_flags

Options pertaining to MAD (Median Absolute Deviation) flagging.

.. jinja:: mad_flags

    {% for k, v in mad_flags.items() %}

    {{"{}".format("mad_flags." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

dask

Options pertaining to Dask (and therefore parallelism).

.. jinja:: dask

        {% for k, v in dask.items() %}

    {{"{}".format("dask." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

solver

Options pertaining to all solvers (as opposed to specific terms).

.. jinja:: solver

    {% for k, v in solver.items() %}

    {{"{}".format("solver." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}

gain

Options pertaining to a specific gain/Jones term.

Warning

This help is generic - users will not typically write gain.option but will instead use the labels specified by solver.gain_terms. Thus, for solver.gain_terms="[G,B]", options would be specified using G.option or B.option.

.. jinja:: gain

    {% for k, v in gain.items() %}

    {{"{}".format("gain." + k) | code}}
        {{"{} ".format(v["info"])}}

        {% if "choices" in v %}
            * Choices:
            {% for i in v["choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "element_choices" in v %}
            * Choices:
            {% for i in v["element_choices"] %}
                - {{i}}
            {% endfor %}
        {% endif %}

        {% if "default" in v %}
            * {{"Default: {} ".format(v["default"])}}
        {% else %}
            * Default: N/A
        {% endif %}

    {% endfor %}