SDImaging

class SDImaging(inputs)[source]

Bases: StandardTaskTemplate

SDImaging processing class.

Attributes Summary

is_multi_vis_task

required_pols

stokes

Methods Summary

analyse(results)

Analyse results generated by prepare.

calculate_theoretical_image_rms(cp, rgp, pp)

Calculate theoretical RMS of an image (PIPE-657).

get_imagename(source, spwids[, antenna, ...])

Generate a filename of the image.

get_raster_info_list(cp, rgp)

Retrun a list of raster information.

prepare()

Execute imaging process.

Attributes Documentation

is_multi_vis_task = True
required_pols = ['XX', 'YY']
stokes = 'I'

Methods Documentation

analyse(results: SDImagingResults) → SDImagingResults[source]

Analyse results generated by prepare.

Analysis includes a detection of edge channels as well as channel range for ATM feature. Based on these information, contamination of the image is examined.

Parameters:

results -- Results object

Returns:

Results object

calculate_theoretical_image_rms(cp: CommonParameters, rgp: ReductionGroupParameters, pp: PostProcessParameters) → dict[str, float][source]

Calculate theoretical RMS of an image (PIPE-657).

Parameters:

  • cp -- Common parameter object of prepare()

  • rgp -- Reduction group parameter object of prepare()

  • pp -- Imaging post process parameters of prepare()

Note: the number of elements in rgp.combined.antids, fieldids, spws, and pols should be equal

to that of infiles

Returns:

A quantum value of theoretical image RMS. The value of quantity will be negative when calculation is aborted, i.e., -1.0 Jy/beam

get_imagename(source: str, spwids: list[int], antenna: str = None, asdm: str = None, stokes: str = None, specmode: str = 'cube') → str[source]

Generate a filename of the image.

Parameters:

  • source -- Source name

  • spwids -- SpW IDs

  • antenna -- Antenna name. Defaults to None.

  • asdm -- ASDM. Defaults to None.

  • stokes -- Stokes parameter. Defaults to None.

  • specmode -- specmode for tsdimaging. Defaults to 'cube'.

Raises:

ValueError -- if asdm is not provided for ampcal

Returns:

A filename of the image

get_raster_info_list(cp: CommonParameters, rgp: ReductionGroupParameters) → list[RasterInfo][source]

Retrun a list of raster information.

Each raster infromation is analyzed for element wise combination of infile, antenna, field, and SpW IDs in input parameter lists.

Parameters:

  • cp -- Common parameter object of prepare()

  • rgp -- Reduction group parameter object of prepare()

Returns:

A list of RasterInfo. If raster information could not be obtained, the corresponding elements in the list will be None.

prepare() → SDImagingResults[source]

Execute imaging process. This is the main method of imaging.

Returns:

result object of imaging