.. _PreFlagger.json#/:

PreFlagger
==========

Flag given baselines, time slots, etc.


.. _PreFlagger.json#/inputs:

inputs
******


.. _PreFlagger.json#/inputs/type:

type
++++

:type: ``string``

:default: ``preflagger``

:doc: Case-insensitive step type; must be 'preflagger' (or 'preflag') `.`


.. _PreFlagger.json#/inputs/abstime:

abstime
+++++++

:type: ``string[]``

:doc: Ranges of absolute UTC date/time given as st..end or val+-delta. Each value (except delta) must be given as a date/time in casacore MVTime format, for instance 12-Mar-2010/11:31:00.000. A delta value must be given as a time (for instance 1:30:0 or 20s) `.`

:default: ``[]``


.. _PreFlagger.json#/inputs/amplmax:

amplmax
+++++++

:type: ``float``

:default: ``1e+30``

:doc: Correlation data with amplitude > amplmax will match `.`


.. _PreFlagger.json#/inputs/amplmin:

amplmin
+++++++

:type: ``float``

:default: ``-1e+30``

:doc: Correlation data with amplitude < amplmin will match. It can be given per correlation. For example, ``amplmin=[100,,,100]`` matches data points with XX or YY amplitude < 100. The non-specified amplitudes get the default value.


.. _PreFlagger.json#/inputs/azimuth:

azimuth
+++++++

:type: ``float[]``

:default: ``[]``

:doc: Ranges of azimuth angles given as st..end or val+-delta. Each value has to be given as a casacore direction like 12:34:56.789 or 12h34m56.789, 12.34.56.789 or 12d34m56.789, or a value followed by a unit like rad or deg `.`


.. _PreFlagger.json#/inputs/baseline:

baseline
++++++++

:doc: See `Description of baseline selection parameters <https://www.astron.nl/lofarwiki/doku.php?id=public:user_software:documentation:ndppp#description_of_baseline_selection_parameters>`__.

:type: ``string[]``

:default: ``[]``


.. _PreFlagger.json#/inputs/blmax:

blmax
+++++

:type: ``float``

:default: ``-1``

:doc: If blmax > 0, baselines with length > blmax meter will match `.`


.. _PreFlagger.json#/inputs/blmin:

blmin
+++++

:type: ``float``

:default: ``-1``

:doc: If blmin > 0, baselines with length < blmin meter will match `.`


.. _PreFlagger.json#/inputs/chan:

chan
++++

:type: ``string``

:default: ``""``

:doc: The given channels will match (start counting at 0). Channels exceeding the number of channels are ignored. Similar to ``msin``, it is possible to specify the channels as an expression of ``nchan``. Furthermore, ``..`` can be used to specify ranges. For example: ``chan=[0..nchan/32-1, 31*nchan/32..nchan-1]`` to flag the first and last 2 or 8 channels (depending on 64 or 256 channels in the observation).


.. _PreFlagger.json#/inputs/corrtype:

corrtype
++++++++

:type: ``string``

:default: ``""``

:doc: Correlation type to match? Must be auto, cross, or an empty string `.`


.. _PreFlagger.json#/inputs/count&#46;path:

count&#46;path
++++++++++++++

:type: ``string?``

:doc: The directory where to create the flag percentages table. If empty, the path of the input MS is used `.`


.. _PreFlagger.json#/inputs/count&#46;save:

count&#46;save
++++++++++++++

:type: ``boolean``

:default: ``False``

:doc: If true, the flag percentages per frequency are saved to a table with extension ``.flagfreq`` and percentages per station to a table with extension ``.flagstat``. The basename of the table is the MS name (without extension) followed by the stepname and extension.


.. _PreFlagger.json#/inputs/elevation:

elevation
+++++++++

:type: ``string?``

:doc: Ranges of elevation angles (similar to azimuth). For example: `0deg..10deg`


.. _PreFlagger.json#/inputs/expr:

expr
++++

:type: ``string?``

:default: ``""``

:doc: Expression of preflagger keyword sets (see above). Operators AND, OR, and NOT are possible (or their equivalents &&,&, `||`, `|`, and !). Parentheses can be used to change precedence order. For example: ``c1 and (c2 or c3)``


.. _PreFlagger.json#/inputs/freqrange:

freqrange
+++++++++

:type: ``string``

:default: ``""``

:doc: Channels in the given frequency ranges will match. Each value in the vector is a range which can be given as start..end or start+-delta. A value can be followed by a unit like KHz. If only one value in a range has a unit, the unit is also applied to the other value. If a range has no unit, it defaults to MHz. For example: ``freqrange=[1.2 .. 1.4 MHz, 1.8MHz+-50KHz]`` flags channels between 1.2MHz and 1.4MHz and between 1.75MHz and 1.85MHz. The example shows that blanks can be used at will.


.. _PreFlagger.json#/inputs/imagmax:

imagmax
+++++++

:type: ``float``

:default: ``1e+30``

:doc: Correlation data with imaginary complex part > imagmax will match `.`


.. _PreFlagger.json#/inputs/imagmin:

imagmin
+++++++

:type: ``float``

:default: ``-1e+30``

:doc: Correlation data with imaginary complex part < imagmin will match `.`


.. _PreFlagger.json#/inputs/lst:

lst
+++

:type: ``string[]``

:default: ``[]``

:doc: Ranges of Local Apparent Sidereal Times like `1:30:0 +- 20min`. The LST of a time slot is calculated for the array position, thus not per antenna.


.. _PreFlagger.json#/inputs/mode:

mode
++++

:type: ``string``

:default: ``set``

:doc: Case-insensitive string telling what to do with the flags of the data matching (or not matching) the selection criteria given in the other parameters. Must be 'set', 'setcomplement'/'setother', 'clear' or 'clearcomplement'/'clearother' `.`


.. _PreFlagger.json#/inputs/phasemax:

phasemax
++++++++

:type: ``float``

:default: ``1e+30``

:doc: Correlation data with phase > phasemax (in radians) will match `.`


.. _PreFlagger.json#/inputs/phasemin:

phasemin
++++++++

:type: ``float``

:default: ``-1e+30``

:doc: Correlation data with phase < phasemin (in radians) will match `.`


.. _PreFlagger.json#/inputs/realmax:

realmax
+++++++

:type: ``float``

:default: ``1e+30``

:doc: Correlation data with real complex part > realmax will match `.`


.. _PreFlagger.json#/inputs/realmin:

realmin
+++++++

:type: ``float``

:default: ``-1e+30``

:doc: Correlation data with real complex part < realmin will match `.`


.. _PreFlagger.json#/inputs/reltime:

reltime
+++++++

:type: ``string[]``

:default: ``[]``

:doc: Ranges of times (using .. or +-) since the start of the observation. A time can be given like 1:30:0 or 20s `.`


.. _PreFlagger.json#/inputs/step_name:

step_name
+++++++++

:type: ``string``

:default: ``preflag``

:doc: unique name for the step `.`


.. _PreFlagger.json#/inputs/timeofday:

timeofday
+++++++++

:type: ``string?``

:default: ``[]``

:doc: Ranges of UTC time-of-day given as st..end or val+-delta. Each value must be given as 12:34:56.789, 12h34m56.789, or as a value followed by a unit like h, min, or s `.`


.. _PreFlagger.json#/inputs/timeslot:

timeslot
++++++++

:type: ``string[]``

:default: ``[]``

:doc: Time slot sequence numbers. First time slot is 0. st..end means end inclusive `.`


.. _PreFlagger.json#/inputs/uvmmax:

uvmmax
++++++

:type: ``float``

:default: ``-1``

:doc: If uvmmax > 0, baselines with UV-distance > uvmmax meter will match `.`


.. _PreFlagger.json#/inputs/uvmmin:

uvmmin
++++++

:type: ``float``

:default: ``-1``

:doc: If uvmmin > 0, baselines with UV-distance < uvmmin meter will match. Note that the UV-distance is the projected baseline length `.`