ska_pst.send.metadata
Module class for structure used for writing YAML meta data files.
- class ska_pst.send.metadata.PstConfig(image: str = 'artefact.skao.int/ska-pst/ska-pst', version: str = '2.2.0')[source]
A data class to represent the config field of a pst metadata file.
Configuration of generating software.
- image: str = 'artefact.skao.int/ska-pst/ska-pst'
The PST image name.
- version: str = '2.2.0'
The version of PST.
- class ska_pst.send.metadata.PstContext(observer: str = '', intent: str = 'Tied-array beam observation', notes: str = '')[source]
A data class to represent the context field of a pst metadata file.
context is meant to be data passed verbatim through from OET/TMC as part of AssignResources (DLM) or Configure (other sub-systems). To be made part of ska_schemas schemas.
- intent: str = 'Tied-array beam observation'
The intent passed from OET/TMC
- notes: str = ''
The notes passed from OET/TMC
- observer: str = ''
Name or role of the person conducting the observation
- class ska_pst.send.metadata.PstFiles(description: str, path: str, size: int, status: str)[source]
A data class to represent the files field of a PST metadata file.
Documentation concerning files coupled to the PST metadata file.
- description: str
The description of the file.
- path: str
The relative path of the file.
- size: int
The size of the file in bytes.
- status: str
The status of the file.
- class ska_pst.send.metadata.PstMetadata(interface: str = 'http://schema.skao.int/ska-data-product-meta/0.1', execution_block: str = '', context: ~ska_pst.send.metadata.PstContext = <factory>, config: ~ska_pst.send.metadata.PstConfig = <factory>, files: list[ska_pst.send.metadata.PstFiles] = <factory>, obscore: ~ska_pst.send.metadata.PstObsCore = <factory>)[source]
Class representing the PST metadata.
This class encapsulates the metadata information for a PST (Processing Science Target) data product. It includes details about the interface, execution block, context, configuration, files, and observation core information.
- context: PstContext
The context information for the PST data.
- execution_block: str = ''
The execution block identifier.
- files: list[ska_pst.send.metadata.PstFiles]
List of files associated with the PST data.
- interface: str = 'http://schema.skao.int/ska-data-product-meta/0.1'
The interface of the metadata.
- obscore: PstObsCore
The observation core information for the PST data.
- class ska_pst.send.metadata.PstObsCore(dataproduct_type: str = 'timeseries', dataproduct_subtype: str = 'voltages', calib_level: int = 0, obs_id: str = '', access_estsize: int = 0, target_name: str = '', s_ra: float = 0.0, s_dec: float = 0.0, t_min: float = 0.0, t_max: float = 0.0, t_resolution: float = 0.0, t_exptime: float = 0.0, facility_name: str = 'SKA-Observatory', instrument_name: str = '', pol_xel: int = 0, pol_states: str = '', em_xel: int = 0, em_unit: str = 'Hz', em_min: float = 0.0, em_max: float = 0.0, em_res_power: str = 'null', em_resolution: float = 0.0, o_ucd: str = 'null')[source]
A dataclass to definition of the standard IVOA ObsCore table/view.
- access_estsize: int = 0
An estimate of the overall data product size in bytes.
This value derived from the recorded files of the scan.
- calib_level: int = 0
The calibration level.
Valid values are 0, 1, 2, 3, or 4.
0 = Raw instrumental data 1 = Instrumental data in a standard format (FITS, VOTable, SDFITS, ASDM, etc.) 2 = Calibrated, science ready data with the instrument signature removed 3 = Enhanced data products like mosaics, resampled or drizzled images, or heavily processed survey fields 4 = Analysis data products generated after some scientific data manipulation or interpretation.
- dataproduct_subtype: str = 'voltages'
The subtype of the data product.
Values can be voltages, spectra, oversampled, channelised, quantised voltages
- dataproduct_type: str = 'timeseries'
Logical data product type.
Values can be image, cube, spectrum, sed, timeseries, visibility, event or measurements.
- em_max: float = 0.0
Stop in spectral coordinates (vacuum wavelength).
For PST this is the centre frequency of the last PST channel.
- em_min: float = 0.0
Start in spectral coordinates (vacuum wavelength).
For PST this is the centre frequency of the first PST channel.
- em_res_power: str = 'null'
Spectral resolving power.
For PST this is not used and defaults to null.
- em_resolution: float = 0.0
The spectral resolution.
For PST this is the width of a PST channel in Hz.
- em_unit: str = 'Hz'
Spectral coordinates unit type.
The unit used of the values of
em_minandem_max.This defaults to Hz.
- em_xel: int = 0
Number of elements along the spectral axis.
For PST this is the number output channels (e.g. NCHAN_OUT).
- facility_name: str = 'SKA-Observatory'
The observatory or facility used to collect the data.
- instrument_name: str = ''
The name of the instrument used for the acquisition of the observation.
- o_ucd: str = 'null'
Unified Content Descriptor of observable
Example of this are phot.count or phot.flux.density see section 4.18 and B.6.4.1 in Obscore standard, UCD1+ controlled vocabulary and especially list of observables),
This is not used PST and is set defaults to “null”.
- obs_id: str = ''
The scan id.
- pol_states: str = ''
List of polarisation states.
- pol_xel: int = 0
Number of polarisation samples.
This is the number of output polarisations (i.e. NPOL_OUT), not the input signal NPOL.
- s_dec: float = 0.0
Centre of observation declination, ICRS.
- s_ra: float = 0.0
The centre of observation right ascension, ICRS.
This value is in degrees, not hour angle.
- t_exptime: float = 0.0
Total exposure time.
This the length of the PST scan.
- t_max: float = 0.0
End time in Modified Julian Date (MJD).
- t_min: float = 0.0
Start time in Modified Julian Date (MJD).
- t_resolution: float = 0.0
Temporal resolution FWHM (full width at half maximum) in seconds.
For PST this the TSAMP converted to seconds. This is the output TSAMP which for Voltage Recorder and Flow Through is the same as the input TSAMP. For Detected filterbank this can be different when there are time averaging or inverse filterbank applied.
- target_name: str = ''
The name of the target.
For PST this is the SOURCE field.