arrakis.rmclean_oncuts

Run RM-synthesis on cutouts in parallel

Module Contents

Functions

cli()

Command-line interface

main(field, outdir, host, epoch[, username, password, ...])

Main script

rmclean1d(→ pymongo.UpdateOne)

1D RM-CLEAN

rmclean3d(→ pymongo.UpdateOne)

Run RM-CLEAN on 3D cube

arrakis.rmclean_oncuts.cli()[source]

Command-line interface

arrakis.rmclean_oncuts.main(field: str, outdir: pathlib.Path, host: str, epoch: int, username: str | None = None, password: str | None = None, dimension='1d', database=False, savePlots=True, limit: int | None = None, cutoff: float = -3, maxIter=10000, gain=0.1, window=None, showPlots=False, rm_verbose=False)[source]

Main script

Parameters:
  • field (str) – RACS field name.

  • outdir (str) – Output directory.

  • host (str) – MongoDB host IP.

  • username (str, optional) – Mongo username. Defaults to None.

  • password (str, optional) – Mongo password. Defaults to None.

  • dimension (str, optional) – Which dimension to run RM-CLEAN. Defaults to “1d”.

  • verbose (bool, optional) – Verbose output. Defaults to True.

  • database (bool, optional) – Update database. Defaults to False.

  • savePlots (bool, optional) – Save plots. Defaults to True.

  • validate (bool, optional) – Run validation. Defaults to False.

  • limit (int, optional) – Limit number of sources processed. Defaults to None.

  • cutoff (float, optional) – CLEAN cutoff (in sigma). Defaults to -3.

  • maxIter (int, optional) – Max CLEAN iterations. Defaults to 10000.

  • gain (float, optional) – Clean gain. Defaults to 0.1.

  • showPlots (bool, optional) – Show interactive plots. Defaults to False.

  • rm_verbose (bool, optional) – Verbose output from RM-CLEAN. Defaults to False.

arrakis.rmclean_oncuts.rmclean1d(comp: dict, outdir: str, cutoff: float = -3, maxIter=10000, gain=0.1, showPlots=False, savePlots=False, rm_verbose=True, window=None) pymongo.UpdateOne[source]

1D RM-CLEAN

Parameters:
  • comp (dict) – Mongo entry for component.

  • outdir (str) – Output directory.

  • cutoff (float, optional) – CLEAN cutouff (in sigma). Defaults to -3.

  • maxIter (int, optional) – Maximum CLEAN interation. Defaults to 10000.

  • gain (float, optional) – CLEAN gain. Defaults to 0.1.

  • showPlots (bool, optional) – Show CLEAN plots. Defaults to False.

  • savePlots (bool, optional) – Save CLEAN plots. Defaults to False.

  • rm_verbose (bool, optional) – Verbose RM-CLEAN. Defaults to True.

Returns:

MongoDB update query.

Return type:

pymongo.UpdateOne

arrakis.rmclean_oncuts.rmclean3d(island: dict, outdir: str, cutoff: float = -3, maxIter=10000, gain=0.1, rm_verbose=False) pymongo.UpdateOne[source]

Run RM-CLEAN on 3D cube

Parameters:
  • island (dict) – MongoDB island entry.

  • outdir (str) – Output directory.

  • cutoff (float, optional) – CLEAN cutoff (in sigma). Defaults to -3.

  • maxIter (int, optional) – Max CLEAN iterations. Defaults to 10000.

  • gain (float, optional) – CLEAN gain. Defaults to 0.1.

  • rm_verbose (bool, optional) – Verbose output. Defaults to False.

Returns:

MongoDB update query.

Return type:

pymongo.UpdateOne