astrohack.io.point_mds

Classes

AstrohackPointFile

Data class for point data.

Module Contents

class AstrohackPointFile(file: str)[source]

Bases: astrohack.io.base_mds.AstrohackBaseFile

Data class for point data.

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

plot_pointing_in_time(destination: str, ant: str | List[str] = 'all', pointing_key: str = 'DIRECTIONAL_COSINES', plot_antennas_separately: bool = False, azel_unit: str = 'deg', time_unit: str = 'hour', az_scale: Tuple | List[float] | numpy.ndarray | None = None, el_scale: Tuple | List[float] | numpy.ndarray | None = None, time_scale: Tuple | List[float] | numpy.ndarray | None = None, figure_size: Tuple | List[float] | numpy.ndarray = (5.0, 6.4), display: bool = False, dpi: int = 300) → None[source]

Plot Pointing for antennas in time.

Parameters:

  • destination (str) – Name of the destination folder to contain plot(s)

  • ant (str, list, optional) – Antenna(s) to plot, default is “all”

  • pointing_key (str, optional) – Which xds pointing data key to plot, defaults to “DIRECTIONAL_COSINES”

  • plot_antennas_separately (bool, optional) – Create an individual plot file for each antenna?

  • azel_unit (str, optional) – Unit for Azimuth and Elevation in the plot(s), valid values are trigonometric units, default is deg

  • time_unit (str, optional) – Unit for time in the plot(s), valid values are time units, default is hour

  • az_scale (Union[Tuple, List[float], np.array], optional) – Azimuth plot limits, defaults to all Azimuths present when None.

  • el_scale (Union[Tuple, List[float], np.array], optional) – Elevation plot limits, defaults to all Elevations present when None.

  • time_scale (Union[Tuple, List[float], np.array], optional) – Time plot limits, defaults to all times present when None

  • display (bool, optional) – Display plot(s) inline or suppress, defaults to True

  • figure_size (numpy.ndarray, list, tuple, optional) – 2 element array/list/tuple with the plot sizes in inches

  • dpi (int, optional) – dots per inch to be used in plots, default is 300

Plot antenna pointing info in time together in one plot, or individually for each antenna.

plot_array_configuration(destination: str, stations: bool = True, zoff: bool = False, unit: str = 'm', box_size: int | float | None = None, figure_size: Tuple | List[float | int] | numpy.ndarray | None = None, display: bool = False, dpi: int = 300) → None[source]

Plot antenna positions.

Parameters:

  • destination (str) – Name of the destination folder to contain plot

  • stations (bool, optional) – Add station names to the plot, defaults to True

  • zoff (bool, optional) – Add Elevation offsets to the plots, defaults to False

  • unit (str, optional) – Unit for the plot, valid values are length units, default is km

  • box_size (int, float, optional) – Size of the box for plotting the inner part of the array in unit, when none the box size is 20% of the total size of the array, default is None

  • display (bool, optional) – Display plots inline or suppress, defaults to True

  • figure_size (numpy.ndarray, list, tuple, optional) – 2 element array/list/tuple with the plot sizes in inches

  • dpi (int, optional) – dots per inch to be used in plots, default is 300

Plot the array configuration from the antenna positions.

set_antennas_as_reference(reference_antennas: str | list[str] | tuple[str], write_changes: bool = True) → None[source]

Modify point_mds data to make specific antennas reference antennas, useful for older datasets that contain wrong pointing data for reference antennas.

Parameters:

  • reference_antennas (Union[str, list[str], tuple[str]]) – Antennas to transform into reference antennas

  • write_changes (bool, optional) – Write the modified mds to disk?