.. _Clipper.json#/:

Clipper
=======

Simulates visibilities from a given skymodel and uses the result to clip bright sources from the data. Because this steps performs prediction, options of the Predict step are also valid.


.. _Clipper.json#/inputs:

inputs
******


.. _Clipper.json#/inputs/type:

type
++++

:type: ``string``

:default: ``clipper``

:doc: Case-insensitive step type; must be 'clipper'.


.. _Clipper.json#/inputs/amplmax:

amplmax
+++++++

:type: ``float``

:default: ``50.0 for LBA``, ``5.0 for HBA``

:doc: Sets the clip level for the data.


.. _Clipper.json#/inputs/baseline:

baseline
++++++++

:type: ``string``

:doc: Perform baseline selection using a filter-substep. Refer to :ref:`Filter` for additional information.

:default: ``""``


.. _Clipper.json#/inputs/flagallcorrelations:

flagallcorrelations
+++++++++++++++++++

:type: ``boolean``

:default: ``True``

:doc: Flag all correlations for a baseline if a single correlation exceeds `amplmax`.


.. _Clipper.json#/inputs/freqstep:

freqstep
++++++++

:type: ``int``

:doc: Perform the visibility prediction only once every `frequency_step` channels. The next `frequency_step - 1` channels will use these visibilities until the next prediction.


.. _Clipper.json#/inputs/step_name:

step_name
+++++++++

:type: ``string``

:default: ``clipper``

:doc: unique name for the step.


.. _Clipper.json#/inputs/timestep:

timestep
++++++++

:type: ``int``

:default: ``5``

:doc: Perform the visibility prediction only once every `time_step` steps. The next `time_step - 1` will use these visibilities until the next prediction.