Ground System Models
Point
- pydantic model tatc.schemas.Point[source]
Surface point in the WGS 84 coordinate system.
Show JSON schema
{ "title": "Point", "description": "Surface point in the WGS 84 coordinate system.", "type": "object", "properties": { "id": { "default": 0, "description": "Point identifier. Not used by the analysis methods, which identify points by the hash of their geometry (see `tatc.utils.hash_geometry`).", "minimum": 0, "title": "Id", "type": "integer" }, "latitude": { "description": "Latitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ 40.74259 ], "maximum": 90, "minimum": -90, "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ -74.02686 ], "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" }, "elevation": { "default": 0, "description": "Elevation (meters) above datum in the WGS 84 coordinate system.", "title": "Elevation", "type": "number" } }, "required": [ "latitude", "longitude" ] }
- Fields:
elevation (float)id (int)latitude (float)longitude (float)
- field id: Annotated[int, Ge(ge=0)] = 0
Point identifier. Not used by the analysis methods, which identify points by the hash of their geometry (see tatc.utils.hash_geometry).
- Constraints:
ge = 0
Ground Station
- pydantic model tatc.schemas.GroundStation[source]
Ground station in the WGS 84 coordinate system.
Show JSON schema
{ "title": "GroundStation", "description": "Ground station in the WGS 84 coordinate system.", "type": "object", "properties": { "id": { "default": 0, "description": "Point identifier. Not used by the analysis methods, which identify points by the hash of their geometry (see `tatc.utils.hash_geometry`).", "minimum": 0, "title": "Id", "type": "integer" }, "latitude": { "description": "Latitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ 40.74259 ], "maximum": 90, "minimum": -90, "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ -74.02686 ], "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" }, "elevation": { "default": 0, "description": "Elevation (meters) above datum in the WGS 84 coordinate system.", "title": "Elevation", "type": "number" }, "name": { "description": "Ground station name", "examples": [ "station 1" ], "title": "Name", "type": "string" }, "min_elevation_angle": { "default": 0, "description": "The minimum elevation angle (decimal degrees) required for satellite communication.", "maximum": 90, "minimum": 0, "title": "Min Elevation Angle", "type": "number" }, "min_access_time": { "default": "PT0S", "description": "Minimum access (integration) time required for satellite communication.", "examples": [ "PT10S" ], "format": "duration", "title": "Min Access Time", "type": "string" } }, "required": [ "latitude", "longitude", "name" ] }
- Fields:
min_access_time (datetime.timedelta)min_elevation_angle (float)name (str)
- field min_access_time: timedelta = datetime.timedelta(0)
Minimum access (integration) time required for satellite communication.
Radar Station
- pydantic model tatc.schemas.RadarStation[source]
Ground-based radar station (e.g. a NOAA NEXRAD WSR-88D weather radar) in the WGS 84 coordinate system.
Absent a terrain_mask, the coverage footprint computed by this schema assumes an idealized, azimuthally symmetric sensor with clear line of sight in every direction. Supplying a terrain_mask (e.g. derived from a digital elevation model) relaxes that assumption by raising the effective minimum elevation angle in blocked directions. Coverage extends half the beam_width beyond the lowest and highest scanned beam centers, treating the elevation angles in between as continuously sampled (gaps between widely spaced tilts are not represented). In all cases, this schema uses the standard-atmosphere “4/3 Earth radius” refraction approximation, which does not capture anomalous propagation (ducting/sub-refraction) under non-standard weather conditions, and reports a 2-D ground-range profile bounding where a target at a given height is observable, not a full 3-D reconstruction of the scanned volume.
Show JSON schema
{ "title": "RadarStation", "description": "Ground-based radar station (e.g. a NOAA NEXRAD WSR-88D weather radar)\nin the WGS 84 coordinate system.\n\nAbsent a `terrain_mask`, the coverage footprint computed by this\nschema assumes an idealized, azimuthally symmetric sensor with clear\nline of sight in every direction. Supplying a `terrain_mask` (e.g.\nderived from a digital elevation model) relaxes that assumption by\nraising the effective minimum elevation angle in blocked directions.\nCoverage extends half the `beam_width` beyond the lowest and highest\nscanned beam centers, treating the elevation angles in between as\ncontinuously sampled (gaps between widely spaced tilts are not\nrepresented). In all cases, this schema uses the standard-atmosphere \"4/3 Earth\nradius\" refraction approximation, which does not capture anomalous\npropagation (ducting/sub-refraction) under non-standard weather\nconditions, and reports a 2-D ground-range profile bounding where a\ntarget at a given height is observable, not a full 3-D reconstruction\nof the scanned volume.", "type": "object", "properties": { "id": { "default": 0, "description": "Point identifier. Not used by the analysis methods, which identify points by the hash of their geometry (see `tatc.utils.hash_geometry`).", "minimum": 0, "title": "Id", "type": "integer" }, "latitude": { "description": "Latitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ 40.74259 ], "maximum": 90, "minimum": -90, "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ -74.02686 ], "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" }, "elevation": { "default": 0, "description": "Elevation (meters) of the radar antenna, including tower height. Coverage depends only on target elevations relative to this value, so it must use the same vertical reference as target elevations and any terrain mask: heights above mean sea level (as in NOAA's NEXRAD station tables and digital elevation models such as Copernicus DEM GLO-30) are recommended, noting that they differ from heights above the WGS 84 ellipsoid by the local geoid undulation.", "title": "Elevation", "type": "number" }, "name": { "description": "Radar station name", "examples": [ "KOUN" ], "title": "Name", "type": "string" }, "max_range": { "default": 460000, "description": "Maximum unambiguous slant range (meters) for radar detection, limited by the pulse repetition frequency (PRF) and receiver hardware. Defaults to 460,000 m (460 km), the range of NEXRAD WSR-88D Level II reflectivity on its lowest (surveillance) tilts; the conventional base reflectivity product is displayed to 230,000 m.", "examples": [ 460000 ], "exclusiveMinimum": 0, "title": "Max Range", "type": "number" }, "min_elevation_angle": { "default": 0.5, "description": "Nominal (hardware/operational) lowest scanned elevation angle (decimal degrees) above local horizontal. Defaults to 0.5 degrees, the lowest elevation cut in most NEXRAD volume coverage patterns. The effective minimum elevation angle at a given azimuth is never below this value, but may be raised locally by `terrain_mask`. Negative values represent scanning below local horizontal, as at some elevated sites (e.g. NEXRAD KFSX scans at about -0.2 degrees); intersection of such a beam with the terrain is represented only through `terrain_mask`.", "maximum": 90, "minimum": -90, "title": "Min Elevation Angle", "type": "number" }, "max_elevation_angle": { "default": 19.5, "description": "Highest scanned elevation angle (decimal degrees) above local horizontal. Defaults to 19.5 degrees, a common highest elevation cut in NEXRAD volume coverage patterns.", "maximum": 90, "minimum": 0, "title": "Max Elevation Angle", "type": "number" }, "terrain_mask": { "anyOf": [ { "$ref": "#/$defs/TerrainMask" }, { "type": "null" } ], "default": null, "description": "Optional azimuthal terrain blockage mask (e.g. derived from a digital elevation model), raising the effective minimum elevation angle in specific directions. When omitted, coverage is assumed azimuthally symmetric. A raised scan angle shortens the outer range at which a target above the station is observable, and removes coverage of a target below the station wherever it lifts the lowest usable angle to or above local horizontal." }, "beam_width": { "default": 0.95, "description": "Half-power (-3 dB) beam width (decimal degrees). Defaults to 0.95 degrees, the NEXRAD WSR-88D beam width. Half of this width extends the observed elevation angles below the lowest scanned beam center (`min_elevation_angle`) and above the highest (`max_elevation_angle`); set to 0 to bound coverage by the beam centers alone.", "maximum": 180, "minimum": 0, "title": "Beam Width", "type": "number" }, "band": { "anyOf": [ { "$ref": "#/$defs/RadarBand" }, { "type": "null" } ], "default": null, "description": "Optional informational tag for this station's nominal operating frequency band (S, C, or X). It does not affect any coverage computation directly -- set `max_range` (and other fields) explicitly to represent a band's practical effect; see `from_band` for illustrative nominal defaults." } }, "$defs": { "RadarBand": { "description": "Common weather radar frequency bands. This is an informational tag\nonly: TAT-C does not model transient, weather-dependent propagation\neffects (e.g. rain attenuation), which is the dominant practical\ndifference between bands in reality -- a heavy storm can attenuate an\nX-band signal to the point of near-total extinction a short distance\nbehind it, a C-band signal moderately, and an S-band signal barely at\nall. The static effect this schema does represent is a shorter\ntypical maximum range at shorter wavelengths, reflecting that overall\nattenuation/sensitivity tradeoff in clear-to-moderate conditions; see\n`RadarStation.from_band`.", "enum": [ "S", "C", "X" ], "title": "RadarBand", "type": "string" }, "TerrainMask": { "description": "Azimuthal terrain blockage mask for a fixed surface object (a\n`RadarStation` or a `SurfacePlatform`): the minimum usable elevation\nangle at each azimuth, due to terrain blocking the line of sight at low\ngrazing angles. Typically derived by ray-tracing a digital elevation\nmodel (DEM) outward from the antenna or instruments to find the highest\nterrain obstruction angle along each azimuthal direction (see\n`tatc.preprocess.compute_terrain_mask`).\n\nThis represents one blocking angle per azimuth (the common case for a\nDEM-derived terrain horizon, where the nearest/highest ridge along a\nray dominates): any elevation angle at or above the masked value is\nassumed clear, and any below it is blocked. It does not model\nmultiple, separately-blocked elevation bands along the same azimuth\n(e.g. a nearby building blocking only a narrow low-elevation slice\nwhile a distant mountain blocks a separate, higher slice).", "properties": { "azimuth": { "description": "Azimuth samples (decimal degrees, clockwise from north, in [0, 360)), strictly increasing, at which the minimum elevation angle is specified. Values are linearly interpolated between samples, wrapping around 0/360 degrees.", "items": { "type": "number" }, "minItems": 2, "title": "Azimuth", "type": "array" }, "min_elevation_angle": { "description": "Minimum usable elevation angle (decimal degrees), due to terrain blockage, at each corresponding azimuth.", "items": { "type": "number" }, "minItems": 2, "title": "Min Elevation Angle", "type": "array" } }, "required": [ "azimuth", "min_elevation_angle" ], "title": "TerrainMask", "type": "object" } }, "required": [ "latitude", "longitude", "name" ] }
- Fields:
band (RadarBand | None)beam_width (float)elevation (float)max_elevation_angle (float)max_range (float)min_elevation_angle (float)name (str)terrain_mask (TerrainMask | None)
- Validators:
max_elevation_angle_ge_min_elevation_angle»all fields
- field band: RadarBand | None = None
Optional informational tag for this station’s nominal operating frequency band (S, C, or X). It does not affect any coverage computation directly – set max_range (and other fields) explicitly to represent a band’s practical effect; see from_band for illustrative nominal defaults.
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field beam_width: float = 0.95
Half-power (-3 dB) beam width (decimal degrees). Defaults to 0.95 degrees, the NEXRAD WSR-88D beam width. Half of this width extends the observed elevation angles below the lowest scanned beam center (min_elevation_angle) and above the highest (max_elevation_angle); set to 0 to bound coverage by the beam centers alone.
- Constraints:
ge = 0
le = 180
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field elevation: float = 0
Elevation (meters) of the radar antenna, including tower height. Coverage depends only on target elevations relative to this value, so it must use the same vertical reference as target elevations and any terrain mask: heights above mean sea level (as in NOAA’s NEXRAD station tables and digital elevation models such as Copernicus DEM GLO-30) are recommended, noting that they differ from heights above the WGS 84 ellipsoid by the local geoid undulation.
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field max_elevation_angle: float = 19.5
Highest scanned elevation angle (decimal degrees) above local horizontal. Defaults to 19.5 degrees, a common highest elevation cut in NEXRAD volume coverage patterns.
- Constraints:
ge = 0
le = 90
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field max_range: float = 460000
Maximum unambiguous slant range (meters) for radar detection, limited by the pulse repetition frequency (PRF) and receiver hardware. Defaults to 460,000 m (460 km), the range of NEXRAD WSR-88D Level II reflectivity on its lowest (surveillance) tilts; the conventional base reflectivity product is displayed to 230,000 m.
- Constraints:
gt = 0
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field min_elevation_angle: float = 0.5
Nominal (hardware/operational) lowest scanned elevation angle (decimal degrees) above local horizontal. Defaults to 0.5 degrees, the lowest elevation cut in most NEXRAD volume coverage patterns. The effective minimum elevation angle at a given azimuth is never below this value, but may be raised locally by terrain_mask. Negative values represent scanning below local horizontal, as at some elevated sites (e.g. NEXRAD KFSX scans at about -0.2 degrees); intersection of such a beam with the terrain is represented only through terrain_mask.
- Constraints:
ge = -90
le = 90
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field name: str [Required]
Radar station name
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- field terrain_mask: TerrainMask | None = None
Optional azimuthal terrain blockage mask (e.g. derived from a digital elevation model), raising the effective minimum elevation angle in specific directions. When omitted, coverage is assumed azimuthally symmetric. A raised scan angle shortens the outer range at which a target above the station is observable, and removes coverage of a target below the station wherever it lifts the lowest usable angle to or above local horizontal.
- Validated by:
max_elevation_angle_ge_min_elevation_angle
- compute_footprint(elevation: float, number_points: int | None = None) Polygon | MultiPolygon[source]
Computes this station’s static ground coverage footprint (a disk, or an annulus if an overhead “cone of silence” applies or, for a target below the station, the lowest beam only descends to the target some distance out) at a specified target elevation. When terrain_mask is set, the footprint is azimuthally irregular, reflecting blocked directions.
- Parameters:
elevation (float) – The elevation (meters) of the observed target, in the same vertical reference as this station’s elevation.
number_points (int | None) – The number of azimuth samples used when this station has a terrain_mask (ignored otherwise, since the symmetric case uses a faster closed-form circle/ annulus). Defaults to the runtime configuration.
- Returns:
The radar coverage footprint, or an empty Polygon if the target is not observable at any ground range.
- Return type:
shapely.geometry.Polygon | shapely.geometry.MultiPolygon
- compute_ground_range_profile(elevation: float, number_points: int | None = None) list[tuple[float, float, float]][source]
Computes the ground-range annulus bounds at a sampled set of azimuths, accounting for this station’s terrain_mask (if any).
- Parameters:
- Returns:
A list of (azimuth, inner_ground_range, outer_ground_range) tuples; a fully blocked azimuth reports (azimuth, 0, 0).
- Return type:
- compute_ground_ranges(elevation: float) tuple[float, float] | None[source]
Computes the idealized, azimuthally symmetric ground-range annulus (meters) within which this station can detect a target at a specified elevation, between the lower half-power edge of the lowest scanned beam and the upper edge of the highest (this does not account for terrain_mask; see compute_ground_range_profile for the azimuth-resolved bounds).
- Parameters:
elevation (float) – The elevation (meters) of the observed target, in the same vertical reference as this station’s elevation.
- Returns:
The (inner_ground_range, outer_ground_range) bounds (meters), or None if the target is not observable at any ground range.
- Return type:
- classmethod from_band(band: RadarBand, **kwargs) RadarStation[source]
Constructs a RadarStation with an illustrative nominal max_range typical of a given weather radar frequency band, for a reasonable starting point without needing to know specific hardware numbers.
These are representative orders of magnitude, not a model of any particular radar, and the real driver of a band’s practical range – precipitation attenuation, which TAT-C does not model as a transient, weather-dependent effect – is only indirectly represented by this static shortening: negligible (effectively no shortening) at S-band, moderate at C-band, and severe (so a much shorter nominal range) at X-band. Pass max_range as a keyword argument to override the band default.
- Parameters:
band (RadarBand) – The nominal operating frequency band.
**kwargs – Other RadarStation fields (e.g. name, latitude, longitude, elevation), including an optional max_range override.
- Returns:
A station with the band tagged and its nominal max_range applied (unless overridden).
- Return type:
- get_effective_max_elevation_angle() float[source]
Gets the highest observed elevation angle: the upper half-power edge of the highest scanned beam.
- Returns:
The effective maximum elevation angle (degrees), max_elevation_angle plus half the beam_width, capped at 90.
- Return type:
- get_effective_min_elevation_angle(azimuth: float) float[source]
Gets the lowest observed elevation angle at a specified azimuth, accounting for this station’s beam_width and terrain_mask (if any).
- Parameters:
azimuth (float) – Azimuth (decimal degrees, clockwise from north).
- Returns:
The effective minimum elevation angle (degrees): the lower half-power edge of the lowest scanned beam (min_elevation_angle minus half the beam_width), raised to any terrain blockage at that azimuth (terrain hides the part of the beam below it), and capped at the effective maximum elevation angle (an azimuth blocked beyond it is simply unobservable, not scannable at a steeper angle still).
- Return type:
- class tatc.schemas.RadarBand(value)[source]
Common weather radar frequency bands. This is an informational tag only: TAT-C does not model transient, weather-dependent propagation effects (e.g. rain attenuation), which is the dominant practical difference between bands in reality – a heavy storm can attenuate an X-band signal to the point of near-total extinction a short distance behind it, a C-band signal moderately, and an S-band signal barely at all. The static effect this schema does represent is a shorter typical maximum range at shorter wavelengths, reflecting that overall attenuation/sensitivity tradeoff in clear-to-moderate conditions; see RadarStation.from_band.
- __format__(format_spec)
Returns format using actual value type unless __str__ has been overridden.
Surface Platform
- pydantic model tatc.schemas.SurfacePlatform[source]
Platform fixed above the Earth’s surface (e.g. a tower or a tethered balloon) in the WGS 84 coordinate system, hosting one or more instruments. Unlike a satellite, the platform does not move in the Earth-fixed frame, so the views of its instruments, and the footprints they project, are static.
Instruments are oriented as on a satellite whose direction of motion is the platform’s heading: a view at zero roll and pitch looks straight down (nadir), a positive roll angle looks to the left of the heading, a positive pitch angle looks toward the heading, and a roll angle of 180 degrees looks straight up (zenith). A generic Instrument observes a cone about nadir; a PointedInstrument observes a view rotated from nadir by fixed roll and pitch angles, for example looking up at a target above the instruments (such as clouds).
Show JSON schema
{ "title": "SurfacePlatform", "description": "Platform fixed above the Earth's surface (e.g. a tower or a tethered\nballoon) in the WGS 84 coordinate system, hosting one or more\ninstruments. Unlike a satellite, the platform does not move in the\nEarth-fixed frame, so the views of its instruments, and the footprints\nthey project, are static.\n\nInstruments are oriented as on a satellite whose direction of motion is\nthe platform's `heading`: a view at zero roll and pitch looks straight\ndown (nadir), a positive roll angle looks to the left of the heading,\na positive pitch angle looks toward the heading, and a roll angle of 180\ndegrees looks straight up (zenith). A generic `Instrument` observes a\ncone about nadir; a `PointedInstrument` observes a view rotated from\nnadir by fixed roll and pitch angles, for example looking up at a\ntarget above the instruments (such as clouds).", "type": "object", "properties": { "id": { "default": 0, "description": "Point identifier. Not used by the analysis methods, which identify points by the hash of their geometry (see `tatc.utils.hash_geometry`).", "minimum": 0, "title": "Id", "type": "integer" }, "latitude": { "description": "Latitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ 40.74259 ], "maximum": 90, "minimum": -90, "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) in the WGS 84 coordinate system.", "examples": [ -74.02686 ], "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" }, "elevation": { "default": 0, "description": "Elevation (meters) of the ground below the platform above the WGS 84 ellipsoid (which differs from a height above mean sea level by the local geoid undulation).", "title": "Elevation", "type": "number" }, "name": { "description": "Platform name.", "examples": [ "tower 1" ], "title": "Name", "type": "string" }, "height": { "description": "Height (meters) of the instruments above the ground, for example the height of a tower or the altitude of a tethered balloon above its tether point.", "examples": [ 30 ], "exclusiveMinimum": 0, "title": "Height", "type": "number" }, "heading": { "default": 0, "description": "Azimuth (decimal degrees, clockwise from north) of the platform's forward (along-track) direction, which orients the views of its instruments.", "exclusiveMaximum": 360, "minimum": 0, "title": "Heading", "type": "number" }, "instruments": { "default": [ { "type": "instrument", "name": "Default", "field_of_regard": 180.0, "min_access_time": "PT0S", "req_self_sunlit": null, "req_target_sunlit": null, "min_target_solar_elevation": null, "max_target_solar_elevation": null, "min_target_glint_angle": null, "max_target_glint_angle": null, "access_time_fixed": false, "nadir_reference": "geodetic" } ], "description": "List of hosted instruments (`Instrument` or `PointedInstrument`).", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "terrain_mask": { "anyOf": [ { "$ref": "#/$defs/TerrainMask" }, { "type": "null" } ], "default": null, "description": "Optional azimuthal terrain blockage mask as seen from the instruments (e.g. from `tatc.preprocess.compute_terrain_mask_for_platform`), which, with the horizon of the ground, blocks views toward a target above the instruments (see `compute_visible_region`). It does not apply to targets below the instruments." } }, "$defs": { "ConicalInstrument": { "additionalProperties": false, "description": "Remote sensing instrument that scans a cone about the nadir: its view\nsweeps rays at a constant angle from nadir (the cone angle) through a\nsector of scan azimuths, tracing an arc on the ground (for example, ahead\nof the satellite). A point is observed when it crosses the cone within\nthe scan sector. The instantaneous footprint is the region the arc sweeps\nas the satellite moves along track by the distance subtended at nadir by\nthe along-track field of view, which stands in for the motion of the arc\nover an integration time.", "properties": { "type": { "const": "conical", "default": "conical", "description": "Instrument type discriminator.", "title": "Type", "type": "string" }, "name": { "default": "Default", "description": "Instrument name.", "title": "Name", "type": "string" }, "field_of_regard": { "default": 180, "description": "Angular field (degrees) of possible observations (with pointing).", "examples": [ 50 ], "exclusiveMinimum": 0, "maximum": 360, "title": "Field Of Regard", "type": "number" }, "min_access_time": { "default": "PT0S", "description": "Minimum access (integration) time to record an observation.", "examples": [ "PT10S" ], "format": "duration", "title": "Min Access Time", "type": "string" }, "req_self_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required instrument sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement).", "title": "Req Self Sunlit" }, "req_target_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required target sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement). Equivalent to a minimum (`True`) or maximum (`False`) target solar elevation angle of 0 degrees.", "title": "Req Target Sunlit" }, "min_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require daylight imaging conditions.", "examples": [ 10 ], "title": "Min Target Solar Elevation" }, "max_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require night-time imaging conditions.", "examples": [ -12 ], "title": "Max Target Solar Elevation" }, "min_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum glint angle (degrees) at the target for valid observation (`None`: no requirement): the angle between the directions toward the satellite and of the Sun's specular reflection (see `tatc.utils.compute_glint_angle`), for example to avoid sun glint over water.", "examples": [ 25 ], "title": "Min Target Glint Angle" }, "max_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum glint angle (degrees) at the target for valid observation (`None`: no requirement), for example to observe in sun glint over water.", "examples": [ 10 ], "title": "Max Target Glint Angle" }, "access_time_fixed": { "default": false, "description": "`True`, if access time is fixed to minimum value.", "title": "Access Time Fixed", "type": "boolean" }, "nadir_reference": { "$ref": "#/$defs/NadirReference", "default": "geodetic", "description": "Definition of the nadir direction from which the view is rotated (`geodetic`: the WGS 84 ellipsoid normal; `geocentric`: toward the Earth's center). The two differ by up to about 0.19 degrees at middle latitudes." }, "cone_angle": { "description": "Angle (degrees) of the scanned cone from nadir.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Cone Angle", "type": "number" }, "along_track_field_of_view": { "description": "Angle (degrees) subtended at nadir by the along-track distance swept by the instantaneous footprint (standing in for the motion of the arc over an integration time).", "exclusiveMaximum": 180, "exclusiveMinimum": 0, "title": "Along Track Field Of View", "type": "number" }, "scan_center_azimuth": { "default": 0, "description": "Scan azimuth (degrees) at the center of the scan sector, from the along-track direction, positive to the left of the direction of motion (0: forward; 180: aft).", "maximum": 180, "minimum": -180, "title": "Scan Center Azimuth", "type": "number" }, "scan_half_width": { "default": 180, "description": "Half width (degrees) of the scan sector on either side of its center (180: a full rotation).", "exclusiveMinimum": 0, "maximum": 180, "title": "Scan Half Width", "type": "number" }, "beam_width": { "anyOf": [ { "exclusiveMaximum": 90, "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Angular width (degrees) of the beam (for example, its half-power width), which sets the size of a sample on the ground (see `compute_sample_size`), or `None` if not modeled.", "title": "Beam Width" }, "scan_sample_spacing": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 180, "type": "number" }, { "type": "null" } ], "default": null, "description": "Scan azimuth (degrees) between the centers of neighboring samples along the scanned arc (see `compute_sample_spacing`), or `None` if not modeled.", "title": "Scan Sample Spacing" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track direction (`earth_fixed`: aligned with the ground track, as for a yaw-steered spacecraft; `inertial`: aligned with the orbit plane, as for a spacecraft without yaw steering)." } }, "required": [ "cone_angle", "along_track_field_of_view" ], "title": "ConicalInstrument", "type": "object" }, "Instrument": { "additionalProperties": false, "description": "Remote sensing instrument.", "properties": { "type": { "const": "instrument", "default": "instrument", "description": "Instrument type discriminator.", "title": "Type", "type": "string" }, "name": { "default": "Default", "description": "Instrument name.", "title": "Name", "type": "string" }, "field_of_regard": { "default": 180, "description": "Angular field (degrees) of possible observations (with pointing).", "examples": [ 50 ], "exclusiveMinimum": 0, "maximum": 360, "title": "Field Of Regard", "type": "number" }, "min_access_time": { "default": "PT0S", "description": "Minimum access (integration) time to record an observation.", "examples": [ "PT10S" ], "format": "duration", "title": "Min Access Time", "type": "string" }, "req_self_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required instrument sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement).", "title": "Req Self Sunlit" }, "req_target_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required target sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement). Equivalent to a minimum (`True`) or maximum (`False`) target solar elevation angle of 0 degrees.", "title": "Req Target Sunlit" }, "min_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require daylight imaging conditions.", "examples": [ 10 ], "title": "Min Target Solar Elevation" }, "max_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require night-time imaging conditions.", "examples": [ -12 ], "title": "Max Target Solar Elevation" }, "min_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum glint angle (degrees) at the target for valid observation (`None`: no requirement): the angle between the directions toward the satellite and of the Sun's specular reflection (see `tatc.utils.compute_glint_angle`), for example to avoid sun glint over water.", "examples": [ 25 ], "title": "Min Target Glint Angle" }, "max_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum glint angle (degrees) at the target for valid observation (`None`: no requirement), for example to observe in sun glint over water.", "examples": [ 10 ], "title": "Max Target Glint Angle" }, "access_time_fixed": { "default": false, "description": "`True`, if access time is fixed to minimum value.", "title": "Access Time Fixed", "type": "boolean" }, "nadir_reference": { "$ref": "#/$defs/NadirReference", "default": "geodetic", "description": "Definition of the nadir direction from which the view is rotated (`geodetic`: the WGS 84 ellipsoid normal; `geocentric`: toward the Earth's center). The two differ by up to about 0.19 degrees at middle latitudes." } }, "title": "Instrument", "type": "object" }, "NadirReference": { "description": "Enumeration of definitions of the nadir direction, from which an\ninstrument's view is rotated. The two coincide over the equator and the\npoles and otherwise differ by up to about 0.19 degrees (at middle\nlatitudes), which shifts a projected view by up to about 2.7 km from\n800 km altitude.", "enum": [ "geodetic", "geocentric" ], "title": "NadirReference", "type": "string" }, "PointedInstrument": { "additionalProperties": false, "description": "Remote sensing instrument with an optional off-nadir (roll/pitch)\npointing offset and a rectangular or elliptical pixel array.\n\nThe view is rotated from the axes of the space system's body (see\n`tatc.schemas.Attitude`), or from the nadir frame without an attitude,\nby the instrument's own angles: first by its yaw angle about the nadir\naxis, then (in scan geometry) by the tilt of the scan plane, then by\nits roll angle about the along-track axis, then (in frame geometry) by\nits pitch angle about the rolled cross-track axis. The body's attitude\nis shared by the instruments it carries, while these angles orient\neach instrument on the body, as its mounting does.", "properties": { "type": { "const": "pointed", "default": "pointed", "description": "Instrument type discriminator.", "title": "Type", "type": "string" }, "name": { "default": "Default", "description": "Instrument name.", "title": "Name", "type": "string" }, "field_of_regard": { "default": 180, "description": "Angular field (degrees) of possible observations (with pointing).", "examples": [ 50 ], "exclusiveMinimum": 0, "maximum": 360, "title": "Field Of Regard", "type": "number" }, "min_access_time": { "default": "PT0S", "description": "Minimum access (integration) time to record an observation.", "examples": [ "PT10S" ], "format": "duration", "title": "Min Access Time", "type": "string" }, "req_self_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required instrument sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement).", "title": "Req Self Sunlit" }, "req_target_sunlit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Required target sunlit state for valid observation (`True`: sunlit, `False`: eclipse, `None`: no requirement). Equivalent to a minimum (`True`) or maximum (`False`) target solar elevation angle of 0 degrees.", "title": "Req Target Sunlit" }, "min_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require daylight imaging conditions.", "examples": [ 10 ], "title": "Min Target Solar Elevation" }, "max_target_solar_elevation": { "anyOf": [ { "maximum": 90, "minimum": -90, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum solar elevation angle (degrees) at the target for valid observation (`None`: no requirement), for example to require night-time imaging conditions.", "examples": [ -12 ], "title": "Max Target Solar Elevation" }, "min_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum glint angle (degrees) at the target for valid observation (`None`: no requirement): the angle between the directions toward the satellite and of the Sun's specular reflection (see `tatc.utils.compute_glint_angle`), for example to avoid sun glint over water.", "examples": [ 25 ], "title": "Min Target Glint Angle" }, "max_target_glint_angle": { "anyOf": [ { "maximum": 180, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum glint angle (degrees) at the target for valid observation (`None`: no requirement), for example to observe in sun glint over water.", "examples": [ 10 ], "title": "Max Target Glint Angle" }, "access_time_fixed": { "default": false, "description": "`True`, if access time is fixed to minimum value.", "title": "Access Time Fixed", "type": "boolean" }, "nadir_reference": { "$ref": "#/$defs/NadirReference", "default": "geodetic", "description": "Definition of the nadir direction from which the view is rotated (`geodetic`: the WGS 84 ellipsoid normal; `geocentric`: toward the Earth's center). The two differ by up to about 0.19 degrees at middle latitudes." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the view about the body's nadir axis, before its roll and pitch, positive turning its along-track axis to the left of the direction of motion, as an attitude's yaw angle turns the body (for example, an instrument whose scan line is rotated on the body).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "cross_track_field_of_view": { "description": "Angular field (degrees) of view orthogonal to instrument motion.", "exclusiveMinimum": 0, "maximum": 180, "title": "Cross Track Field Of View", "type": "number" }, "along_track_field_of_view": { "description": "Angular field (degrees) of view in direction of instrument motion.", "exclusiveMinimum": 0, "maximum": 180, "title": "Along Track Field Of View", "type": "number" }, "roll_angle": { "default": 0, "description": "Left/right look angle (degrees): a rotation of the view about the along-track axis, positive to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "roll_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Roll angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360, in the direction of motion), as (argument of latitude, roll angle) pairs interpolated linearly and periodically, for an instrument whose roll varies around the orbit (for example, the roll steering of a synthetic aperture radar). If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "pitch_angle": { "default": 0, "description": "Fore/aft look angle (degrees): a rotation of the view about the rolled cross-track axis (after roll), positive forward. In scan geometry, the tilt of the scan plane: a rotation about the cross-track axis before roll, as for a scanner that tilts fore or aft.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "pitch_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Pitch angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360, in the direction of motion), as (argument of latitude, pitch angle) pairs interpolated linearly and periodically, for an instrument whose pitch varies around the orbit (for example, an imager that tilts fore or aft to avoid sun glint). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "view_geometry": { "$ref": "#/$defs/ViewGeometry", "default": "frame", "description": "Geometry in which the fields of view and pixels are defined: in a plane perpendicular to the boresight (`frame`, as for a framing camera or a pushbroom array), or in cross-track and along-track angles (`scan`, as for a cross-track scanner, whose along-track angular extent is constant across the scan)." }, "is_rectangular": { "default": false, "description": "True, if this instrument produces a rectangular view.", "title": "Is Rectangular", "type": "boolean" }, "is_swept": { "default": false, "description": "True, if this instrument's view sweeps along track, as for a pushbroom imager or a cross-track scanner, whose footprints over the time steps of a ground track or the samples of a region are the strips swept by its cross-track line (the directions whose along-track angle relative to the view center is zero; see `compute_swept_footprints`), as `tatc.analysis.collect_observations` observes a point when that line sweeps over it, rather than its view at each instant. The along-track field of view still sets the view at an instant (see `compute_footprint`).", "title": "Is Swept", "type": "boolean" }, "cross_track_pixels": { "default": 1, "description": "Number of pixels in cross-track direction.", "minimum": 1, "title": "Cross Track Pixels", "type": "integer" }, "along_track_pixels": { "default": 1, "description": "Number of pixels in along-track direction.", "minimum": 1, "title": "Along Track Pixels", "type": "integer" }, "cross_track_oversampling": { "default": 0, "description": "Fraction of pixel overlap in cross-track direction: the fraction of a pixel's instantaneous field of view shared with its neighbor (negative for a gap between pixels, as a fraction of the instantaneous field of view).", "exclusiveMaximum": 1, "title": "Cross Track Oversampling", "type": "number" }, "along_track_oversampling": { "default": 0, "description": "Fraction of pixel overlap in along-track direction: the fraction of a pixel's instantaneous field of view shared with its neighbor (negative for a gap between pixels, as a fraction of the instantaneous field of view).", "exclusiveMaximum": 1, "title": "Along Track Oversampling", "type": "number" }, "scan_period": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Period (seconds) between consecutive scans of a scanning instrument (for example, 8/3 s for ATMS), whose scans are spaced along track by the distance they advance on the ground in one period (see `compute_sample_spacing`), or `None` if not modeled.", "title": "Scan Period" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track direction (`earth_fixed`: aligned with the ground track, as for a yaw-steered spacecraft; `inertial`: aligned with the orbit plane, as for a spacecraft without yaw steering)." } }, "required": [ "cross_track_field_of_view", "along_track_field_of_view" ], "title": "PointedInstrument", "type": "object" }, "TerrainMask": { "description": "Azimuthal terrain blockage mask for a fixed surface object (a\n`RadarStation` or a `SurfacePlatform`): the minimum usable elevation\nangle at each azimuth, due to terrain blocking the line of sight at low\ngrazing angles. Typically derived by ray-tracing a digital elevation\nmodel (DEM) outward from the antenna or instruments to find the highest\nterrain obstruction angle along each azimuthal direction (see\n`tatc.preprocess.compute_terrain_mask`).\n\nThis represents one blocking angle per azimuth (the common case for a\nDEM-derived terrain horizon, where the nearest/highest ridge along a\nray dominates): any elevation angle at or above the masked value is\nassumed clear, and any below it is blocked. It does not model\nmultiple, separately-blocked elevation bands along the same azimuth\n(e.g. a nearby building blocking only a narrow low-elevation slice\nwhile a distant mountain blocks a separate, higher slice).", "properties": { "azimuth": { "description": "Azimuth samples (decimal degrees, clockwise from north, in [0, 360)), strictly increasing, at which the minimum elevation angle is specified. Values are linearly interpolated between samples, wrapping around 0/360 degrees.", "items": { "type": "number" }, "minItems": 2, "title": "Azimuth", "type": "array" }, "min_elevation_angle": { "description": "Minimum usable elevation angle (decimal degrees), due to terrain blockage, at each corresponding azimuth.", "items": { "type": "number" }, "minItems": 2, "title": "Min Elevation Angle", "type": "array" } }, "required": [ "azimuth", "min_elevation_angle" ], "title": "TerrainMask", "type": "object" }, "VelocityFrame": { "description": "Enumeration of reference frames for the velocity vector that defines an\ninstrument's along-track direction (and hence its cross-track direction,\northogonal to velocity and nadir).", "enum": [ "earth_fixed", "inertial" ], "title": "VelocityFrame", "type": "string" }, "ViewGeometry": { "description": "Enumeration of the geometries in which a pointed instrument's view (its\nfields of view and pixels) is defined.", "enum": [ "frame", "scan" ], "title": "ViewGeometry", "type": "string" } }, "required": [ "latitude", "longitude", "name", "height" ] }
- Fields:
elevation (float)heading (float)height (float)instruments (list[AllInstruments])name (str)terrain_mask (TerrainMask | None)
- Validators:
check_instruments»all fields
- field elevation: float = 0
Elevation (meters) of the ground below the platform above the WGS 84 ellipsoid (which differs from a height above mean sea level by the local geoid undulation).
- Validated by:
check_instruments
- field heading: float = 0
Azimuth (decimal degrees, clockwise from north) of the platform’s forward (along-track) direction, which orients the views of its instruments.
- Constraints:
ge = 0
lt = 360
- Validated by:
check_instruments
- field height: float [Required]
Height (meters) of the instruments above the ground, for example the height of a tower or the altitude of a tethered balloon above its tether point.
- Constraints:
gt = 0
- Validated by:
check_instruments
- field instruments: list[AllInstruments] = [Instrument(type='instrument', name='Default', field_of_regard=180, min_access_time=datetime.timedelta(0), req_self_sunlit=None, req_target_sunlit=None, min_target_solar_elevation=None, max_target_solar_elevation=None, min_target_glint_angle=None, max_target_glint_angle=None, access_time_fixed=False, nadir_reference=<NadirReference.GEODETIC: 'geodetic'>)]
List of hosted instruments (Instrument or PointedInstrument).
- Constraints:
min_length = 1
- Validated by:
check_instruments
- field terrain_mask: TerrainMask | None = None
Optional azimuthal terrain blockage mask as seen from the instruments (e.g. from tatc.preprocess.compute_terrain_mask_for_platform), which, with the horizon of the ground, blocks views toward a target above the instruments (see compute_visible_region). It does not apply to targets below the instruments.
- Validated by:
check_instruments
- validator check_instruments » all fields[source]
Checks that each instrument’s view is defined for a fixed platform: not a ConicalInstrument (whose footprint is swept by motion along track), and without roll or pitch angle profiles (which vary with an orbit’s argument of latitude) or an inertial velocity frame (aligned with an orbit plane).
- compute_visible_region(elevation: float, number_azimuths: int = 360) Polygon | MultiPolygon[source]
Computes the region at a target elevation above the instruments that is visible over the horizon: bounded at each azimuth by the lowest line of sight that clears both the terrain mask (if any) and the horizon of the ground, projected to the target elevation. Footprints toward a target above the instruments are clipped to this region (see tatc.analysis.collect_platform_track).
- Parameters:
- Returns:
- The
visible region.
- Return type:
shapely.geometry.Polygon | shapely.geometry.MultiPolygon
- get_altitude() float[source]
Gets the elevation of the instruments: the ground elevation plus the platform height.
- Returns:
the elevation (meters) above the WGS 84 ellipsoid
- Return type:
- get_track(times: datetime | list[datetime] | None = None) Geocentric[source]
Gets the static track of the platform’s instruments (see tatc.utils.compute_static_track), from which they project their views as from a satellite’s orbit track.
- Parameters:
times (datetime.datetime | list[datetime.datetime] | None) – The time(s). The views and footprints do not depend on time; times are needed only to evaluate time-varying conditions (such as the sunlit conditions of Instrument.is_valid_observation). Defaults to 2020-01-01 00:00:00 UTC.
- Returns:
The position/velocity.
- Return type:
skyfield.positionlib.Geocentric
Terrain Mask
- pydantic model tatc.schemas.TerrainMask[source]
Azimuthal terrain blockage mask for a fixed surface object (a RadarStation or a SurfacePlatform): the minimum usable elevation angle at each azimuth, due to terrain blocking the line of sight at low grazing angles. Typically derived by ray-tracing a digital elevation model (DEM) outward from the antenna or instruments to find the highest terrain obstruction angle along each azimuthal direction (see tatc.preprocess.compute_terrain_mask).
This represents one blocking angle per azimuth (the common case for a DEM-derived terrain horizon, where the nearest/highest ridge along a ray dominates): any elevation angle at or above the masked value is assumed clear, and any below it is blocked. It does not model multiple, separately-blocked elevation bands along the same azimuth (e.g. a nearby building blocking only a narrow low-elevation slice while a distant mountain blocks a separate, higher slice).
Show JSON schema
{ "title": "TerrainMask", "description": "Azimuthal terrain blockage mask for a fixed surface object (a\n`RadarStation` or a `SurfacePlatform`): the minimum usable elevation\nangle at each azimuth, due to terrain blocking the line of sight at low\ngrazing angles. Typically derived by ray-tracing a digital elevation\nmodel (DEM) outward from the antenna or instruments to find the highest\nterrain obstruction angle along each azimuthal direction (see\n`tatc.preprocess.compute_terrain_mask`).\n\nThis represents one blocking angle per azimuth (the common case for a\nDEM-derived terrain horizon, where the nearest/highest ridge along a\nray dominates): any elevation angle at or above the masked value is\nassumed clear, and any below it is blocked. It does not model\nmultiple, separately-blocked elevation bands along the same azimuth\n(e.g. a nearby building blocking only a narrow low-elevation slice\nwhile a distant mountain blocks a separate, higher slice).", "type": "object", "properties": { "azimuth": { "description": "Azimuth samples (decimal degrees, clockwise from north, in [0, 360)), strictly increasing, at which the minimum elevation angle is specified. Values are linearly interpolated between samples, wrapping around 0/360 degrees.", "items": { "type": "number" }, "minItems": 2, "title": "Azimuth", "type": "array" }, "min_elevation_angle": { "description": "Minimum usable elevation angle (decimal degrees), due to terrain blockage, at each corresponding azimuth.", "items": { "type": "number" }, "minItems": 2, "title": "Min Elevation Angle", "type": "array" } }, "required": [ "azimuth", "min_elevation_angle" ] }
- Fields:
azimuth (list[float])min_elevation_angle (list[float])
- Validators:
validate_profile»all fields
- field azimuth: list[float] [Required]
Azimuth samples (decimal degrees, clockwise from north, in [0, 360)), strictly increasing, at which the minimum elevation angle is specified. Values are linearly interpolated between samples, wrapping around 0/360 degrees.
- Constraints:
min_length = 2
- Validated by:
validate_profile
- field min_elevation_angle: list[float] [Required]
Minimum usable elevation angle (decimal degrees), due to terrain blockage, at each corresponding azimuth.
- Constraints:
min_length = 2
- Validated by:
validate_profile
- get_min_elevation_angle(azimuth: float) float[source]
Interpolates (periodically, wrapping at 0/360 degrees) the minimum usable elevation angle at a specified azimuth.
- get_min_elevation_angles(azimuths: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) ndarray[tuple[int, ...], dtype[_ScalarType_co]][source]
Interpolates (periodically, wrapping at 0/360 degrees) the minimum usable elevation angles at specified azimuths, vectorized across azimuths (see get_min_elevation_angle).
- Parameters:
azimuths (numpy.typing.ArrayLike) – Azimuths (decimal degrees, clockwise from north).
- Returns:
The interpolated minimum usable elevation angles (degrees).
- Return type:
numpy.typing.NDArray