nenupy.io.bst


BST file

Inheritance diagram of nenupy.io.bst.BST

BST(file_name[, beam])

Beamlet STatistics reading class.

class nenupy.io.bst.BST(file_name, beam=0)[source]

Bases: StatisticsData

Beamlet STatistics reading class.

Attributes Summary

analog_beams

Lists the analog beam indices used for the recording of BST data.

digital_beams

Lists the digital beam indices used for the recording of BST data.

analog_beam

Prints the analog beam index currently corresponding to the digital beam index.

beam

Digital beam index.

analog_pointing

Retrieves the analog pointing associated to the current analog_beam selected.

digital_pointing

Retrieves the digital pointing associated to the current beam selected.

frequencies

Retrieves the sub-band middle frequency of all the sub-bands recorded for the selected beam.

mini_arrays

Retrieves the list of Mini-Arrays used to record BST data for the selected analog_beam.

Methods Summary

get([frequency_selection, time_selection, ...])

Sub-selects BST data.

Attributes and Methods Documentation

property analog_beam

Prints the analog beam index currently corresponding to the digital beam index.

Getter:

Analog beam index.

Type:

int

property analog_beams

Lists the analog beam indices used for the recording of BST data.

Getter:

List of analog beam indices.

Type:

ndarray

property analog_pointing

Retrieves the analog pointing associated to the current analog_beam selected.

Getter:

Analog pointing (time, azimuth, elevation).

Type:

tuple`(:class:`~astropy.time.Time, Quantity, Quantity)

property beam

Digital beam index.

Setter:

Beam index.

Getter:

Beam index.

Type:

int

property digital_beams

Lists the digital beam indices used for the recording of BST data.

Getter:

List of digital beam indices.

Type:

ndarray

property digital_pointing

Retrieves the digital pointing associated to the current beam selected.

Getter:

Digital pointing (time, azimuth, elevation).

Type:

tuple`(:class:`~astropy.time.Time, Quantity, Quantity)

property frequencies

Retrieves the sub-band middle frequency of all the sub-bands recorded for the selected beam.

Getter:

Sub-band mid frequencies.

Type:

Quantity

get(frequency_selection=None, time_selection=None, polarization='NW', beam=0)[source]

Sub-selects BST data. frequency_selection and time_selection arguments accept str values formatted as, e.g., '>={value}' or '>={value_1} & <{value_2}' or '=={value}'.

Parameters:
  • frequency_selection (str) – Frequency selection. The expected '{value}' format is frequency units, e.g. '>=50MHz' or '< 1 GHz'. Default is None (i.e., no selection upon frequency).

  • time_selection (str) – Time selection. The expected '{value}' format is ISOT, e.g. '>=2022-01-01T12:00:00'. Default is None (i.e., no selection upon time).

  • polarization (str) – Polarization selection, must be either 'NW' or 'NE'. Default is 'NW'.

  • beam (int) – Digital beam index selection. Default is 0.

Returns:

BST data subset.

Return type:

ST_Slice

Example:
from nenupy.io.bst import BST

bst = BST("/path/to/BST.fits")
data = bst.get(
    frequency_selection="<=52MHz",
    time_selection='>=2022-01-24T11:08:10 & <2022-01-24T11:14:08',
    polarization="NW",
    beam=8
)
property mini_arrays

Retrieves the list of Mini-Arrays used to record BST data for the selected analog_beam.

Getter:

Mini-Arrays list.

Type:

ndarray