Module pyxisMs2mat.pyxis4DataExtraction

Helper functions to extract useful data from an MS Table into a set a .mat file.

pyxisMs2mat.pyxis4DataExtraction.getdata(msname, srcname, mstag, freqFirst, freqLast, srcid, fileid0)[source]

Python function to access the MS and extract relevant data into a .mat file.

Parameters

  • msname (string) – Path to the MS.

  • srcname (string) – Name of the target source.

  • mstag (str) – Name tag of the MS (required if multiple MSs), by default “”.

  • freqFirst (int) – Index of the first channel frequency to extract from each spectral window, by default 0.

  • freqLast (int) – Index of the last channel frequency to extract from each spectral window, by default last channel frequency available in the MS.

  • srcid (int) – Field id of the target source.

  • fileid0 (int) – ID of the last frequency channel if MSs of multiple frequency bandwidths are provided.

Returns

ID of the last frequency channel if MSs of multiple frequency bandwidths are provided.

Return type

int

pyxisMs2mat.pyxis4DataExtraction.getdata_ms(msf='$MS', srcname='$SRCNAME', mstag='$MSTAG', srcid='$FIELDID', freqFirst='$FIRSTCH', freqLast='$LASTCH')[source]

Pyxis function to be used from the command line to extract data from a single MS. Data from all available spectral windows will be extracted.

Parameters

  • msf (str, required) – Path to the MS.

  • srcname (str, optional) – Name of the target source, by default “”.

  • mstag (str, optional) – Name tag of the MS (required if multiple MSs), by default “”.

  • srcid (str, optional) – Field id of the target source, by default 0.

  • freqFirst (str, optional) – Index of the first channel frequency to extract from each spectral window, by default 0.

  • freqLast (str, optional) – Index of the last channel frequency to extract from each spectral window, by default last channel frequency available in the MS.

pyxisMs2mat.pyxis4DataExtraction.getdata_ms_concat_bandwidth(msf_lowbandwidth='$MSLOW', msf_highbandwidth='$MSHIGH', srcname='$SRCNAME', srcid='$FIELDID', mstag='$MSTAG', freqFirst='$FIRSTCH', freqLast='$LASTCH')[source]

Pyxis function to be used from the command line to extract data resulting from the combination of two MSs spanning two different frequency bands. Both MSs are expected to have the same specs of their associated spectral windows.

Parameters

  • msf_lowbandwidth (str, required) – Path to the low frequency band MS.

  • msf_highbandwidth (str, required) – Path to the high frequency band MS.

  • srcname (str, optional) – Name of the target source, by default “”.

  • srcid (str, optional) – Field id of the target source, by default 0.

  • mstag (str, optional) – Name tag of the MS (required if multiple MSs), by default “”.

  • freqFirst (str, optional) – Index of the first channel frequency to extract from each spectral window, by default 0.

  • freqLast (str, optional) – Index of the last channel frequency to extract from each spectral window, by default last channel frequency available in the MS.