.. _H5ParmPredict.json#/:

H5ParmPredict
=============

Subtract multiple directions of visibilities corrupted by an instrument model (in H5Parm) generated by DDECal.


.. _H5ParmPredict.json#/inputs:

inputs
******


.. _H5ParmPredict.json#/inputs/type:

type
++++

:type: ``string``

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


.. _H5ParmPredict.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 `.`


.. _H5ParmPredict.json#/inputs/applycal.correction:

applycal.correction
+++++++++++++++++++++++

:type: ``string``

:doc: SolTab which contains the directions to be predicted, or "fulljones" `.`


.. _H5ParmPredict.json#/inputs/applycal.parmdb:

applycal.parmdb
+++++++++++++++++++

:type: ``string``

:doc: Path of the h5parm in which the corruptions are stored `.`


.. _H5ParmPredict.json#/inputs/beammode:

beammode
++++++++

:type: ``enum``

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

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


.. _H5ParmPredict.json#/inputs/directions:

directions
++++++++++

:type: ``string?``

:default: ``[]``

:doc: List of directions to include. Each of those directions needs to be in the h5parm soltab. If empty, all directions in the soltab are predicted.  The names of the directions need to look like ``[dir1,dir2]``, where ``dir1`` and ``dir2`` are patches in the sourcedb. By default, the full list of directions is taken from the H5Parm. The convention for naming directions in DDECal in H5Parm is ``[patch1,patch2]``. This directions parameter can be used to predict / subtract a subset of the directions `.`


.. _H5ParmPredict.json#/inputs/onebeamperpatch:

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

:type: ``string?``

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


.. _H5ParmPredict.json#/inputs/operation:

operation
+++++++++

:type: ``string``

:default: ``replace``

:doc: Should the predicted visibilities replace those being processed (``replace``, default), should they be subtracted from those being processed (``subtract``) or added to them (``add``) `.`


.. _H5ParmPredict.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.


.. _H5ParmPredict.json#/inputs/usebeammodel:

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

:type: ``bool``

:default: ``False``

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


.. _H5ParmPredict.json#/inputs/usechannelfreq:

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

:type: ``boolean?``

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