flint.peel.jolly

Utilities to run the holly-roger sun flagging utilities

Classes

TukeyTractorOptions

Container for the Jolly-Roger tractor operations. These

Functions

_create_jolly_tractor_options(...)
cli(→ None)
get_parser(→ argparse.ArgumentParser)
jolly_roger_tractor(→ flint.options.MS)	Run the jolly_roger tukey tractor method to null towards an object.

Module Contents

class flint.peel.jolly.TukeyTractorOptions(/, **data: Any)

Bases: flint.options.BaseOptions

Container for the Jolly-Roger tractor operations. These options map into the jolly_roger.tractor.TukeyTaperOptions class. Exception being that this container omits the usage of astropy quantities.

apply_towards_object: bool = True

apply the taper using the delay towards the target object. Otherwise delays away from zero are nulled with potential for significant smearing effects.

chunk_size: int = 1000

Size of the row-wise chunking iterator

copy_column_data: bool = False

Copy the data from the data column to the output column before applying the taper

data_column: str = 'DATA'

The visibility column to modify

dry_run: bool = False

Indicates whether the data will be written back to the measurement set

elevation_cut_deg: float = -1

The elevation cut-off for the target object, in degrees. Defaults to -1.

ignore_nyquist_zone: int = 2

Do not apply the tukey taper if object is beyond this Nyquist zone

make_plots: bool = False

Create a small set of diagnostic plots. This can be slow.

outer_width: float

The start of the tapering in frequency space, in radians

output_column: str = 'CORRECTED_DATA'

The output column to be created with the modified data

overwrite: bool = False

If the output column exists it will be overwritten

target_object: str = 'Sun'

The target object to apply the delay towards.

tukey_width: float

The width of the tapered region in frequency space, in radians

flint.peel.jolly._create_jolly_tractor_options(ms_path: pathlib.Path, tukey_tractor_options: TukeyTractorOptions) → jolly_roger.tractor.TukeyTractorOptions

flint.peel.jolly.cli() → None

flint.peel.jolly.get_parser() → argparse.ArgumentParser

flint.peel.jolly.jolly_roger_tractor(ms: flint.options.MS | pathlib.Path, tukey_tractor_options: TukeyTractorOptions | None = None, update_tukey_tractor_options: dict[str, Any] | None = None) → flint.options.MS

Run the jolly_roger tukey tractor method to null towards an object.

Parameters:

• ms (MS | Path) – The measurement set to modify

• tukey_tractor_options (TukeyTractorOptions | None, optional) – Settings to modify the tukey tractor algorithm. If None defaults are used. Defaults to None.

• update_tukey_tractor_options (dict[str, Any] | None, optional) – Over-rides the options of tukey_tractor_options. Defaults to None.

Returns:

Reference to modified measurement set.

Return type:

MS