nenupy.io.sst


SST file

Inheritance diagram of nenupy.io.sst.SST

SST(file_name)

Spectral STatistics reading class.

class nenupy.io.sst.SST(file_name)[source]

Bases: StatisticsData

Spectral STatistics reading class.

Attributes Summary

frequencies

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

mini_arrays

Retrieves the list of Mini-Arrays whose data have been recorded.

Methods Summary

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

Sub-selects SST data.

Attributes and Methods Documentation

property frequencies

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

Getter:

Sub-band mid frequencies.

Type:

Quantity

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

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

Parameters:
  • mini_array (int) – Mini-Array index. Default is 0.

  • 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'.

Returns:

SST data subset.

Return type:

ST_Slice

Example:
from nenupy.io.sst import SST

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

Retrieves the list of Mini-Arrays whose data have been recorded.

Getter:

Mini-Arrays list.

Type:

ndarray