rm_lite.tools_1d.rmclean

RM-CLEAN on 1D data

Attributes

rmclean_arrs_schema
rmclean_arrs_schema_df
rmclean_scalar_schema
rmclean_scalar_schema_df

Classes

RMClean1DResults

Resulting arrays from RM-synthesis

Functions

run_rmclean_from_synth(→ RMClean1DResults)

Run RM-CLEAN on the results of RM-synth.

Module Contents

class rm_lite.tools_1d.rmclean.RMClean1DResults

Bases: NamedTuple

Resulting arrays from RM-synthesis

clean_parameters: polars.DataFrame

RMClean parameters

fdf_arrs: polars.DataFrame

RMClean arrays

fdf_parameters: polars.DataFrame

FDF parameters

rm_lite.tools_1d.rmclean.run_rmclean_from_synth(rm_synth_1d_results: rm_lite.tools_1d.rmsynth.RMSynth1DResults, auto_mask: float = 7, auto_threshold: float = 1, max_iter: int = 10000, gain: float = 0.1, mask_arr: numpy.typing.NDArray[numpy.bool_] | None = None) → RMClean1DResults

Run RM-CLEAN on the results of RM-synth.

Parameters:

• rm_synth_1d_results (RMSynth1DResults) – Results from RM-synth.

• auto_mask (float, optional) – Masking threshold in SNR. Defaults to 7.

• auto_threshold (float, optional) – Cleaning threshold in SNR. Defaults to 1.

• max_iter (int, optional) – Maximum CLEAN iterations. Defaults to 10_000.

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

• mask_arr (NDArray[np.bool_] | None, optional) – Optional mask array. Defaults to None.

Returns:

RM-CLEAN results: fdf_parameters, fdf_arrs, clean_parameters.

Return type:

RMClean1DResults

rm_lite.tools_1d.rmclean.rmclean_arrs_schema

rm_lite.tools_1d.rmclean.rmclean_arrs_schema_df

rm_lite.tools_1d.rmclean.rmclean_scalar_schema

rm_lite.tools_1d.rmclean.rmclean_scalar_schema_df