Params API¶

Parameter container and validation for pclean.

Deprecated since version ``PcleanParams``: is deprecated. Use pclean.config.PcleanConfig with its to_casa_*() bridge methods instead. This module is retained only for backward compatibility and will be removed in a future release.

class pclean.params.PcleanParams(vis='', **kwargs)[source]¶

Bases: object

Validated, serialisable parameter container for pclean.

Organises all tclean-compatible parameters into sub-dicts that map directly to the casatools synthesis-tool APIs, plus Dask-specific settings.

Parameters:

vis (str | Sequence[str]) – Measurement set path(s).
**kwargs – Any parameter accepted by CASA tclean plus the extra nworkers, scheduler_address, threads_per_worker, memory_limit, and local_directory keys.

property specmode: str¶

property imagename: str¶

property parallel: bool¶

property niter: int¶

property nfields: int¶

property nms: int¶

property deconvolver: str¶

property is_cube: bool¶

property is_mfs: bool¶

to_dict()[source]¶

Return a plain-dict snapshot that can be sent to a Dask worker.

Return type:: dict

classmethod from_dict(d)[source]¶

Re-hydrate from a plain dict (inverse of to_dict).

Parameters:: d (dict)
Return type:: PcleanParams

clone()[source]¶

Return type:: PcleanParams

make_subcube_params(start, nchan, image_suffix)[source]¶

Return a copy tuned for a channel sub-range (cube parallelism).

Parameters:

start (int | str) – Start channel (int) or frequency/velocity string for the subcube.
nchan (int) – Number of channels in this subcube.
image_suffix (str) – Suffix appended to the base imagename.

Return type:

PcleanParams

make_rowchunk_params(partition_selpars, image_suffix)[source]¶

Return a copy with selection pars limited to a row chunk.

Used for continuum parallelism.

Parameters:

partition_selpars (dict)
image_suffix (str)

Return type:

PcleanParams