.. _Predict.json#/:

Predict
=======

Simulate visibilities for a given sky model `.`


.. _Predict.json#/inputs:

inputs
******


.. _Predict.json#/inputs/type:

type
++++

:type: ``string``

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


.. _Predict.json#/inputs/applycal.*:

applycal.*
++++++++++++++

:doc: Set of options for applycal to apply to this predict. For this applycal-substep, .invert is off by default, so the predicted visibilities will be corrupted with the parmdb `.`


.. _Predict.json#/inputs/beammode:

beammode
++++++++

:type: ``enum``

:doc: Same as in `ApplyBeam <ApplyBeam.html>`__ step `.`

:symbols: ``array_factor``, ``element``, ``default``


.. _Predict.json#/inputs/beamproximitylimit:

beamproximitylimit
++++++++++++++++++

:type: ``float``

:doc: Same as in `ApplyBeam <ApplyBeam.html>`__ step `.`


.. _Predict.json#/inputs/correctfreqsmearing:

correctfreqsmearing
+++++++++++++++++++

:type: ``boolean``

:default: ``False``

:doc: Simulate frequency smearing based on the channel width, by multiplying the visibility with a sinc function `.`


.. _Predict.json#/inputs/correcttimesmearing:

correcttimesmearing
+++++++++++++++++++

:type: ``int``

:default: ``1``

:doc: ``Apply time smearing correction by upsampling the uvw values before predicting and averaging the predicted data afterwards. The value is the upsampling and averaging factor. A value of 0 or 1 disables time smearing.``


.. _Predict.json#/inputs/elementmodel:

elementmodel
++++++++++++

:type: ``enum``

:default: ``hamaker``

:doc: Specifies which beam model to use `.`

:symbols: ``hamaker``, ``lobes``, ``oskar``, ``oskardipole``


.. _Predict.json#/inputs/onebeamperpatch:

onebeamperpatch
+++++++++++++++

:type: ``boolean``

:doc: Same as in `ApplyBeam <ApplyBeam.html>`__ step `.`


.. _Predict.json#/inputs/operation:

operation
+++++++++

:type: ``string``

:default: ``replace``

:doc: Should the predicted visibilities be output as is (``replace``, default), should they be subtracted from the input visibilities (``subtract``) or added to them (``add``) `.`


.. _Predict.json#/inputs/outputmodelname:

outputmodelname
+++++++++++++++

:type: ``string``

:default: ``""``

:doc: Name for writing the predicted visibilities in the output DPBuffer. If empty (default), write the output in the main/default visibility buffer, thereby replacing the input visibilities. Otherwise, write the output to an extra (model) data buffer in the output DPBuffer with the given name `.`


.. _Predict.json#/inputs/parallelbaselines:

parallelbaselines
+++++++++++++++++

:type: ``boolean``

:default: ``False``

:doc: Parallelize sky model prediction over baselines instead of sources. Will speed up performance in certain cases `.`


.. _Predict.json#/inputs/sourcedb:

sourcedb
++++++++

:type: ``string``

:doc: Path of sourcedb in which a sky model is stored (the output of makesourcedb) `.` When the path ends with ``.skymodel`` or ``.txt`` DP3 expects a skymodel file as used by makesourcedb. This makes it possible to directly use a skymodel file without using makesourcedb to convert the file.  The sourcedb format is described at https://www.astron.nl/lofarwiki/doku.php?id=public:user_software:documentation:makesourcedb . In DP3 v5.3 a change was introduced to fix the projection of Gaussian sources. For backward compatibility, also the old behavior is still supported, using the key ``OrientationIsAbsolute`` in the sky model. To make sure you use the new (and most correct) behavior, add ``OrientationIsAbsolute=true`` to your sky models `.`


.. _Predict.json#/inputs/sources:

sources
+++++++

:type: ``array``

:default: ``[]``

:doc: Patches to use in the predict step of the calibration `.`


.. _Predict.json#/inputs/usebeammodel:

usebeammodel
++++++++++++

:type: ``bool``

:default: ``False``

:doc: Use the beam model in the predict part of the calibration `.`


.. _Predict.json#/inputs/usechannelfreq:

usechannelfreq
++++++++++++++

:type: ``boolean``

:doc: Same as in `ApplyBeam <ApplyBeam.html>`__ step `.`