Crate mwalib

Expand description

A library to simplify reading Murchison Widefield Array (MWA) raw visibilities, voltages and metadata.

Re-exports§

built_info
ffi: This module exists purely for other languages to interface with mwalib.
fits_read: Helper functions for reading FITS files.
misc: General helper/utility methods

fits_open: Open a fits file.
fits_open_hdu: Open a fits file’s HDU by index.
fits_open_hdu_by_name: Open a fits file’s HDU by name.
get_fits_col: Get a column of values from a fits file’s table HDU.
get_fits_float_image_into_buffer: Given a FITS file pointer and a HDU, read the associated float image.
get_fits_image: Given a FITS file pointer and a HDU, read the associated image.
get_hdu_image_size: Get the size of the image on the supplied FITS file pointer and HDU.
get_optional_fits_key: Given a FITS file pointer, a HDU that belongs to it, and a keyword that may or may not exist, pull out the value of the keyword, parsing it into the desired type.
get_optional_fits_key_long_string: Given a FITS file pointer, and a keyword to a long string keyword that may or may not exist, pull out the long string of the keyword. This deals with FITSs CONTINUE mechanism by calling a low level fits function.
get_required_fits_key: Given a FITS file pointer, a HDU that belongs to it, and a keyword, pull out the value of the keyword, parsing it into the desired type.
get_required_fits_key_long_string: Given a FITS file pointer, and a keyword to a long string keyword, pull out the long string of the keyword. This deals with FITSs CONTINUE mechanism by calling a low level fits function.

Antenna: Structure for storing MWA antennas (tiles without polarisation) information from the metafits file
Baseline: This is a struct for our baselines, so callers know the antenna ordering
CalibrationFit: Calibration Fits This table is present in some metafits files, and if present, contains data from the calibration_solutions database table with a calibration fit from the most recent fitted calibration observation with the same frequency channel setttings as this observation.
CoarseChannel: This is a struct for coarse channels
CorrelatorContext: This represents the basic metadata and methods for an MWA correlator observation.
MetafitsContext: Metafits context. This represents the basic metadata for an MWA observation.
Rfinput: Structure for storing MWA rf_chains (tile with polarisation) information from the metafits file
SignalChainCorrection: Signal chain correction table
TimeStep: This is a struct for our timesteps NOTE: correlator timesteps use unix time, voltage timesteps use gpstime, but we convert the two depending on what we are given
VoltageBeam
VoltageContext: This represents the basic metadata and methods for an MWA voltage capture system (VCS) observation.

CableDelaysApplied: The type of cable delays applied to the data
CalibrationFitError: EfinputError subtypes
CoarseChannelError: CoarseChannelError subtypes
GeometricDelaysApplied: The type of geometric delays applied to the data
GpuboxError: GpuboxError subtypes - mainly used by CorrelatorContext
MWAMode: The MODE the system was in for this observation
MWAVersion: Enum for all of the known variants of file format based on Correlator version
MetafitsError: Metafits error subtypes - used by MetafitsContext
MwalibError: MwalibError subtypes
Pol: Instrument polarisation.
ReceiverType: ReceiverType enum.
RfinputError: RfinputError subtypes
VisPol: Visibility polarisations
VoltageFileError: VoltageFileError subtypes - mainly used by VoltageContext

MWALIB_MWA_ALTITUDE_METRES: The MWA’s altitude in metres.
MWALIB_MWA_COAX_V_FACTOR: the velocity factor of electic fields in RG-6 like coax cable
MWALIB_MWA_LATITUDE_RADIANS: NOTE: the below constants are here for FFI compatibility If you are using Marlu, then it’s recommended to use the constants from that library
MWALIB_MWA_LONGITUDE_RADIANS: The MWA’s longitude on Earth in radians. This is 116d40m14.93485s.
MWALIB_SPEED_OF_LIGHT_IN_VACUUM_M_PER_S: speed of light in m/s