karabo.imaging.imager_oskar

Overview

This package summerizes tools and functions to be used with the imager from the OSKAR backend. This backend does not offer functionality to calculate a cleaned image. You must use RASCIL or WSClean.

Classes

class OskarDirtyImagerConfig(imaging_npixel: int, imaging_cellsize: float, combine_across_frequencies: bool = True, imaging_phase_centre: str | None = None)

Config / parameters of an OskarDirtyImager.

Adds parameters specific to OskarDirtyImager.

Attributes:

imaging_npixel (int): see DirtyImagerConfig imaging_cellsize (float): see DirtyImagerConfig combine_across_frequencies (bool): see DirtyImagerConfig imaging_phase_centre (Optional[str]): Phase centre (in SkyCoord string format).

Defaults to None.

__init__(imaging_npixel: int, imaging_cellsize: float, combine_across_frequencies: bool = True, imaging_phase_centre: str | None = None) → None

class OskarDirtyImager(config: OskarDirtyImagerConfig)

Dirty imager based on the OSKAR library.

Attributes:

config (OskarDirtyImagerConfig): Config containing parameters for

OSKAR dirty imaging.

__init__(config: OskarDirtyImagerConfig) → None

Initializes the instance with a config.

Args:

config (OskarDirtyImagerConfig): see config attribute

create_dirty_image(visibility: Visibility, /, *, output_fits_path: Path | str | None = None) → Image

Creates a dirty image from a visibility.

Args:

visibility: Visibility object

from which to create the dirty image. Contains the visibilities of an observation.

output_fits_path: Path to write the dirty image to.

Example: /tmp/dirty.fits. If None, will be set to a temporary directory and a default file name. Defaults to None.

Returns:

Image: Dirty image