radio migration

.schemalintrc.js

@@ -22,6 +22,7 @@ module.exports = {
     { name: "private" },
     { name: "public" },
     { name: "rawdata" },
+    { name: "radio" },
   ],
   rules: {
     "name-casing": ["error", "snake"],

app/data/model/__init__.py

@@ -13,6 +13,7 @@
 from app.data.model.nature import NatureCatalogObject
 from app.data.model.note import NoteCatalogObject
 from app.data.model.photometry import PhotometryIsophotalCatalogObject, PhotometryTotalCatalogObject
+from app.data.model.radio import RadioCatalogObject
 from app.data.model.records import (
     CrossmatchRecordRow,
     DesignationRecord,
@@ -66,4 +67,5 @@
     "NoteCatalogObject",
     "get_catalog_object_type",
     "Bibliography",
+    "RadioCatalogObject",
 ]

app/data/model/helpers.py

@@ -1,4 +1,4 @@
-from app.data.model import designation, geometry, icrs, interface, nature, note, photometry, redshift
+from app.data.model import designation, geometry, icrs, interface, nature, note, photometry, radio, redshift
 
 _CATALOG_OBJECT_TYPES: dict[interface.RawCatalog, type[interface.CatalogObject]] = {
     interface.RawCatalog.DESIGNATION: designation.DesignationCatalogObject,
@@ -9,6 +9,7 @@
     interface.RawCatalog.PHOTOMETRY__ISOPHOTAL: photometry.PhotometryIsophotalCatalogObject,
     interface.RawCatalog.GEOMETRY: geometry.GeometryCatalogObject,
     interface.RawCatalog.NOTE: note.NoteCatalogObject,
+    interface.RawCatalog.RADIO: radio.RadioCatalogObject,
 }
 
 

app/data/model/interface.py

@@ -19,6 +19,7 @@ class RawCatalog(enum.Enum):
     PHOTOMETRY__ISOPHOTAL = "photometry_isophotal"
     GEOMETRY = "geometry"
     NOTE = "note"
+    RADIO = "radio"
 
 
 RUNTIME_RAW_CATALOGS: frozenset[RawCatalog] = frozenset(

app/data/model/radio.py

@@ -0,0 +1,9 @@
+from typing import final
+
+from app.data.model import interface
+
+
+@final
+class RadioCatalogObject(interface.CatalogObject):
+    def catalog(self) -> interface.RawCatalog:
+        return interface.RawCatalog.RADIO

postgres/migrations/V050__radio.sql

@@ -0,0 +1,249 @@
+/* pgmigrate-encoding: utf-8 */
+BEGIN;
+
+ALTER TYPE common.quality RENAME VALUE 'ok' TO 'regular' ;
+ALTER TYPE common.quality RENAME VALUE 'lowsnr' TO 'low_snr' ;
+ALTER TYPE common.quality RENAME VALUE 'sus' TO 'suspected' ;
+ALTER TYPE common.quality RENAME VALUE '>' TO 'lower_limit' ;
+ALTER TYPE common.quality RENAME VALUE '<' TO 'upper_limit' ;
+
+ALTER TYPE common.quality RENAME TO quality_type ;
+-- ALTER TYPE common.QualityType SET SCHEMA common ;
+
+COMMENT ON TYPE common.quality_type	IS '{
+"description": "Quality flag of the measurement",
+"values": {
+  "regular": "regular measurement",
+  "low_snr": "low signal-to-noise",
+  "suspected": "suspected measurement",
+  "lower_limit": "lower limit",
+  "upper_limit": "upper limit",
+  "wrong": "wrong measurement"
+  }
+}' ;
+
+CREATE TYPE common.velocity_convention_type AS ENUM ( 'optical', 'radio', 'relativistic' ) ;
+COMMENT ON TYPE common.velocity_convention_type IS '{
+"description": "Velocity convention",
+"values": {
+  "optical": "Voptical=c(λ-λ0)/λ0=cz",
+  "radio": "Vradio=c(ν0-ν)/ν0; cz=Vradio/(1-Vradio/c)",
+  "relativistic": "Relativistic Doppler effect: V=c(ν0^2-ν^2)/(ν0^2+ν^2)=c(λ^2-λ0^2)/(λ^2+λ0^2)=c[(1+z)^2-1]/[(1+z)^2+1]"
+  }
+}' ;
+
+
+----------------------------------------------------
+-------------- Radio Observations schema -----------
+----------------------------------------------------
+CREATE SCHEMA IF NOT EXISTS radio ;
+COMMENT ON SCHEMA radio IS 'Catalog of the radio observations';
+SELECT meta.setparams('radio', '{"description": "Catalog of the radio observations"}');
+
+CREATE TYPE radio.flux_method_type AS ENUM ( 'sum', 'fit' ) ;
+COMMENT ON TYPE radio.flux_method_type	IS '{
+"description": "Method of the flux measurement",
+"values": {
+  "sum":"Integrated radio line flux by summing all velocity channels",
+  "fit":"Integrated radio line flux by model line fitting"
+  }
+}' ;
+
+CREATE TYPE radio.width_method_type AS ENUM ( 'max', 'peak', 'w2p', 'mean', 'int', 'edge', 'model' ) ;
+COMMENT ON TYPE radio.width_method_type	IS '{
+"description": "Method of the line width measurement",
+"values": {
+  "max": "Maximal-value-based width",
+  "peak": "Every peak-based width",
+  "w2p": "Mean of peaks double-horn specific width",
+  "mean": "Mean-flux–based width",
+  "int": "Integrated-flux–based width",
+  "edge": "Edge-based width",
+  "model": "Model-based width"
+  }
+}' ;
+
+CREATE TYPE radio.telescope_type AS ENUM ( 'single-dish', 'interferometer' ) ;
+COMMENT ON TYPE radio.telescope_type	IS '{
+"description": "Radio telescope types",
+"values": {
+  "single-dish": "Single-dish reflector",
+  "interferometer": "Radio interferometer"
+  }
+}' ;
+
+
+
+------------ Radio lines -------------------
+CREATE TABLE radio.lines (
+  id	Text	PRIMARY KEY
+, species	Text	NOT NULL
+, transition	Text	NOT NULL
+, frequency	Real	NOT NULL
+, UNIQUE (species,transition)
+);
+
+COMMENT ON TABLE radio.lines	IS 'List of radio lines' ;
+COMMENT ON COLUMN radio.lines.id	IS 'Line ID' ;
+COMMENT ON COLUMN radio.lines.species	IS 'Designation of atoms and molecules' ;
+COMMENT ON COLUMN radio.lines.transition	IS 'Transition' ;
+COMMENT ON COLUMN radio.lines.frequency	IS '{"description":"Line frequency", "unit":"Hz", "ucd":"em.freq"}' ;
+
+SELECT meta.setparams('radio', 'lines', 'id', '{"description": "Line ID"}');
+SELECT meta.setparams('radio', 'lines', 'species', '{"description": "Designation of atoms and molecules"}');
+SELECT meta.setparams('radio', 'lines', 'transition', '{"description": "Transition"}');
+SELECT meta.setparams('radio', 'lines', 'frequency', '{"description": "Line frequency"}');
+
+INSERT INTO radio.lines (id,species,transition,frequency) VALUES
+  ('HI', 'HI', '21 cm', 1420.4058e6)
+, ('CO(1-0)', 'CO', '(1-0)', 115.271)
+, ('CO(2-1)', 'CO', '(2-1)', 230.538)
+, ('OH 1612 MHz', 'OH', '1612 MHz', 1612.231e6)
+, ('OH 1665 MHz', 'OH', '1665 MHz', 1665.402e6)
+, ('OH 1667 MHz', 'OH', '1667 MHz', 1667.359e6)
+, ('OH 1720 MHz', 'OH', '1720 MHz', 1720.530e6)
+;
+
+------------- Telescopes --------------------
+CREATE TABLE radio.telescopes (
+  id	Text	PRIMARY KEY
+, type	radio.telescope_type	NOT NULL
+, description	Text	NOT NULL
+) ;
+
+COMMENT ON TABLE radio.telescopes	IS 'List of radio lines' ;
+COMMENT ON COLUMN radio.telescopes.id	IS 'Telescope ID' ;
+COMMENT ON COLUMN radio.telescopes.type	IS 'Telescope type' ;
+COMMENT ON COLUMN radio.telescopes.description	IS 'Telescope description' ;
+
+SELECT meta.setparams('radio', 'telescopes', 'id', '{"description": "Telescope ID"}');
+SELECT meta.setparams('radio', 'telescopes', 'type', '{"description": "Telescope type"}');
+SELECT meta.setparams('radio', 'telescopes', 'description', '{"description": "Telescope description"}');
+
+INSERT INTO radio.telescopes (id,type,description) VALUES
+  ('Nancay',     'single-dish', 'Large radio telescope of the Nançay Radio Observatory')
+, ('GB140ft',    'single-dish', 'NRAO Green Bank (43m, 140ft)')
+, ('GB300ft',    'single-dish', 'NRAO Green Bank (91m, 300ft)')
+, ('GBT',        'single-dish', 'Robert C. Byrd Green Bank Telescope (100m)')
+, ('Effelsberg', 'single-dish', 'Effelsberg Radio Telescope (100m)')
+, ('Arecibo',    'single-dish', 'Arecibo Telescope (305m, 1000ft)')
+, ('Parkes',     'single-dish', 'Murriyang, Parkes 64m Radio Telescope')
+, ('FAST',       'single-dish', 'Five-hundred-meter Aperture Spherical Telescope')
+, ('WSRT',    'interferometer', 'Westerbork Synthesis Radio Telescope')
+, ('ATCA',    'interferometer', 'Australia Telescope Compact Array')
+, ('GMRT',    'interferometer', 'Giant Metrewave Radio Telescope')
+, ('VLA',     'interferometer', 'Karl G. Jansky Very Large Array')
+, ('VLA A',   'interferometer', 'A-configuration of the Karl G. Jansky Very Large Array')
+, ('VLA B',   'interferometer', 'B-configuration of the Karl G. Jansky Very Large Array')
+, ('VLA C',   'interferometer', 'C-configuration of the Karl G. Jansky Very Large Array')
+, ('VLA D',   'interferometer', 'A-configuration of the Karl G. Jansky Very Large Array')
+;
+
+
+------------- Data sets ---------------------
+CREATE TABLE radio.datasets (
+  id	Integer	PRIMARY KEY
+, table_id	Integer	NOT NULL	REFERENCES layer0.tables (id) ON DELETE restrict ON UPDATE cascade
+, telescope_id	Text	NOT NULL	REFERENCES radio.telescopes (id) ON DELETE restrict ON UPDATE cascade
+, line_id	Text	NOT NULL	DEFAULT 'HI'
+, resolution	real	NOT NULL
+, velocity_convention	common.velocity_convention_type	NOT NULL	DEFAULT 'optical'
+, flux_correction	boolean	NOT NULL	DEFAULT false
+, resolution_correction	boolean	NOT NULL	DEFAULT false
+, redshift_correction	boolean	NOT NULL	DEFAULT false
+) ;
+
+COMMENT ON TABLE radio.datasets	IS 'Dataset description' ;
+COMMENT ON COLUMN radio.datasets.id	IS 'Dataset ID' ;
+COMMENT ON COLUMN radio.datasets.table_id	IS 'Original data table ID' ;
+COMMENT ON COLUMN radio.datasets.telescope_id	IS 'Telescope ID' ;
+COMMENT ON COLUMN radio.datasets.line_id	IS 'Spectral line ID' ;
+COMMENT ON COLUMN radio.datasets.resolution	IS '{"description":"Effective spectral resolution", "unit":"km/s", "ucd":"spect.resolution"}' ;
+COMMENT ON COLUMN radio.datasets.flux_correction	IS 'Indication if the flux was corrected for the beam filling factor' ;
+COMMENT ON COLUMN radio.datasets.resolution_correction	IS 'Indication if the line width was corrected for the spectral resolution' ;
+COMMENT ON COLUMN radio.datasets.redshift_correction	IS 'Indication if the line width was corrected for the cosmological broadening' ;
+
+SELECT meta.setparams('radio', 'datasets', 'id', '{"description": "Dataset ID"}');
+SELECT meta.setparams('radio', 'datasets', 'table_id', '{"description": "Original data table ID"}');
+SELECT meta.setparams('radio', 'datasets', 'telescope_id', '{"description": "Telescope ID"}');
+SELECT meta.setparams('radio', 'datasets', 'line_id', '{"description": "Spectral line ID"}');
+SELECT meta.setparams('radio', 'datasets', 'resolution', '{"description": "Effective spectral resolution"}');
+SELECT meta.setparams('radio', 'datasets', 'velocity_convention', '{"description": "Common velocity convention type"}');
+SELECT meta.setparams('radio', 'datasets', 'flux_correction', '{"description": "Indication if the flux was corrected for the beam filling factor"}');
+SELECT meta.setparams('radio', 'datasets', 'resolution_correction', '{"description": "Indication if the line width was corrected for the spectral resolution"}');
+SELECT meta.setparams('radio', 'datasets', 'redshift_correction', '{"description": "Indication if the line width was corrected for the cosmological broadening"}');
+
+
+------------- Line flux ---------------------
+CREATE TABLE radio.line_flux (
+  record_id	Text	NOT NULL	REFERENCES layer0.records(id) ON UPDATE cascade ON DELETE restrict
+, flux	real	NOT NULL
+, e_flux	real
+, quality	common.quality_type	NOT NULL	DEFAULT 'regular'
+, method	radio.flux_method_type	NOT NULL	DEFAULT 'sum'
+, PRIMARY KEY (record_id, method)
+);
+CREATE INDEX ON radio.line_flux (record_id) ;
+CREATE INDEX ON radio.line_flux (method) ;
+
+COMMENT ON TABLE radio.line_flux	IS 'Catalog of the radio line fluxes' ;
+COMMENT ON COLUMN radio.line_flux.record_id	IS 'Record ID' ;
+COMMENT ON COLUMN radio.line_flux.flux	IS '{"description":"Integrated radio line flux", "unit":"Jy.km/s", "ucd":"phot.flux.density;spect.line"}' ;
+COMMENT ON COLUMN radio.line_flux.e_flux	IS '{"description":"Error of the integrated radio line flux", "unit":"Jy.km/s", "ucd":"stat.error"}' ;
+COMMENT ON COLUMN radio.line_flux.method	IS 'Measurement type (sum, fit)' ;
+
+SELECT meta.setparams('radio', 'line_flux', 'record_id', '{"description": "Record ID"}');
+SELECT meta.setparams('radio', 'line_flux', 'flux', '{"description": "Integrated radio line flux"}');
+SELECT meta.setparams('radio', 'line_flux', 'e_flux', '{"description": "Error of the integrated radio line flux"}');
+SELECT meta.setparams('radio', 'line_flux', 'quality', '{"description": "Common quality type"}');
+SELECT meta.setparams('radio', 'line_flux', 'method', '{"description": "Measurement type (sum, fit)"}');
+
+
+
+------------- Line flux ---------------------
+-- CREATE TABLE radio.continuum_flux (
+--   record_id	Text	NOT NULL	REFERENCES layer0.records(id) ON UPDATE cascade ON DELETE restrict
+-- , flux	real	NOT NULL
+-- , e_flux	real
+-- , quality	common.QualityType	NOT NULL	DEFAULT 'regular'
+-- , frequency	real	NOT NULL
+-- , bandwidth	real	NOT NULL
+-- , PRIMARY KEY (record_id, frequency)
+-- );
+-- CREATE INDEX ON radio.data (record_id) ;
+-- CREATE INDEX ON radio.data (method) ;
+--
+-- COMMENT ON TABLE radio.continuum_flux	IS 'Catalog of the radio continuum fluxes' ;
+-- COMMENT ON COLUMN radio.continuum_flux.record_id	IS 'Record ID' ;
+-- COMMENT ON COLUMN radio.continuum_flux.flux	IS '{"description":"Flux density", "unit":"Jy", "ucd":"phot.flux.density;spect.line"}' ;
+-- COMMENT ON COLUMN radio.continuum_flux.e_flux	IS '{"description":"Error of the flux density", "unit":"Jy", "ucd":"stat.error"}' ;
+-- COMMENT ON COLUMN radio.continuum_flux.frequency	IS '{"description":"Frequency", "unit":"Hz", "ucd":"em.freq"}' ;
+-- COMMENT ON COLUMN radio.continuum_flux.frequency	IS '{"description":"Bandwidth", "unit":"Hz", "ucd":"em.freq"}' ;
+
+
+------------- Line Width ---------------------
+CREATE TABLE radio.line_width (
+  record_id	Text	NOT NULL	REFERENCES layer0.records(id) ON UPDATE cascade ON DELETE restrict
+, width	real	NOT NULL
+, e_width	real
+, method	radio.width_method_type	NOT NULL	DEFAULT 'peak'
+, level	real	NOT NULL	DEFAULT 50
+, PRIMARY KEY (record_id, method, level)
+);
+CREATE INDEX ON radio.line_width (record_id) ;
+CREATE INDEX ON radio.line_width (method) ;
+
+COMMENT ON TABLE radio.line_width	IS 'Catalog of the HI line width' ;
+COMMENT ON COLUMN radio.line_width.record_id	IS 'Record ID' ;
+COMMENT ON COLUMN radio.line_width.width	IS '{"description":"Radio line width", "unit":"km/s", "ucd":"spect.line.width"}' ;
+COMMENT ON COLUMN radio.line_width.e_width	IS '{"description":"Error of the radio line width", "unit":"km/s", "ucd":"stat.error"}' ;
+COMMENT ON COLUMN radio.line_width.method	IS 'Measurement type' ;
+COMMENT ON COLUMN radio.line_width.level	IS 'Measurement level in percent' ;
+
+SELECT meta.setparams('radio', 'line_width', 'record_id', '{"description": "Record ID"}');
+SELECT meta.setparams('radio', 'line_width', 'width', '{"description": "Radio line width"}');
+SELECT meta.setparams('radio', 'line_width', 'e_width', '{"description": "Error of the radio line width"}');
+SELECT meta.setparams('radio', 'line_width', 'method', '{"description": "Measurement type"}');
+SELECT meta.setparams('radio', 'line_width', 'level', '{"description": "Measurement level in percent"}');
+
+COMMIT;