PyDIET 0.9.3__py3-none-any.whl

pydiet/server/models/__init__.py

@@ -0,0 +1,34 @@
+"""
+Data models
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+
+from .dataconfig import (
+    DataConfigModel,
+    DetectorConfigModel,
+    EmissionConfigModel,
+    FileConfigModel,
+    FiltersConfigModel,
+    InstrumentConfigModel,
+    OpticsConfigModel,
+    SiteConfigModel,
+    TelescopeConfigModel,
+    TransmissionConfigModel
+)
+from .exceptions import ETCValidationError
+from .query import ETCQueryModel
+from .response import ETCResponseModel
+from .instrument import (
+    DetectorModel,
+    FiltersModel,
+    InstrumentModel,
+    OpticsModel,
+    SBSEDModel,
+    SEDModel,
+    SiteModel,
+    TelescopeModel,
+    TransmissionModel,
+    spectral_to_arrays
+)
+

pydiet/server/models/dataconfig.py

@@ -0,0 +1,195 @@
+"""
+Data models
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+
+from astropy import units as u  #type: ignore[import-untyped]
+from pydantic import BaseModel, DirectoryPath
+
+from ..types import AnnotatedQuantity
+
+
+class FileConfigModel(BaseModel):
+    '''
+    Pydantic model for transmission curve configuration.
+    '''
+    default: bool = False
+    id: str = ''
+    name: str = ""
+    description: str = ""
+    vars: dict[str, float|str] = {}
+    file: str
+
+
+
+class EmissionConfigModel(BaseModel):
+    '''
+    Pydantic model for emission curve set configuration.
+    '''
+    path: str = ""
+    temperatures: list[AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "K",
+        gt = 0. * u.K,
+        decimals = 2,
+        description  = "Device temperature."
+    )] = [283 * u.K]
+    areas: list[AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m2",
+        ge = 0. * u.m**2,
+        decimals = 3,
+        description = "Emissive area."
+    )] = [0. * u.m**2]
+    files: list[FileConfigModel] = []
+
+
+
+class TransmissionConfigModel(BaseModel):
+    '''
+    Pydantic model for transmission curve set configuration.
+    '''
+    path: str = ""
+    files: list[FileConfigModel] = []
+
+
+
+class SiteConfigModel(BaseModel):
+    '''
+    Pydantic model for the observing site data configuration model.
+    '''
+    default: bool = False
+    id: str
+    name: str
+    description: str
+    path: str
+    altitude:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m",
+        ge = -1000. * u.m,
+        decimals = 3,
+        description = "Altitude of the observation site."
+    )
+    transmission: TransmissionConfigModel
+    emission: EmissionConfigModel
+
+
+
+class TelescopeConfigModel(BaseModel):
+    '''
+    Pydantic model for the telescope data configuration model.
+    '''
+    default: bool = False
+    id: str
+    name: str
+    description: str
+    path: str
+    collecting_area:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m2",
+        gt = 0. * u.m**2,
+        decimals = 3,
+        description = "Full collecting area, including possible mirror hole and spider branches."
+    )
+    obstruction_area:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m2",
+        gt = 0. * u.m**2,
+        decimals = 3,
+        description = "Default obstruction area (only used if not specified for the instrument)."
+    )
+    transmission: TransmissionConfigModel
+    emission: EmissionConfigModel
+
+
+
+class DetectorConfigModel(BaseModel):
+    '''
+    Pydantic model for the detector data configuration model.
+    '''
+    path: str
+    gain:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "electron/adu",
+        gt = 0. * u.electron / u.adu,
+        decimals = 3,
+        description = "Average gain (conversion factor) in electrons per ADU."
+    )
+    ron:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "electron",
+        ge = 0. * u.electron,
+        decimals = 3,
+        description = "Total readout noise in electrons."
+    )
+    scale: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "arcsec/pix",
+        gt = [0., 0.] * u.arcsec / u.pix,
+        min_shape = (2),
+        max_shape = (2),
+        decimals = 4,
+        description = "Angular pixel scale along each axis."
+    )
+    transmission: TransmissionConfigModel
+    emission: EmissionConfigModel
+
+
+
+class OpticsConfigModel(BaseModel):
+    '''
+    Pydantic model for the intrument optics data configuration model.
+    '''
+    path: str
+    transmission: TransmissionConfigModel
+    emission: EmissionConfigModel
+
+
+
+class FiltersConfigModel(OpticsConfigModel):
+    '''
+    Pydantic model for the intrument filters data configuration model.
+    '''
+    pass
+
+
+
+class InstrumentConfigModel(BaseModel):
+    '''
+    Pydantic model for the instrument data configuration model.
+    '''
+    default: bool = False
+    id: str
+    name: str
+    description: str
+    path: str
+    wavelength_range: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        gt = [0., 0.] *u. nm,
+        min_shape = (2),
+        max_shape = (2),
+        decimals = 4,
+        description = "Instrument minimum and maximum wavelengths."
+    )
+    obstruction_area:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m2",
+        gt = 0. * u.m**2,
+        decimals = 3,
+        description = "Obstruction area for this particular instrument."
+    )
+    overhead:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "s",
+        ge = 0. * u.second,
+        decimals = 3,
+        description = "Total instrument time overhead between exposures."
+    )
+    site_id: str
+    telescope_id: str
+    optics: OpticsConfigModel
+    filters: FiltersConfigModel
+    detector: DetectorConfigModel
+
+
+
+class DataConfigModel(BaseModel):
+    '''
+    Pydantic model for the data configuration
+    '''
+    path: DirectoryPath
+    sites: list['SiteConfigModel']
+    telescopes: list['TelescopeConfigModel']
+    instruments: list['InstrumentConfigModel']
+

pydiet/server/models/default.py

@@ -0,0 +1,9 @@
+"""
+Default entries for models
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+
+# We actually gather default entities from the data module
+from ..data import default_filter, default_instrument, filters, instruments
+

pydiet/server/models/exceptions.py

@@ -0,0 +1,9 @@
+"""
+Exceptions for model validation.
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+
+class ETCValidationError(Exception):
+    pass
+

pydiet/server/models/instrument.py

@@ -0,0 +1,314 @@
+"""
+Data models
+"""
+# Copyright CFHT/CNRS/CEA/UParisSaclay
+# Licensed under the MIT licence
+
+from typing import Annotated, Optional, Tuple
+
+from astropy import units as u  #type: ignore[import-untyped]
+import numpy as np
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+from synphot import (  #type: ignore[import-untyped]
+    BlackBody1D,
+    ConstFlux1D,
+    Observation,
+    SourceSpectrum,
+    SpectralElement
+)
+from synphot.spectrum import BaseSpectrum  #type: ignore[import-untyped]
+
+from ... import package
+from ..types import AnnotatedQuantity
+
+
+def spectral_to_arrays(spectral: BaseSpectrum) -> Tuple[np.ndarray, np.ndarray]:
+    w = spectral.waveset
+    x = spectral(w)
+
+    # Trim extra 0 values at beginning and at the end
+    idx = np.where(x.value != 0.)[0]
+    if len(idx):
+        start = idx[0] - 1 if idx[0] > 0 else 0
+        end = idx[-1] + 2 if idx[-1] < w.size - 1 else w.size
+        w = w[start:end]
+        x = x[start:end]
+
+    return w, x
+
+
+
+class DetectorModel(BaseModel):
+    '''
+    Pydantic model for an instrument detector (e.g., CMOS or CCD).
+    '''
+    gain: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "electron / adu",
+        gt = 0. * u.electron / u.adu,
+        decimals = 4,
+        description = "Detector conversion factor."
+    )
+    ron: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "electron",
+        ge = 0. * u.electron,
+        decimals = 4,
+        description = "Read-out noise RMS amplitude."
+    )
+    scale: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "arcsec/pix",
+        gt = [0., 0.] * u.arcsec / u.pix,
+        min_shape = (2),
+        max_shape = (2),
+        decimals = 4,
+        description = "Angular pixel scale along each axis."
+    )
+    transmissions: dict[str, 'TransmissionModel']
+    emissions: dict[str, 'SBSEDModel']
+
+
+
+class InstrumentModel(BaseModel):
+    '''
+    Pydantic model for a PyDIET instrument.
+    '''
+    id: str
+    name: str
+    description: str
+    wavelength_range: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        gt = [0., 0.] * u.nm,
+        min_shape = (2),
+        max_shape = (2),
+        decimals = 4,
+        description = "Instrument minimum and maximum wavelengths."
+    )
+    obstruction_area:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m2",
+        gt = 0. * u.m**2,
+        decimals = 3,
+        description = "Default obstruction area (only used if not specified for the instrument)."
+    )
+    overhead:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "s",
+        ge = 0. * u.second,
+        decimals = 3,
+        description = "Total instrument time overhead between exposures."
+    )
+    filters: 'FiltersModel'
+    optics: 'OpticsModel'
+    detector: 'DetectorModel'
+    telescope: 'TelescopeModel'
+    site: 'SiteModel'
+    default: bool = False
+
+    transmissions: Optional[dict] = Field(default=None)  #type: ignore[annotation-unchecked]
+    emissions_ct: Optional[dict] = Field(default=None)  #type: ignore[annotation-unchecked]
+
+    @model_validator(mode="after")
+    def _update_transmissions(self):
+        # Compute extra parameters during initialization
+        area = self.telescope.collecting_area - self.obstruction_area
+        # Filter emissions and transmissions
+        upstream_transmission = 1.
+        upstream_emission = SourceSpectrum(ConstFlux1D, amplitude=0.)
+        # Pre-filter list of transmissions
+        transmissions = [
+            *self.telescope.transmissions.values(),
+            *self.optics.transmissions.values()
+        ]
+        emissions = [
+            *self.telescope.emissions.values(),
+            *self.optics.emissions.values()
+        ]
+        for i, v in enumerate(transmissions):
+            emission = emissions[i].spectral
+            transmission = transmissions[i].spectral
+            upstream_transmission *= transmission
+            upstream_emission = upstream_emission * transmission + emission
+        self.transmissions : dict[str, TransmissionModel] = {}  #type: ignore[annotation-unchecked]
+        self.emissions_ct : dict[str, u.Quantity[u.ct/u.s]] = {}  #type: ignore[annotation-unchecked]
+        filter_transmissions = self.filters.transmissions
+        filter_emissions = self.filters.emissions
+        for f in filter_transmissions:
+            filter = filter_transmissions[f]
+            filter_transmission = filter.spectral
+            filter_emission = filter_emissions[f].spectral
+            transmission = upstream_transmission * filter_transmission
+            emission = upstream_emission * transmission + filter_emission
+            transmission *= self.detector.transmissions["0"].spectral
+            emission *= self.detector.transmissions["0"].spectral
+            wave, response = spectral_to_arrays(transmission)
+            self.transmissions[f] = TransmissionModel(
+                id = filter.id,
+                name = filter.name,
+                description = filter.description,
+                vars = filter.vars,
+                wave = wave,
+                response = response,
+                spectral = transmission
+            )
+            # Compute countrate
+            if transmission.tpeak() > 0.:
+                observation = Observation(emission, transmission, force='taper')
+                self.emissions_ct[f] = observation.countrate(area=area).value
+            else:
+                self.emissions_ct[f] = 0.
+        return self
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+
+
+class OpticsModel(BaseModel):
+    '''
+    Pydantic model for optics.
+    '''
+    transmissions: dict[str, 'TransmissionModel']
+    emissions: dict[str, 'SBSEDModel']
+
+
+
+class FiltersModel(OpticsModel):
+    '''
+    Pydantic model for a filter set.
+    '''
+    pass
+
+
+
+class SBSEDModel(BaseModel):
+    '''
+    Pydantic model for a Surface Brightness Spectral Energy Distribution (SBSED).
+    '''
+    id: str
+    name: str
+    description: str
+    vars: dict[str, float|str] = {}
+    wave: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        ge = 100. * u.nm,
+        le = 100. * u.micron,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 4
+    ) | None = None
+    sbsed:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "Jy / arcsec2",
+        ge = 0. * u.Jy / u.arcsec**2,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 6
+    ) | None = None
+    spectral: SourceSpectrum = Field(exclude=True)
+    default: bool = False
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+
+
+class SEDModel(BaseModel):
+    '''
+    Pydantic model for a Spectral Energy Distribution (SED).
+    '''
+    id: str
+    name: str
+    description: str
+    vars: dict[str, float] = {}
+    wave: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        ge = 100. * u.nm,
+        le = 100. * u.micron,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 4
+    ) | None = None
+    sed:  AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "Jy",
+        ge = 0. * u.Jy,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 6
+    ) | None = None
+    spectral: SourceSpectrum = Field(exclude=True)
+    default: bool = False
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+
+
+class SiteModel(BaseModel):
+    '''
+    Pydantic model for an observing site.
+    '''
+    id: str
+    name: str
+    description: str
+    sky_transmissions: dict[str, 'TransmissionModel']
+    sky_emissions: dict[str, 'SBSEDModel']
+    default: bool = False
+
+
+
+class TelescopeModel(BaseModel):
+    '''
+    Pydantic model for a telescope.
+    '''
+    id: str
+    name: str
+    description: str
+    collecting_area: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m**2",
+        gt = 0. * u.m**2,
+        decimals = 4,
+        description = "Full collecting area, ignoring obstructions."
+    )
+    obstruction_area: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "m**2",
+        gt = 0. * u.m**2,
+        decimals = 4,
+        description = "Minimum obstruction area."
+    )
+    transmissions: dict[str, 'TransmissionModel']
+    emissions: dict[str, 'SBSEDModel']
+    default: bool = False
+
+
+
+class TransmissionModel(BaseModel):
+    '''
+    Pydantic model for a transmission curve (with wavelength).
+    '''
+    id: str
+    name: str
+    description: str = ""
+    vars: Optional[dict[str, float | str]] = None
+    wave_range: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        gt = [0., 0.] * u.nm,
+        min_shape = (2),
+        max_shape = (2),
+        decimals = 4,
+        description = "Instrument minimum and maximum wavelengths."
+    ) | None = None
+    wave: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "nm",
+        ge = 100. * u.nm,
+        le = 100. * u.micron,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 3
+    ) | None = None
+    response: AnnotatedQuantity(    #type: ignore[valid-type]
+        unit = "",
+        ge = -100.,
+        le = 100.,
+        min_shape = (2),
+        max_shape = (100000),
+        decimals = 4
+    ) | None = None
+    spectral: Optional[SpectralElement] = Field(default=None, exclude=True)
+    default: bool = False
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+