astrohack.io.beamcut_mds

Classes

AstrohackBeamcutFile

Data class for beam cut data.

Module Contents

class AstrohackBeamcutFile(file: str)[source]

Bases: astrohack.io.base_mds.AstrohackBaseFile

Data class for beam cut data.

Data within an object of this class can be selected for further inspection, plotted or produce a report

observation_summary(summary_file: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', az_el_key: str = 'center', phase_center_unit: str = 'radec', az_el_unit: str = 'deg', time_format: str = '%d %h %Y, %H:%M:%S', tab_size: int = 3, print_summary: bool = True, parallel: bool = False) → None[source]

Create a Summary of observation information

Parameters:

  • summary_file (str) – Text file to put the observation summary

  • ant (list or str, optional) – antenna ID to use in subselection, defaults to “all” when None, ex. ea25

  • ddi (list or int, optional) – data description ID to use in subselection, defaults to “all” when None, ex. 0

  • az_el_key (str, optional) – What type of Azimuth & Elevation information to print, ‘mean’, ‘median’ or ‘center’, default is ‘center’

  • phase_center_unit (str, optional) – What unit to display phase center coordinates, ‘radec’ and angle units supported, default is ‘radec’

  • az_el_unit (str, optional) – Angle unit used to display Azimuth & Elevation information, default is ‘deg’

  • time_format (str, optional) – datetime time format for the start and end dates of observation, default is “%d %h %Y, %H:%M:%S”

  • tab_size (int, optional) – Number of spaces in the tab levels, default is 3

  • print_summary (bool, optional) – Print the summary at the end of execution, default is True

  • parallel (bool, optional) – Run in parallel, defaults to False

Returns:

None

Return type:

NoneType

Additional Information

This method produces a summary of the data in the AstrohackBeamcutFile displaying general information, spectral information, beam image characteristics and aperture image characteristics.

plot_beamcut_in_amplitude(destination: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', lm_unit: str = 'amin', azel_unit: str = 'deg', y_scale: list[float | int] | None = None, display: bool = False, dpi: int = 300, parallel: bool = False) → None[source]

Plot beamcuts contained in the beamcut_mds in amplitude

Parameters:

  • destination (str) – Directory into which to save plots.

  • ant (list or str, optional) – Antenna ID to use in subselection, e.g. ea25, defaults to “all”.

  • ddi (list or int, optional) – Data description ID to use in subselection, e.g. 0, defaults to “all”.

  • lm_unit (str, optional) – Unit for L/M offsets, default is “amin”.

  • azel_unit (str, optional) – Unit for Az/El information, default is “deg”.

  • y_scale (str, optional) – Set the y scale for the plots.

  • display (bool, optional) – Display plots during execution, default is False.

  • dpi (int, optional) – Pixel resolution for plots, default is 300.

  • parallel (bool, optional) – Run in parallel, defaults to False.

Returns:

None

Return type:

NoneType

plot_beamcut_in_db(destination: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', lm_unit: str = 'amin', azel_unit: str = 'deg', y_scale: list[float | int] | tuple[float | int] | None = None, display: bool = False, dpi: int = 300, parallel: bool = False) → None[source]

Plot beamcuts contained in the beamcut_mds in attenuation

Parameters:

  • destination (str) – Directory into which to save plots.

  • ant (list or str, optional) – Antenna ID to use in subselection, e.g. ea25, defaults to “all”.

  • ddi (list or int, optional) – Data description ID to use in subselection, e.g. 0, defaults to “all”.

  • lm_unit (str, optional) – Unit for L/M offsets, default is “amin”.

  • azel_unit (str, optional) – Unit for Az/El information, default is “deg”.

  • y_scale (str, optional) – Set the y scale for the plots.

  • display (bool, optional) – Display plots during execution, default is False.

  • dpi (int, optional) – Pixel resolution for plots, default is 300.

  • parallel (bool, optional) – Run in parallel, defaults to False.

Returns:

None

Return type:

NoneType

plot_beamcut_lm_offsets(destination: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', lm_unit: str = 'amin', azel_unit: str = 'deg', display: bool = False, dpi: int = 300, parallel: bool = False) → None[source]

Plot beamcuts contained in the beamcut_mds over the sky

Parameters:

  • destination (str) – Directory into which to save plots.

  • ant (list or str, optional) – Antenna ID to use in subselection, e.g. ea25, defaults to “all”.

  • ddi (list or int, optional) – Data description ID to use in subselection, e.g. 0, defaults to “all”.

  • lm_unit (str, optional) – Unit for L/M offsets, default is “amin”.

  • azel_unit (str, optional) – Unit for Az/El information, default is “deg”.

  • display (bool, optional) – Display plots during execution, default is False.

  • dpi (int, optional) – Pixel resolution for plots, default is 300.

  • parallel (bool, optional) – Run in parallel, defaults to False.

Returns:

None

Return type:

NoneType

plot_beamcut_in_phase(destination: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', lm_unit: str = 'amin', azel_unit: str = 'deg', phase_unit: str = 'deg', phase_scale: List[float] | Tuple[float] | numpy.ndarray | None = None, display: bool = False, dpi: int = 300, parallel: bool = False) → None[source]

Plot beamcuts contained in the beamcut_mds in phase

Parameters:

  • destination (str) – Directory into which to save plots.

  • ant (list or str, optional) – Antenna ID to use in subselection, e.g. ea25, defaults to “all”.

  • ddi (list or int, optional) – Data description ID to use in subselection, e.g. 0, defaults to “all”.

  • lm_unit (str, optional) – Unit for L/M offsets, default is “amin”.

  • azel_unit (str, optional) – Unit for Az/El information, default is “deg”.

  • phase_unit (str, optional) – Unit for the phase plots, default is “deg”.

  • phase_scale (Union[List[float], Tuple[float], np.array], optional) – Scale for the phase plots, in phase_unit, default is None, meaning 1 full cycle.

  • display (bool, optional) – Display plots during execution, default is False.

  • dpi (int, optional) – Pixel resolution for plots, default is 300.

  • parallel (bool, optional) – Run in parallel, defaults to False.

Returns:

None

Return type:

NoneType

export_beamcut_report(destination: str, ant: str | List[str] = 'all', ddi: str | int | List[int] = 'all', lm_unit: str = 'amin', azel_unit: str = 'deg', parallel: bool = False) → None[source]

Create reports on the parameters of the gaussians fitted to the beamcut.

Parameters:

  • destination (str) – Directory into which to save the reports.

  • ant (list or str, optional) – Antenna ID to use in subselection, e.g. ea25, defaults to “all”.

  • ddi (list or int, optional) – Data description ID to use in subselection, e.g. 0, defaults to “all”.

  • lm_unit (str, optional) – Unit for L/M offsets, default is “amin”.

  • azel_unit (str, optional) – Unit for Az/El information, default is “deg”.

  • parallel (bool, optional) – run in parallel, defaults to False.

Returns:

None

Return type:

NoneType