.. _pipeline_steps:

***************
Pipeline Steps
***************

This page documents the parameters accepted by each pipeline step.

.. note::

   Parameters labelled *required* have no default value and must always be
   provided. All other parameters are optional and fall back to the listed
   default when omitted.

Preflagger
==========

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.Preflagger
   :exclude-members: resolve, frequency_ranges_mhz

.. py:attribute:: Preflagger.frequency_ranges_mhz
   :type: list[FrequencyRangeMHz]
   :value: required

   List of frequency ranges to flag (at least one required). Each entry is a
   :ref:`frequency-range-mhz` with ``start`` and ``stop`` values in MHz.

.. _frequency-range-mhz:

FrequencyRangeMHz
-----------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.preflagger.FrequencyRangeMHz

.. _aoflagger:

AOFlagger
=========

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.AOFlagger
   :exclude-members: resolve, strategy

.. py:attribute:: AOFlagger.strategy
   :type: PresetStrategy | FileStrategy
   :value: required

   AOFlagger strategy, discriminated by ``kind``. Use :ref:`preset-strategy`
   to select a bundled preset, or :ref:`file-strategy` to supply a custom file.

.. _preset-strategy:

PresetStrategy
--------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.aoflagger.PresetStrategy

.. note::

   See :ref:`aoflagger-strategy-presets` for the list of available preset names.

.. _file-strategy:

FileStrategy
------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.aoflagger.FileStrategy

Applycal
========

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.Applycal
   :exclude-members: resolve, table

.. py:attribute:: Applycal.table
   :type: H5ParmTable | SDMTable
   :value: required

   Calibration table source, discriminated by ``kind``. Use
   :ref:`h5parm-table` in standalone mode or :ref:`sdm-table` in SDM mode.

.. _h5parm-table:

H5ParmTable (standalone mode)
------------------------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.applycal.H5ParmTable

.. _sdm-table:

SDMTable (SDM mode)
--------------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.applycal.SDMTable

Averager
========

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.Averager
   :exclude-members: resolve

.. _demixer:

Demixer
=======

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.Demixer
   :exclude-members: resolve, sky_model

.. py:attribute:: Demixer.sky_model
   :type: SourceDbSkyModel
   :value: required

   Sky model for demixing, discriminated by ``kind``. Currently only
   :ref:`sourcedb-sky-model` is available.

.. _sourcedb-sky-model:

SourceDbSkyModel
----------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.steps.demixer.SourceDbSkyModel

.. _input:

Input
=====

.. autopydantic_model:: ska_sdp_batch_preprocess.config.input.InputConfig

.. _output:

Output
======

.. autopydantic_model:: ska_sdp_batch_preprocess.config.output.OutputConfig
   :exclude-members: storage_manager

.. py:attribute:: OutputConfig.storage_manager
   :module: ska_sdp_batch_preprocess.config.output
   :type: StorageManager | None
   :value: None

   Optional Dysco storage manager settings. Set this block to enable
   compression; see :ref:`storage-manager`.

.. _storage-manager:

StorageManager
--------------

.. autopydantic_model:: ska_sdp_batch_preprocess.config.output.StorageManager