Space System Models
Instrument
- pydantic model tatc.schemas.Instrument[source]
Remote sensing instrument.
Show JSON schema
{ "title": "Instrument", "description": "Remote sensing instrument.", "type": "object", "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." } }, "$defs": { "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" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Fields:
access_time_fixed (bool)field_of_regard (float)max_target_glint_angle (float | None)max_target_solar_elevation (float | None)min_access_time (datetime.timedelta)min_target_glint_angle (float | None)min_target_solar_elevation (float | None)nadir_reference (tatc.utils.projection.NadirReference)name (str)req_self_sunlit (bool | None)req_target_sunlit (bool | None)type (Literal['instrument'])
- Validators:
check_target_solar_elevation_range»all fields
- field access_time_fixed: bool = False
True, if access time is fixed to minimum value.
- Validated by:
check_target_solar_elevation_range
- field field_of_regard: float = 180
Angular field (degrees) of possible observations (with pointing).
- Constraints:
gt = 0
le = 360
- Validated by:
check_target_solar_elevation_range
- field max_target_glint_angle: float | None = None
Maximum glint angle (degrees) at the target for valid observation (None: no requirement), for example to observe in sun glint over water.
- Constraints:
ge = 0
le = 180
- Validated by:
check_target_solar_elevation_range
- field max_target_solar_elevation: float | None = None
Maximum solar elevation angle (degrees) at the target for valid observation (None: no requirement), for example to require night-time imaging conditions.
- Constraints:
ge = -90
le = 90
- Validated by:
check_target_solar_elevation_range
- field min_access_time: timedelta = datetime.timedelta(0)
Minimum access (integration) time to record an observation.
- Validated by:
check_target_solar_elevation_range
- field min_target_glint_angle: float | None = None
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.
- Constraints:
ge = 0
le = 180
- Validated by:
check_target_solar_elevation_range
- field min_target_solar_elevation: float | None = None
Minimum solar elevation angle (degrees) at the target for valid observation (None: no requirement), for example to require daylight imaging conditions.
- Constraints:
ge = -90
le = 90
- Validated by:
check_target_solar_elevation_range
- field nadir_reference: NadirReference = NadirReference.GEODETIC
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.
- Validated by:
check_target_solar_elevation_range
- field req_self_sunlit: bool | None = None
Required instrument sunlit state for valid observation (True: sunlit, False: eclipse, None: no requirement).
- Validated by:
check_target_solar_elevation_range
- field req_target_sunlit: bool | None = None
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.
- Validated by:
check_target_solar_elevation_range
- field type: Literal['instrument'] = 'instrument'
Instrument type discriminator.
- Validated by:
check_target_solar_elevation_range
- bind_attitude(attitude: Any) Instrument[source]
Gets a copy of this instrument carried by a space system with an attitude (see tatc.schemas.Attitude and tatc.schemas.AttitudeSchedule): its views (but not its field of regard, measured from nadir) are rotated from the body’s axes.
- Parameters:
attitude (Any) – The attitude, or None.
- Returns:
the bound copy
- Return type:
- validator check_target_solar_elevation_range » all fields[source]
Check that the minimum target solar elevation angle does not exceed the maximum.
- compute_footprint(orbit_track: Geocentric, number_points: int | None = None, elevation: float = 0, ground_elevation: float = 0) list[Polygon | MultiPolygon][source]
Compute the instanteous instrument footprint.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
number_points (int | None) – The required number of polygon points to generate.
elevation (float) – The elevation (meters) at which project the footprint.
ground_elevation (float) – The elevation (meters) of the ground, which blocks rays toward an elevation above the instrument.
- Returns:
The instrument footprint(s).
- Return type:
list[shapely.geometry.Polygon | shapely.geometry.MultiPolygon]
- compute_footprint_center(orbit_track: Geocentric, elevation: float = 0, ground_elevation: float = 0) GeographicPosition[source]
Compute the center of an instaneous instrument footprint.
- Parameters:
- Returns:
The instrument footprint center.
- Return type:
skyfield.toposlib.GeographicPosition
- get_min_elevation_angle(height: float) float[source]
Get the minimum elevation angle required to observe a point.
- get_swath_width(height: float) float[source]
Gets the instrument swath width projected to the Earth’s surface.
- is_observing(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[bool]][source]
Determines if the instrument observes at each time of an orbit track: outside the blind intervals of the attitude of the space system that carries it (see tatc.schemas.Attitude.blind_intervals), if any.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
- Returns:
Array of indicators: True if the instrument observes.
- Return type:
numpy.typing.NDArray
- is_valid_observation(orbit_track: Geocentric, target: GeographicPosition | None = None) ndarray[tuple[int, ...], dtype[bool]][source]
Determines if an instrument can provide a valid observations: the instrument must observe (see is_observing), and the instrument’s sunlit state and the target’s sunlit state, solar elevation angle (without atmospheric refraction), and glint angle must satisfy any requirements.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – orbit track position/velocity from Skyfield
target (skyfield.toposlib.GeographicPosition) – target position from Skyfield
- Returns:
Array of indicators: True if instrument provides a valid observation.
- Return type:
numpy.typing.NDArray
Pointed Instrument
- pydantic model tatc.schemas.PointedInstrument[source]
Remote sensing instrument with an optional off-nadir (roll/pitch) pointing offset and a rectangular or elliptical pixel array.
The view is rotated from the axes of the space system’s body (see tatc.schemas.Attitude), or from the nadir frame without an attitude, by the instrument’s own angles: first by its yaw angle about the nadir axis, then (in scan geometry) by the tilt of the scan plane, then by its roll angle about the along-track axis, then (in frame geometry) by its pitch angle about the rolled cross-track axis. The body’s attitude is shared by the instruments it carries, while these angles orient each instrument on the body, as its mounting does.
Show JSON schema
{ "title": "PointedInstrument", "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.", "type": "object", "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)." } }, "$defs": { "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" }, "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" } }, "additionalProperties": false, "required": [ "cross_track_field_of_view", "along_track_field_of_view" ] }
- Config:
extra: str = forbid
- Fields:
along_track_field_of_view (float)along_track_oversampling (float)along_track_pixels (int)cross_track_field_of_view (float)cross_track_oversampling (float)cross_track_pixels (int)is_rectangular (bool)is_swept (bool)pitch_angle (float)pitch_angle_profile (list[tuple[float, float]] | None)roll_angle (float)roll_angle_profile (list[tuple[float, float]] | None)scan_period (float | None)type (Literal['pointed'])velocity_frame (VelocityFrame)view_geometry (ViewGeometry)yaw_angle (float)
- Validators:
_validate_angle_profile»pitch_angle_profile_validate_angle_profile»roll_angle_profile
- field along_track_field_of_view: float [Required]
Angular field (degrees) of view in direction of instrument motion.
- Constraints:
gt = 0
le = 180
- Validated by:
check_target_solar_elevation_range
- field along_track_oversampling: float = 0
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).
- Constraints:
lt = 1
- Validated by:
check_target_solar_elevation_range
- field along_track_pixels: int = 1
Number of pixels in along-track direction.
- Constraints:
ge = 1
- Validated by:
check_target_solar_elevation_range
- field cross_track_field_of_view: float [Required]
Angular field (degrees) of view orthogonal to instrument motion.
- Constraints:
gt = 0
le = 180
- Validated by:
check_target_solar_elevation_range
- field cross_track_oversampling: float = 0
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).
- Constraints:
lt = 1
- Validated by:
check_target_solar_elevation_range
- field cross_track_pixels: int = 1
Number of pixels in cross-track direction.
- Constraints:
ge = 1
- Validated by:
check_target_solar_elevation_range
- field is_rectangular: bool = False
True, if this instrument produces a rectangular view.
- Validated by:
check_target_solar_elevation_range
- field is_swept: bool = False
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).
- Validated by:
check_target_solar_elevation_range
- field pitch_angle: float = 0
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.
- Constraints:
ge = -180
le = 180
- Validated by:
check_target_solar_elevation_range
- field pitch_angle_profile: list[tuple[float, float]] | None = None
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.
- Constraints:
min_length = 1
- Validated by:
_validate_angle_profilecheck_target_solar_elevation_range
- field roll_angle: float = 0
Left/right look angle (degrees): a rotation of the view about the along-track axis, positive to the left of the direction of motion.
- Constraints:
ge = -180
le = 180
- Validated by:
check_target_solar_elevation_range
- field roll_angle_profile: list[tuple[float, float]] | None = None
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.
- Constraints:
min_length = 1
- Validated by:
_validate_angle_profilecheck_target_solar_elevation_range
- field scan_period: float | None = None
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.
- Constraints:
gt = 0
- Validated by:
check_target_solar_elevation_range
- field type: Literal['pointed'] = 'pointed'
Instrument type discriminator.
- Validated by:
check_target_solar_elevation_range
- field velocity_frame: VelocityFrame = VelocityFrame.EARTH_FIXED
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).
- Validated by:
check_target_solar_elevation_range
- field view_geometry: ViewGeometry = ViewGeometry.FRAME
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).
- Validated by:
check_target_solar_elevation_range
- field yaw_angle: float = 0
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).
- Constraints:
ge = -180
le = 180
- Validated by:
check_target_solar_elevation_range
- compute_footprint(orbit_track: Geocentric, number_points: int | None = None, elevation: float = 0, ground_elevation: float = 0) list[Polygon | MultiPolygon][source]
Compute the instanteous instrument footprint.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
number_points (int | None) – The required number of polygon points to generate.
elevation (float) – The elevation (meters) at which project the footprint.
ground_elevation (float) – The elevation (meters) of the ground, which blocks rays toward an elevation above the instrument.
- Returns:
The instrument footprint(s).
- Return type:
list[shapely.geometry.Polygon | shapely.geometry.MultiPolygon]
- compute_footprint_center(orbit_track: Geocentric, elevation: float = 0, ground_elevation: float = 0) GeographicPosition[source]
Compute the center of an instaneous instrument footprint.
- Parameters:
- Returns:
The instrument footprint center.
- Return type:
skyfield.toposlib.GeographicPosition
- compute_footprint_pixel_array(orbit_track: Geocentric, elevation: float = 0, ground_elevation: float = 0) list[MultiPoint][source]
Compute the instanteous footprint pixel array.
- Parameters:
- Returns:
The instrument pixel array(s).
- Return type:
list[shapely.geometry.MultiPoint]
- compute_projected_pixel_position(orbit_track: Geocentric, cross_track_index: int, along_track_index: int, elevation: float = 0, ground_elevation: float = 0) GeographicPosition[source]
Get the location of a projected pixel.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – the satellite orbit track.
cross_track_index (int) – cross-track pixel index (right to left: index 0 is on the right of the direction of motion).
along_track_index (int) – along-track pixel index (fore-to-aft).
elevation (float) – The elevation (meters) at which project the pixel.
ground_elevation (float) – The elevation (meters) of the ground, which blocks rays toward an elevation above the instrument.
- Returns:
the geographic position of the projected pixel
- Return type:
(skyfield.toposlib.GeographicPosition)
- compute_sample_size(orbit_track: Geocentric, target: GeographicPosition) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Computes the size on the ground (meters) of a pixel viewing a target: the extent of its instantaneous field of view along track and across track, centered on the line of sight to the target (see tatc.utils.compute_ground_sample_size). The sizes grow with the slant range and, in the direction of a view off nadir, with the obliquity of the view.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position (a single target, or one target for each time of the orbit track).
- Returns:
- the along-track
and cross-track sizes (meters).
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray]
- compute_sample_spacing(orbit_track: Geocentric, target: GeographicPosition) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Computes the spacing on the ground (meters) between the centers of neighboring pixels viewing a target, along track and across track (see compute_sample_size). A pixel smaller than the spacing (a negative oversampling) leaves gaps between pixels, and a sensor cannot resolve detail finer than the larger of the two.
The spacing is that of the angles between pixels, projected around the line of sight to the target. For a scanning instrument with a scan_period, the spacing along track is instead the larger of the angular spacing between its pixels within a scan (if it has more than one along track) and the distance the scan advances on the ground at the target in one period, divided among its pixels along track (see tatc.utils.compute_ground_advance). The advance, nearly constant across the scan, spaces the scans of an instrument with one pixel along track (such as a microwave sounder); toward the edges of the swath, where the pixels of an array of detectors grow larger than the advance, consecutive scans overlap and the spacing within a scan dominates.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position (a single target, or one target for each time of the orbit track).
- Returns:
- the along-track
and cross-track spacings (meters).
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray]
- compute_swept_footprints(orbit_track: Geocentric, counts: _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], number_points: int | None = None, elevation: float = 0) list[Polygon | MultiPolygon][source]
Compute the footprints swept by the view’s cross-track line over spans of time (see tatc.utils.compute_swept_footprints).
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity at the times of each span (at least two, from its start to its end), one span after another.
counts (numpy.typing.ArrayLike) – The number of times of each span.
number_points (int | None) – The number of points across the line.
elevation (float) – The elevation (meters) at which project the footprints.
- Returns:
- The
footprint of each span.
- Return type:
list[shapely.geometry.Polygon | shapely.geometry.MultiPolygon]
- get_along_track_instantaneous_field_of_view() float[source]
Gets the instananeous field of view (degrees) for along-track pixels.
- Returns:
the along-track instantaneous pixel field of view (degrees)
- Return type:
- get_along_track_sample_spacing() float[source]
Gets the angular spacing (degrees) between the centers of neighboring along-track pixels: the field of view divided among the pixels.
- Returns:
the along-track sample spacing (degrees)
- Return type:
- get_cross_track_instantaneous_field_of_view() float[source]
Gets the instananeous field of view (degrees) for cross-track pixels.
- Returns:
the cross-track instantaneous pixel field of view (degrees)
- Return type:
- get_cross_track_sample_spacing() float[source]
Gets the angular spacing (degrees) between the centers of neighboring cross-track pixels: the field of view divided among the pixels.
- Returns:
the cross-track sample spacing (degrees)
- Return type:
- get_pitch_angle(orbit_track: Geocentric | None = None) float | ndarray[tuple[int, ...], dtype[float64]][source]
Gets the pitch angle (degrees) at the satellite position(s) of an orbit track: interpolated from pitch_angle_profile at the satellite’s argument of latitude, if given, or otherwise pitch_angle.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric | None) – The satellite position/velocity (in an inertial frame).
- Returns:
the pitch angle(s) (degrees)
- Return type:
float | numpy.typing.NDArray[numpy.float64]
- get_pixel_cone_and_clock_angle(cross_track_index: int, along_track_index: int) tuple[float, float][source]
Gets the cone and clock angles (degrees) for a given pixel: its angular offset from the instrument boresight (after roll/pitch), expressed in polar form.
- Parameters:
- Returns:
- cone (the pixel’s total angular
displacement from boresight) and clock (about the boresight, from the cross-track axis on the left of the direction of motion toward the along-track axis forward) angles (degrees).
- Return type:
- get_roll_angle(orbit_track: Geocentric | None = None) float | ndarray[tuple[int, ...], dtype[float64]][source]
Gets the roll angle (degrees) at the satellite position(s) of an orbit track: interpolated from roll_angle_profile at the satellite’s argument of latitude, if given, or otherwise roll_angle.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric | None) – The satellite position/velocity (in an inertial frame).
- Returns:
the roll angle(s) (degrees)
- Return type:
float | numpy.typing.NDArray[numpy.float64]
- is_in_field_of_view(orbit_track: Geocentric, target: GeographicPosition) ndarray[tuple[int, ...], dtype[bool]][source]
Determines if a target lies within the instantaneous field of view. Does not check whether the target is above the satellite’s horizon.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position.
- Returns:
Array of indicators: True if the target is in the field of view.
- Return type:
numpy.typing.NDArray
Conical Instrument
- pydantic model tatc.schemas.ConicalInstrument[source]
Remote sensing instrument that scans a cone about the nadir: its view sweeps rays at a constant angle from nadir (the cone angle) through a sector of scan azimuths, tracing an arc on the ground (for example, ahead of the satellite). A point is observed when it crosses the cone within the scan sector. The instantaneous footprint is the region the arc sweeps as the satellite moves along track by the distance subtended at nadir by the along-track field of view, which stands in for the motion of the arc over an integration time.
Show JSON schema
{ "title": "ConicalInstrument", "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.", "type": "object", "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)." } }, "$defs": { "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" }, "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" } }, "additionalProperties": false, "required": [ "cone_angle", "along_track_field_of_view" ] }
- Config:
extra: str = forbid
- Fields:
along_track_field_of_view (float)beam_width (float | None)cone_angle (float)scan_center_azimuth (float)scan_half_width (float)scan_sample_spacing (float | None)type (Literal['conical'])velocity_frame (VelocityFrame)
- Validators:
default_field_of_regard»all fields
- field along_track_field_of_view: float [Required]
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).
- Constraints:
gt = 0
lt = 180
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field beam_width: float | None = None
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.
- Constraints:
gt = 0
lt = 90
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field cone_angle: float [Required]
Angle (degrees) of the scanned cone from nadir.
- Constraints:
gt = 0
lt = 90
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field scan_center_azimuth: float = 0
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).
- Constraints:
ge = -180
le = 180
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field scan_half_width: float = 180
Half width (degrees) of the scan sector on either side of its center (180: a full rotation).
- Constraints:
gt = 0
le = 180
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field scan_sample_spacing: float | None = None
Scan azimuth (degrees) between the centers of neighboring samples along the scanned arc (see compute_sample_spacing), or None if not modeled.
- Constraints:
gt = 0
le = 180
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field type: Literal['conical'] = 'conical'
Instrument type discriminator.
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- field velocity_frame: VelocityFrame = VelocityFrame.EARTH_FIXED
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).
- Validated by:
check_target_solar_elevation_rangedefault_field_of_regard
- compute_footprint(orbit_track: Geocentric, number_points: int | None = None, elevation: float = 0, ground_elevation: float = 0) list[Polygon | MultiPolygon][source]
Compute the instanteous instrument footprint: the region swept by the scanned arc as the satellite moves along track by the distance subtended at nadir by the along-track field of view.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
number_points (int | None) – The number of points along a full rotation of each edge of the arc. Defaults to the runtime configuration.
elevation (float) – The elevation (meters) at which project the footprint.
ground_elevation (float) – The elevation (meters) of the ground, which blocks rays toward an elevation above the instrument.
- Returns:
The instrument footprint(s).
- Return type:
list[shapely.geometry.Polygon | shapely.geometry.MultiPolygon]
- compute_footprint_center(orbit_track: Geocentric, elevation: float = 0, ground_elevation: float = 0) GeographicPosition[source]
Compute the center of an instaneous instrument footprint: the point on the cone at the center of the scan sector.
- Parameters:
- Returns:
The instrument footprint center.
- Return type:
skyfield.toposlib.GeographicPosition
- compute_sample_size(orbit_track: Geocentric, target: GeographicPosition) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Computes the size on the ground (meters) of the beam viewing a target, along track and across track (see tatc.utils.compute_ground_sample_size): the beam is circular, but its footprint is longer in the direction of the view (along track, for a view ahead of the satellite), as the view is oblique. The sizes are NaN if the beam width is not modeled.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position (a single target, or one target for each time of the orbit track).
- Returns:
- the along-track
and cross-track sizes (meters).
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray]
- compute_sample_spacing(orbit_track: Geocentric, target: GeographicPosition) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Computes the spacing on the ground (meters) between the centers of neighboring samples viewing a target: along track, the distance the scanned arc advances between scans (subtended at nadir by the along-track field of view), and across track, the distance between samples along the scanned arc (the scan sample spacing times the arc’s radius on the ground, from the sub-satellite point to the target). The cross-track spacing is NaN if the scan sample spacing is not modeled.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position (a single target, or one target for each time of the orbit track).
- Returns:
- the along-track
and cross-track spacings (meters).
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray]
- validator default_field_of_regard » all fields[source]
Defaults the field of regard to contain the instantaneous footprint, with a margin of 1 degree.
- get_swath_width(height: float) float[source]
Gets the instrument swath width projected to the Earth’s surface: the cross-track extent of the scanned arc, assuming a spherical Earth.
- is_in_field_of_view(orbit_track: Geocentric, target: GeographicPosition) ndarray[tuple[int, ...], dtype[bool]][source]
Determines if a target lies within the instantaneous footprint: if it crosses the cone within the scan sector as the satellite moves along track by the distance subtended at nadir by the along-track field of view (linearly interpolating its cone angle and scan azimuth between the start, middle, and end of the motion). Does not check whether the target is above the satellite’s horizon.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity.
target (skyfield.toposlib.GeographicPosition) – The target position.
- Returns:
Array of indicators: True if the target is in the field of view.
- Return type:
numpy.typing.NDArray
Attitude
- pydantic model tatc.schemas.Attitude[source]
Attitude of a spacecraft’s body relative to its orbit. The body is rotated from the orbit’s nadir frame (its nadir axis and its along-track axis, aligned with the velocity in velocity_frame) first by the yaw angle about the nadir axis, then by the roll angle about the yawed along-track axis, then by the pitch angle about the rolled cross-track axis. Each angle is constant or, if its profile is given, varies with the satellite’s argument of latitude.
The instruments of a space system point relative to its body: their yaw, roll, and pitch angles, scan azimuths, and pixels are measured from the body’s axes. For example, a yaw angle of 180 degrees (flying backward) swaps the left and right of a cross-track scanner and the fore and aft of a conical scan. An instrument’s field of regard remains measured from nadir. The attitude is that of the body, shared by every instrument it carries; an instrument’s own angles (see PointedInstrument) orient it on the body, after the body’s rotation.
Show JSON schema
{ "title": "Attitude", "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "type": "object", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "$defs": { "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" } } }
- Fields:
blind_intervals (list[tuple[float, float]] | None)pitch_angle (float)pitch_angle_profile (list[tuple[float, float]] | None)roll_angle (float)roll_angle_profile (list[tuple[float, float]] | None)type (Literal['attitude'])velocity_frame (tatc.utils.projection.VelocityFrame)yaw_angle (float)yaw_angle_profile (list[tuple[float, float]] | None)
- Validators:
_validate_angle_profile»pitch_angle_profile_validate_angle_profile»roll_angle_profile_validate_angle_profile»yaw_angle_profile_validate_blind_intervals»blind_intervals
- field blind_intervals: list[tuple[float, float]] | None = None
Intervals of the satellite’s argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system’s instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see Instrument.is_valid_observation).
- Constraints:
min_length = 1
- Validated by:
_validate_blind_intervals
- field pitch_angle: float = 0
Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.
- Constraints:
ge = -180
le = 180
- field pitch_angle_profile: list[tuple[float, float]] | None = None
Pitch angle (degrees) as a function of the satellite’s argument of latitude (see yaw_angle_profile). If given, it overrides pitch_angle.
- Constraints:
min_length = 1
- Validated by:
_validate_angle_profile
- field roll_angle: float = 0
Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.
- Constraints:
ge = -180
le = 180
- field roll_angle_profile: list[tuple[float, float]] | None = None
Roll angle (degrees) as a function of the satellite’s argument of latitude (see yaw_angle_profile), for example the roll steering of a synthetic aperture radar. If given, it overrides roll_angle.
- Constraints:
min_length = 1
- Validated by:
_validate_angle_profile
- field type: Literal['attitude'] = 'attitude'
Attitude type discriminator.
- field velocity_frame: VelocityFrame = VelocityFrame.EARTH_FIXED
Reference frame of the velocity vector that defines the along-track axis (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).
- field yaw_angle: float = 0
Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).
- Constraints:
ge = -180
le = 180
- field yaw_angle_profile: list[tuple[float, float]] | None = None
Yaw angle (degrees) as a function of the satellite’s argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides yaw_angle.
- Constraints:
min_length = 1
- Validated by:
_validate_angle_profile
- get_angles(orbit_track: Geocentric) tuple[_Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], _Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]][source]
Gets the yaw, roll, and pitch angles (degrees) of the body at the satellite position(s) of an orbit track.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the yaw, roll, and pitch angles (degrees)
- Return type:
tuple[numpy.typing.ArrayLike, numpy.typing.ArrayLike, numpy.typing.ArrayLike]
- get_body_angles(orbit_track: Geocentric) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Gets the yaw, roll, and pitch angles (degrees) of the body and whether its along-track axis is aligned with the inertial velocity, at each time of an orbit track, as arrays with the shape of its times (as used by the projection utilities, see tatc.utils.projection._compute_nadir_axes).
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the yaw, roll, and pitch angles (degrees), and whether the velocity frame is inertial
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray]
- is_observing(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[bool]][source]
Gets whether the instruments observe at each time of an orbit track: whether the satellite’s argument of latitude lies outside the blind intervals.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
- True where the instruments observe, with the
shape of the times of the orbit track.
- Return type:
numpy.typing.NDArray
Target Attitude
- pydantic model tatc.schemas.TargetAttitude[source]
Attitude of a spacecraft’s body that points its nadir axis at ground targets, as for an agile satellite imaging sites or a target mode: at each time, at the target closest to nadir (with the smallest off-nadir angle) among those within max_off_nadir_angle of nadir and above the horizon, and otherwise along nadir. The body is rotated by the yaw angle about the nadir axis and then by the roll and pitch angles that point its nadir axis at the target (see tatc.utils.compute_view_angles), so that its along-track axis stays close to the direction of motion. The body turns instantly between targets and nadir (slews are not modeled).
The fields of regard of its instruments (measured from nadir) should include the off-nadir angles at which the body points. As an instrument’s view stays on a target while the body points at it, the epoch of an observation of the target is a time while the body points at it (rather than the time a view sweeps over it).
Show JSON schema
{ "title": "TargetAttitude", "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "type": "object", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "$defs": { "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "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" } }, "required": [ "targets" ] }
- Fields:
max_off_nadir_angle (float)targets (list[tatc.schemas.surface.point.Point])type (Literal['target'])velocity_frame (tatc.utils.projection.VelocityFrame)yaw_angle (float)
- field max_off_nadir_angle: float = 30
Maximum angle (degrees) from nadir at which the body points at a target.
- Constraints:
gt = 0
lt = 90
- field targets: list[Point] [Required]
The ground targets at which to point.
- Constraints:
min_length = 1
- field type: Literal['target'] = 'target'
Attitude type discriminator.
- field velocity_frame: VelocityFrame = VelocityFrame.EARTH_FIXED
Reference frame of the velocity vector that defines the along-track axis (see Attitude.velocity_frame).
- field yaw_angle: float = 0
Rotation (degrees) of the body about the nadir axis before pointing (see Attitude.yaw_angle).
- Constraints:
ge = -180
le = 180
- get_body_angles(orbit_track: Geocentric) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Gets the yaw, roll, and pitch angles (degrees) of the body and whether its velocity frame is inertial, at each time of an orbit track (see Attitude.get_body_angles): the roll and pitch angles that point its nadir axis at the target of each time (see get_target_index), or zero.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the yaw, roll, and pitch angles (degrees), and whether the velocity frame is inertial
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray]
- get_target_index(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[_ScalarType_co]][source]
Gets the index of the target at which the body points at each time of an orbit track, or -1 if it points along nadir.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
- the target indices, with the shape of the
orbit track’s times
- Return type:
numpy.typing.NDArray
- is_observing(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[bool]][source]
Gets whether the instruments observe at each time of an orbit track (see Attitude.is_observing): always.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
- True, with the shape of the times of the
orbit track.
- Return type:
numpy.typing.NDArray
Glint Attitude
- pydantic model tatc.schemas.GlintAttitude[source]
Attitude of a spacecraft’s body that points its nadir axis at the sun glint (the specular point, see tatc.utils.compute_specular_point), as for the glint mode of a greenhouse gas sounder observing the ocean: at each time, toward the specular point, or short of it toward nadir by an offset angle (in the plane of the nadir axis and the line of sight to the specular point), while the Sun is at least min_solar_elevation above the horizon at the specular point (equal to the satellite’s elevation angle seen from it) and the body points within max_off_nadir_angle of nadir, and otherwise along nadir. The body is rotated by the yaw angle about the nadir axis and then by the roll and pitch angles that point its nadir axis (see tatc.utils.compute_view_angles), which follows the glint as it moves with the satellite and the Sun.
The fields of regard of its instruments (measured from nadir) should include the off-nadir angles at which the body points.
Show JSON schema
{ "title": "GlintAttitude", "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "type": "object", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "$defs": { "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" } } }
- Fields:
max_off_nadir_angle (float)min_solar_elevation (float)offset_angle (float)offset_angle_profile (list[tuple[float, float]] | None)type (Literal['glint'])velocity_frame (tatc.utils.projection.VelocityFrame)yaw_angle (float)
- Validators:
_validate_offset_angle_profile»offset_angle_profile
- field max_off_nadir_angle: float = 60
Maximum angle (degrees) from nadir at which the body points toward the glint.
- Constraints:
gt = 0
lt = 90
- field min_solar_elevation: float = 0
Minimum solar elevation angle (degrees) at the specular point at which the body points at it.
- Constraints:
ge = 0
lt = 90
- field offset_angle: float = 0
Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.
- Constraints:
ge = 0
lt = 90
- field offset_angle_profile: list[tuple[float, float]] | None = None
Offset angle (degrees, see offset_angle) as a function of the specular point’s angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides offset_angle.
- Constraints:
min_length = 1
- Validated by:
_validate_offset_angle_profile
- field type: Literal['glint'] = 'glint'
Attitude type discriminator.
- field velocity_frame: VelocityFrame = VelocityFrame.EARTH_FIXED
Reference frame of the velocity vector that defines the along-track axis (see Attitude.velocity_frame).
- field yaw_angle: float = 0
Rotation (degrees) of the body about the nadir axis before pointing (see Attitude.yaw_angle).
- Constraints:
ge = -180
le = 180
- get_aim_point(orbit_track: Geocentric) GeographicPosition[source]
Gets the point on the WGS 84 ellipsoid at which the body points at each time of an orbit track: the specular point, or the point short of it toward nadir by the offset angle, where the criteria are met, or NaN where the body points along nadir.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the aim points.
- Return type:
skyfield.toposlib.GeographicPosition
- get_body_angles(orbit_track: Geocentric) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Gets the yaw, roll, and pitch angles (degrees) of the body and whether its velocity frame is inertial, at each time of an orbit track (see Attitude.get_body_angles): the roll and pitch angles that point its nadir axis at the aim point (see get_aim_point), or zero.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the yaw, roll, and pitch angles (degrees), and whether the velocity frame is inertial
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray]
- get_offset_angle(off_nadir_angle: _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]
Gets the offset angle (degrees) toward nadir for specular points at angles (degrees) from nadir (see offset_angle_profile).
- Parameters:
off_nadir_angle (numpy.typing.ArrayLike) – The specular points’ angles from nadir (degrees).
- Returns:
the offset angles (degrees).
- Return type:
numpy.typing.NDArray
- is_observing(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[bool]][source]
Gets whether the instruments observe at each time of an orbit track (see Attitude.is_observing): always.
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
- True, with the shape of the times of the
orbit track.
- Return type:
numpy.typing.NDArray
Attitude Schedule
- pydantic model tatc.schemas.AttitudeSchedule[source]
Schedule of attitudes over time: each segment’s attitude applies from its start until the start of the next segment, and the first segment’s attitude also applies before its start. For example, a satellite that periodically flips to fly backward (yaw 180 degrees) and forward, or that alternates between observing modes.
Show JSON schema
{ "title": "AttitudeSchedule", "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "type": "object", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "type": "object" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "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" } }, "required": [ "segments" ] }
- Fields:
segments (list[tatc.schemas.attitude.AttitudeSegment])type (Literal['schedule'])
- Validators:
_sort_segments»segments
- field segments: list[AttitudeSegment] [Required]
The segments, each with a start time and an attitude.
- Constraints:
min_length = 1
- Validated by:
_sort_segments
- field type: Literal['schedule'] = 'schedule'
Attitude type discriminator.
- classmethod from_attitudes(starts: list[datetime], attitudes: list[Attitude | TargetAttitude | GlintAttitude]) AttitudeSchedule[source]
Creates a schedule from the start times and attitudes of its segments.
- Parameters:
starts (list[datetime.datetime]) – The start times (timezone-aware).
attitudes (list[Attitude | TargetAttitude | GlintAttitude]) – The attitude of each segment.
- Returns:
the schedule
- Return type:
- get_attitude(time: datetime) Attitude | TargetAttitude | GlintAttitude[source]
Gets the attitude that applies at a time.
- Parameters:
time (datetime.datetime) – The time (timezone-aware).
- Returns:
the attitude
- Return type:
- get_body_angles(orbit_track: Geocentric) tuple[ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]], ndarray[tuple[int, ...], dtype[_ScalarType_co]]][source]
Gets the yaw, roll, and pitch angles (degrees) of the body and whether its velocity frame is inertial, at each time of an orbit track, from the attitude of the segment in which each time lies (see Attitude.get_body_angles).
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
the yaw, roll, and pitch angles (degrees), and whether the velocity frame is inertial
- Return type:
tuple[numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray, numpy.typing.NDArray]
- is_observing(orbit_track: Geocentric) ndarray[tuple[int, ...], dtype[bool]][source]
Gets whether the instruments observe at each time of an orbit track, from the attitude of the segment in which each time lies (see Attitude.is_observing).
- Parameters:
orbit_track (skyfield.positionlib.Geocentric) – The satellite position/velocity (in an inertial frame).
- Returns:
- True where the instruments observe, with the
shape of the times of the orbit track.
- Return type:
numpy.typing.NDArray
- pydantic model tatc.schemas.AttitudeSegment[source]
An attitude that applies from a start time (until the start of the next segment of a schedule).
Show JSON schema
{ "title": "AttitudeSegment", "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "type": "object", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "type": "object" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "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" } }, "required": [ "start", "attitude" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude)start (pydantic.types.AwareDatetime)
- field attitude: ScheduledAttitudes [Required]
The attitude.
- field start: AwareDatetime [Required]
Time (timezone-aware) from which the attitude applies.
Satellite
- pydantic model tatc.schemas.Satellite[source]
Single satellite.
Show JSON schema
{ "title": "Satellite", "description": "Single satellite.", "type": "object", "properties": { "name": { "description": "Space system name.", "examples": [ "International Space Station" ], "title": "Name", "type": "string" }, "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 assigned instruments.", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "attitude": { "anyOf": [ { "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "schedule": "#/$defs/AttitudeSchedule", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" }, { "$ref": "#/$defs/AttitudeSchedule" } ] }, { "type": "null" } ], "default": null, "description": "Attitude of the spacecraft's body (or a schedule of attitudes), from which the views of its instruments are rotated, or `None` for a body aligned with the nadir frame (each instrument's `velocity_frame` then orients it).", "title": "Attitude" }, "type": { "const": "satellite", "default": "satellite", "description": "Space system type discriminator.", "title": "Type", "type": "string" }, "orbit": { "anyOf": [ { "$ref": "#/$defs/CircularOrbit" }, { "$ref": "#/$defs/GeneralPerturbationsOrbit" }, { "$ref": "#/$defs/GeosynchronousOrbit" }, { "$ref": "#/$defs/KeplerianOrbit" }, { "$ref": "#/$defs/MolniyaOrbit" }, { "$ref": "#/$defs/SunSynchronousOrbit" }, { "$ref": "#/$defs/TundraOrbit" }, { "$ref": "#/$defs/TwoLineElements" } ], "description": "Orbit specification.", "title": "Orbit" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSchedule": { "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "required": [ "segments" ], "title": "AttitudeSchedule", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "CircularOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion -- circular motion case.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "circular", "default": "circular", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" } }, "required": [ "mean_altitude" ], "title": "CircularOrbit", "type": "object" }, "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" }, "GeneralPerturbationsElements": { "description": "General perturbations orbital elements for a satellite.", "properties": { "object_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object name.", "title": "Object Name" }, "epoch": { "description": "Epoch.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_motion": { "description": "Mean motion (degrees/second).", "exclusiveMinimum": 0, "title": "Mean Motion", "type": "number" }, "eccentricity": { "description": "Eccentricity.", "maximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "inclination": { "description": "Inclination (degrees).", "maximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "ra_of_asc_node": { "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Ra Of Asc Node", "type": "number" }, "arg_of_pericenter": { "description": "Argument of pericenter (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Arg Of Pericenter", "type": "number" }, "mean_anomaly": { "description": "Mean anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Mean Anomaly", "type": "number" }, "norad_cat_id": { "default": 0, "description": "NORAD catalog identifier.", "minimum": 0, "title": "Norad Cat Id", "type": "integer" }, "bstar": { "default": 0, "description": "Starred ballistic coefficient.", "title": "Bstar", "type": "number" }, "mean_motion_dot": { "default": 0, "description": "First derivative of mean motion (degrees/second^2).", "title": "Mean Motion Dot", "type": "number" }, "mean_motion_ddot": { "default": 0, "description": "Second derivative of mean motion (degrees/second^3).", "title": "Mean Motion Ddot", "type": "number" }, "classification": { "default": "U", "description": "Classification type.", "title": "Classification", "type": "string" }, "international_designator": { "default": "00000A", "description": "International designator.", "title": "International Designator", "type": "string" }, "ephemeris_type": { "default": 0, "description": "Ephemeris type.", "title": "Ephemeris Type", "type": "integer" }, "element_set_num": { "default": 0, "description": "Element set number.", "title": "Element Set Num", "type": "integer" }, "revolution_num": { "default": 0, "description": "Revolution number at epoch.", "title": "Revolution Num", "type": "integer" } }, "required": [ "epoch", "mean_motion", "eccentricity", "inclination", "ra_of_asc_node", "arg_of_pericenter", "mean_anomaly" ], "title": "GeneralPerturbationsElements", "type": "object" }, "GeneralPerturbationsOrbit": { "description": "Orbit defined with general perturbations (GP) elements.\n\nThe orbit is propagated with SGP4, using whichever element's epoch is\nclosest to each time, or, if `element_switch_times` are given, the\nelement between the switches before and after each time (see\n`get_element_index`). Optionally (with `repeat_cycle` and `remove_drag`),\nit is propagated as an orbit maintained against drag on a repeat ground\ntrack, which SGP4 does not model: if the orbit declares a repeat cycle or\none is found (see `GeneralPerturbationsElements.get_repeat_cycle`), times\nbefore the first element's epoch and after the last element's epoch are\ninstead propagated with that element maintained on its repeat ground\ntrack and repeated with its repeat cycle (see `get_repeat_element`). For\nan orbit with a single element, this applies to all times.", "properties": { "type": { "const": "gp", "default": "gp", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "elements": { "description": "General perturbations elements.", "items": { "$ref": "#/$defs/GeneralPerturbationsElements" }, "minItems": 1, "title": "Elements", "type": "array" }, "remove_drag": { "default": false, "description": "True, to propagate the orbit without drag, as for an orbit maintained against drag: the elements' drag terms (B* and the derivatives of mean motion) are ignored, while the Earth's oblateness (and, for deep-space orbits, the Moon and Sun) still perturb the orbit.", "title": "Remove Drag", "type": "boolean" }, "repeat_cycle": { "anyOf": [ { "format": "duration", "type": "string" }, { "const": "auto", "type": "string" }, { "type": "null" } ], "default": null, "description": "Repeat cycle with which the orbit is propagated as maintained on a repeat ground track: None (the default), to propagate the elements directly; `auto`, to use the repeat cycle found from the elements, if any (see `GeneralPerturbationsElements.get_repeat_cycle`); or a duration, to declare the repeat cycle (for example, 91 days, which is refined to the nearest whole number of nodal days, or for a sun-synchronous orbit mean solar days, of the elements maintained on the repeat ground track; see `GeneralPerturbationsElements.get_repeat_element`). A repeat cycle requires `remove_drag`, as the orbit is maintained against drag.", "title": "Repeat Cycle" }, "element_switch_times": { "anyOf": [ { "items": { "format": "date-time", "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Times at which propagation switches from each element (sorted by epoch) to the next, one fewer than the elements, each between the epochs of the elements before and after it: element k is used from switch k - 1 until switch k. None (the default) switches midway between consecutive epochs, using the element whose epoch is closest to each time. Common switch times keep satellites whose elements are published at slightly different times (as in a formation) on elements of the same epochs; see `tatc.utils.align_element_switches`.", "title": "Element Switch Times" } }, "required": [ "elements" ], "title": "GeneralPerturbationsOrbit", "type": "object" }, "GeosynchronousOrbit": { "description": "Orbit defined by geosynchronous parameters: a fixed longitude rather\nthan a right ascension of ascending node.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "default": 35793160.85267107, "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "geosynchronous", "default": "geosynchronous", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) of the sub-satellite point in the WGS 84 coordinate system.", "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" } }, "required": [ "longitude" ], "title": "GeosynchronousOrbit", "type": "object" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "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" }, "KeplerianOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "keplerian", "default": "keplerian", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "semimajor_axis": { "description": "Semimajor axis (meters).", "exclusiveMinimum": 0, "title": "Semimajor Axis", "type": "number" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "eccentricity": { "default": 0, "description": "Eccentricity.", "exclusiveMaximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "perigee_argument": { "default": 0, "description": "Perigee argument (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Perigee Argument", "type": "number" } }, "required": [ "semimajor_axis" ], "title": "KeplerianOrbit", "type": "object" }, "MolniyaOrbit": { "description": "Orbit defined by Molniya parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "molniya", "default": "molniya", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "MolniyaOrbit", "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" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "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" }, "SunSynchronousOrbit": { "description": "Orbit defined by sun synchronous parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "exclusiveMaximum": 5980991.228584941, "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "sso", "default": "sso", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "equator_crossing_time": { "description": "Equator crossing time (local solar time).", "format": "time", "title": "Equator Crossing Time", "type": "string" }, "equator_crossing_ascending": { "default": true, "description": "True, if the equator crossing time is ascending (south-to-north).", "title": "Equator Crossing Ascending", "type": "boolean" } }, "required": [ "mean_altitude", "equator_crossing_time" ], "title": "SunSynchronousOrbit", "type": "object" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "type": "object" }, "TundraOrbit": { "description": "Orbit defined by Tundra parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "tundra", "default": "tundra", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "TundraOrbit", "type": "object" }, "TwoLineElements": { "description": "Orbit defined by two line elements (TLE).", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "tle", "default": "tle", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "tle": { "description": "The two TLE lines.", "examples": [ [ "1 25544U 98067A 21156.30527927 .00003432 00000-0 70541-4 0 9993", "2 25544 51.6455 41.4969 0003508 68.0432 78.3395 15.48957534286754" ] ], "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "title": "Tle", "type": "array" } }, "required": [ "tle" ], "title": "TwoLineElements", "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": [ "name", "orbit" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude | tatc.schemas.attitude.AttitudeSchedule | None)instruments (list[tatc.schemas.instrument.simple.Instrument | tatc.schemas.instrument.pointed.PointedInstrument | tatc.schemas.instrument.conical.ConicalInstrument])name (str)orbit (tatc.schemas.orbit.circular.CircularOrbit | tatc.schemas.orbit.gp.GeneralPerturbationsOrbit | tatc.schemas.orbit.geosynchronous.GeosynchronousOrbit | tatc.schemas.orbit.keplerian.KeplerianOrbit | tatc.schemas.orbit.molniya.MolniyaOrbit | tatc.schemas.orbit.sun_synchronous.SunSynchronousOrbit | tatc.schemas.orbit.tundra.TundraOrbit | tatc.schemas.orbit.two_line_elements.TwoLineElements)type (Literal['satellite'])
- Validators:
_check_velocity_frames»all fields
- field attitude: AllAttitudes | None = None
Attitude of the spacecraft’s body (or a schedule of attitudes), from which the views of its instruments are rotated, or None for a body aligned with the nadir frame (each instrument’s velocity_frame then orients it).
- Validated by:
_check_velocity_frames
- 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 assigned instruments.
- Constraints:
min_length = 1
- Validated by:
_check_velocity_frames
- field orbit: AllOrbits [Required]
Orbit specification.
- Validated by:
_check_velocity_frames
- field type: Literal['satellite'] = 'satellite'
Space system type discriminator.
- Validated by:
_check_velocity_frames
- get_instrument(index: int = 0) Instrument
Gets an instrument carried by this space system, with its views rotated from the axes of the body in its attitude (see Instrument.bind_attitude).
- Parameters:
index (int) – The index of the instrument.
- Returns:
the instrument
- Return type:
Train Constellation
- pydantic model tatc.schemas.TrainConstellation[source]
A constellation that arranges member satellites in sequence.
Show JSON schema
{ "title": "TrainConstellation", "description": "A constellation that arranges member satellites in sequence.", "type": "object", "properties": { "name": { "description": "Space system name.", "examples": [ "International Space Station" ], "title": "Name", "type": "string" }, "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 assigned instruments.", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "attitude": { "anyOf": [ { "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "schedule": "#/$defs/AttitudeSchedule", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" }, { "$ref": "#/$defs/AttitudeSchedule" } ] }, { "type": "null" } ], "default": null, "description": "Attitude of the spacecraft's body (or a schedule of attitudes), from which the views of its instruments are rotated, or `None` for a body aligned with the nadir frame (each instrument's `velocity_frame` then orients it).", "title": "Attitude" }, "type": { "const": "train", "default": "train", "description": "Space system type discriminator.", "title": "Type", "type": "string" }, "orbit": { "anyOf": [ { "$ref": "#/$defs/CircularOrbit" }, { "$ref": "#/$defs/GeneralPerturbationsOrbit" }, { "$ref": "#/$defs/GeosynchronousOrbit" }, { "$ref": "#/$defs/KeplerianOrbit" }, { "$ref": "#/$defs/MolniyaOrbit" }, { "$ref": "#/$defs/SunSynchronousOrbit" }, { "$ref": "#/$defs/TundraOrbit" }, { "$ref": "#/$defs/TwoLineElements" } ], "description": "Lead orbit for this constellation.", "title": "Orbit" }, "number_satellites": { "default": 1, "description": "The count of the number of satellites.", "minimum": 1, "title": "Number Satellites", "type": "integer" }, "interval": { "description": "The local time interval between satellites in a train constellation.", "format": "duration", "title": "Interval", "type": "string" }, "repeat_ground_track": { "default": true, "description": "True, if the train satellites should repeat the same ground track.", "title": "Repeat Ground Track", "type": "boolean" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSchedule": { "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "required": [ "segments" ], "title": "AttitudeSchedule", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "CircularOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion -- circular motion case.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "circular", "default": "circular", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" } }, "required": [ "mean_altitude" ], "title": "CircularOrbit", "type": "object" }, "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" }, "GeneralPerturbationsElements": { "description": "General perturbations orbital elements for a satellite.", "properties": { "object_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object name.", "title": "Object Name" }, "epoch": { "description": "Epoch.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_motion": { "description": "Mean motion (degrees/second).", "exclusiveMinimum": 0, "title": "Mean Motion", "type": "number" }, "eccentricity": { "description": "Eccentricity.", "maximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "inclination": { "description": "Inclination (degrees).", "maximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "ra_of_asc_node": { "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Ra Of Asc Node", "type": "number" }, "arg_of_pericenter": { "description": "Argument of pericenter (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Arg Of Pericenter", "type": "number" }, "mean_anomaly": { "description": "Mean anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Mean Anomaly", "type": "number" }, "norad_cat_id": { "default": 0, "description": "NORAD catalog identifier.", "minimum": 0, "title": "Norad Cat Id", "type": "integer" }, "bstar": { "default": 0, "description": "Starred ballistic coefficient.", "title": "Bstar", "type": "number" }, "mean_motion_dot": { "default": 0, "description": "First derivative of mean motion (degrees/second^2).", "title": "Mean Motion Dot", "type": "number" }, "mean_motion_ddot": { "default": 0, "description": "Second derivative of mean motion (degrees/second^3).", "title": "Mean Motion Ddot", "type": "number" }, "classification": { "default": "U", "description": "Classification type.", "title": "Classification", "type": "string" }, "international_designator": { "default": "00000A", "description": "International designator.", "title": "International Designator", "type": "string" }, "ephemeris_type": { "default": 0, "description": "Ephemeris type.", "title": "Ephemeris Type", "type": "integer" }, "element_set_num": { "default": 0, "description": "Element set number.", "title": "Element Set Num", "type": "integer" }, "revolution_num": { "default": 0, "description": "Revolution number at epoch.", "title": "Revolution Num", "type": "integer" } }, "required": [ "epoch", "mean_motion", "eccentricity", "inclination", "ra_of_asc_node", "arg_of_pericenter", "mean_anomaly" ], "title": "GeneralPerturbationsElements", "type": "object" }, "GeneralPerturbationsOrbit": { "description": "Orbit defined with general perturbations (GP) elements.\n\nThe orbit is propagated with SGP4, using whichever element's epoch is\nclosest to each time, or, if `element_switch_times` are given, the\nelement between the switches before and after each time (see\n`get_element_index`). Optionally (with `repeat_cycle` and `remove_drag`),\nit is propagated as an orbit maintained against drag on a repeat ground\ntrack, which SGP4 does not model: if the orbit declares a repeat cycle or\none is found (see `GeneralPerturbationsElements.get_repeat_cycle`), times\nbefore the first element's epoch and after the last element's epoch are\ninstead propagated with that element maintained on its repeat ground\ntrack and repeated with its repeat cycle (see `get_repeat_element`). For\nan orbit with a single element, this applies to all times.", "properties": { "type": { "const": "gp", "default": "gp", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "elements": { "description": "General perturbations elements.", "items": { "$ref": "#/$defs/GeneralPerturbationsElements" }, "minItems": 1, "title": "Elements", "type": "array" }, "remove_drag": { "default": false, "description": "True, to propagate the orbit without drag, as for an orbit maintained against drag: the elements' drag terms (B* and the derivatives of mean motion) are ignored, while the Earth's oblateness (and, for deep-space orbits, the Moon and Sun) still perturb the orbit.", "title": "Remove Drag", "type": "boolean" }, "repeat_cycle": { "anyOf": [ { "format": "duration", "type": "string" }, { "const": "auto", "type": "string" }, { "type": "null" } ], "default": null, "description": "Repeat cycle with which the orbit is propagated as maintained on a repeat ground track: None (the default), to propagate the elements directly; `auto`, to use the repeat cycle found from the elements, if any (see `GeneralPerturbationsElements.get_repeat_cycle`); or a duration, to declare the repeat cycle (for example, 91 days, which is refined to the nearest whole number of nodal days, or for a sun-synchronous orbit mean solar days, of the elements maintained on the repeat ground track; see `GeneralPerturbationsElements.get_repeat_element`). A repeat cycle requires `remove_drag`, as the orbit is maintained against drag.", "title": "Repeat Cycle" }, "element_switch_times": { "anyOf": [ { "items": { "format": "date-time", "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Times at which propagation switches from each element (sorted by epoch) to the next, one fewer than the elements, each between the epochs of the elements before and after it: element k is used from switch k - 1 until switch k. None (the default) switches midway between consecutive epochs, using the element whose epoch is closest to each time. Common switch times keep satellites whose elements are published at slightly different times (as in a formation) on elements of the same epochs; see `tatc.utils.align_element_switches`.", "title": "Element Switch Times" } }, "required": [ "elements" ], "title": "GeneralPerturbationsOrbit", "type": "object" }, "GeosynchronousOrbit": { "description": "Orbit defined by geosynchronous parameters: a fixed longitude rather\nthan a right ascension of ascending node.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "default": 35793160.85267107, "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "geosynchronous", "default": "geosynchronous", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) of the sub-satellite point in the WGS 84 coordinate system.", "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" } }, "required": [ "longitude" ], "title": "GeosynchronousOrbit", "type": "object" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "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" }, "KeplerianOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "keplerian", "default": "keplerian", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "semimajor_axis": { "description": "Semimajor axis (meters).", "exclusiveMinimum": 0, "title": "Semimajor Axis", "type": "number" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "eccentricity": { "default": 0, "description": "Eccentricity.", "exclusiveMaximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "perigee_argument": { "default": 0, "description": "Perigee argument (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Perigee Argument", "type": "number" } }, "required": [ "semimajor_axis" ], "title": "KeplerianOrbit", "type": "object" }, "MolniyaOrbit": { "description": "Orbit defined by Molniya parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "molniya", "default": "molniya", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "MolniyaOrbit", "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" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "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" }, "SunSynchronousOrbit": { "description": "Orbit defined by sun synchronous parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "exclusiveMaximum": 5980991.228584941, "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "sso", "default": "sso", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "equator_crossing_time": { "description": "Equator crossing time (local solar time).", "format": "time", "title": "Equator Crossing Time", "type": "string" }, "equator_crossing_ascending": { "default": true, "description": "True, if the equator crossing time is ascending (south-to-north).", "title": "Equator Crossing Ascending", "type": "boolean" } }, "required": [ "mean_altitude", "equator_crossing_time" ], "title": "SunSynchronousOrbit", "type": "object" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "type": "object" }, "TundraOrbit": { "description": "Orbit defined by Tundra parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "tundra", "default": "tundra", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "TundraOrbit", "type": "object" }, "TwoLineElements": { "description": "Orbit defined by two line elements (TLE).", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "tle", "default": "tle", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "tle": { "description": "The two TLE lines.", "examples": [ [ "1 25544U 98067A 21156.30527927 .00003432 00000-0 70541-4 0 9993", "2 25544 51.6455 41.4969 0003508 68.0432 78.3395 15.48957534286754" ] ], "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "title": "Tle", "type": "array" } }, "required": [ "tle" ], "title": "TwoLineElements", "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": [ "name", "orbit", "interval" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude | tatc.schemas.attitude.AttitudeSchedule | None)instruments (list[tatc.schemas.instrument.simple.Instrument | tatc.schemas.instrument.pointed.PointedInstrument | tatc.schemas.instrument.conical.ConicalInstrument])interval (datetime.timedelta)name (str)number_satellites (int)orbit (tatc.schemas.orbit.circular.CircularOrbit | tatc.schemas.orbit.gp.GeneralPerturbationsOrbit | tatc.schemas.orbit.geosynchronous.GeosynchronousOrbit | tatc.schemas.orbit.keplerian.KeplerianOrbit | tatc.schemas.orbit.molniya.MolniyaOrbit | tatc.schemas.orbit.sun_synchronous.SunSynchronousOrbit | tatc.schemas.orbit.tundra.TundraOrbit | tatc.schemas.orbit.two_line_elements.TwoLineElements)repeat_ground_track (bool)type (Literal['train'])
- Validators:
_check_velocity_frames»all fields
- field attitude: AllAttitudes | None = None
Attitude of the spacecraft’s body (or a schedule of attitudes), from which the views of its instruments are rotated, or None for a body aligned with the nadir frame (each instrument’s velocity_frame then orients it).
- Validated by:
_check_velocity_frames
- 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 assigned instruments.
- Constraints:
min_length = 1
- Validated by:
_check_velocity_frames
- field interval: timedelta [Required]
The local time interval between satellites in a train constellation.
- Validated by:
_check_velocity_frames
- field number_satellites: int = 1
The count of the number of satellites.
- Constraints:
ge = 1
- Validated by:
_check_velocity_frames
- field orbit: AllOrbits [Required]
Lead orbit for this constellation.
- Validated by:
_check_velocity_frames
- field repeat_ground_track: bool = True
True, if the train satellites should repeat the same ground track.
- Validated by:
_check_velocity_frames
- field type: Literal['train'] = 'train'
Space system type discriminator.
- Validated by:
_check_velocity_frames
- get_delta_mean_anomaly() float[source]
Gets the difference in mean anomaly (decimal degrees) for adjacent member satellites: each trails the one ahead of it along the orbit by the interval, at the lead orbit’s propagated rate.
- Returns:
the difference in mean anomaly
- Return type:
- get_delta_raan() float[source]
Gets the difference in right ascension of ascending node (decimal degrees) for adjacent member satellites. When repeating the ground track, each satellite occupies, in the Earth-fixed frame, the position of the one ahead of it one interval earlier: its ascending node is shifted by the Earth’s rotation (relative to inertial space, i.e. the sidereal day) during the interval, less the precession of the orbit plane during the interval. (For a sun-synchronous orbit, an interval of whole days therefore keeps the satellites in the same plane.)
- Returns:
the difference in right ascension of ascending node
- Return type:
- get_instrument(index: int = 0) Instrument
Gets an instrument carried by this space system, with its views rotated from the axes of the body in its attitude (see Instrument.bind_attitude).
- Parameters:
index (int) – The index of the instrument.
- Returns:
the instrument
- Return type:
Walker Configuration
Walker Constellation
- pydantic model tatc.schemas.WalkerConstellation[source]
A constellation that arranges member satellites following the Walker pattern.
Show JSON schema
{ "title": "WalkerConstellation", "description": "A constellation that arranges member satellites following the Walker pattern.", "type": "object", "properties": { "name": { "description": "Space system name.", "examples": [ "International Space Station" ], "title": "Name", "type": "string" }, "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 assigned instruments.", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "attitude": { "anyOf": [ { "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "schedule": "#/$defs/AttitudeSchedule", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" }, { "$ref": "#/$defs/AttitudeSchedule" } ] }, { "type": "null" } ], "default": null, "description": "Attitude of the spacecraft's body (or a schedule of attitudes), from which the views of its instruments are rotated, or `None` for a body aligned with the nadir frame (each instrument's `velocity_frame` then orients it).", "title": "Attitude" }, "type": { "const": "walker", "default": "walker", "description": "Space system type discriminator.", "title": "Type", "type": "string" }, "configuration": { "$ref": "#/$defs/WalkerConfiguration", "default": "delta", "description": "Walker configuration." }, "orbit": { "anyOf": [ { "$ref": "#/$defs/CircularOrbit" }, { "$ref": "#/$defs/GeneralPerturbationsOrbit" }, { "$ref": "#/$defs/GeosynchronousOrbit" }, { "$ref": "#/$defs/KeplerianOrbit" }, { "$ref": "#/$defs/MolniyaOrbit" }, { "$ref": "#/$defs/SunSynchronousOrbit" }, { "$ref": "#/$defs/TundraOrbit" }, { "$ref": "#/$defs/TwoLineElements" } ], "description": "Lead orbit for this constellation.", "title": "Orbit" }, "number_satellites": { "default": 1, "description": "Number of satellites in the constellation.", "minimum": 1, "title": "Number Satellites", "type": "integer" }, "number_planes": { "default": 1, "description": "The number of equally-spaced planes in a Walker Delta constellation. Ranges from 1 to (number of satellites).", "minimum": 1, "title": "Number Planes", "type": "integer" }, "relative_spacing": { "default": 0, "description": "Relative spacing of satellites between planes for a Walker Delta constellation. Ranges from 0 for equal mean anomaly to (number of planes) - 1. For example, `relative_spacing=1` means the mean anomaly is shifted by `360/number_satellites` between adjacent planes.", "minimum": 0, "title": "Relative Spacing", "type": "integer" }, "seam_spacing": { "anyOf": [ { "exclusiveMaximum": 180, "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Difference in right ascension of ascending node (degrees) across the seam of a Walker star constellation, where the ascending sides of the last plane face the descending sides of the first plane (180 degrees from its ascending node). The other adjacent planes are spaced (180 - seam_spacing) / (number_planes - 1) degrees apart. None (default) spaces all planes equally (180 / number_planes degrees, including across the seam). Satellites moving in opposite directions across the seam cover a narrower street than those in adjacent planes moving in the same direction, so continuous coverage designs such as Iridium's (six planes 31.6 degrees apart with a 22 degree seam) use a narrower seam.", "title": "Seam Spacing" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSchedule": { "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "required": [ "segments" ], "title": "AttitudeSchedule", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "CircularOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion -- circular motion case.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "circular", "default": "circular", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" } }, "required": [ "mean_altitude" ], "title": "CircularOrbit", "type": "object" }, "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" }, "GeneralPerturbationsElements": { "description": "General perturbations orbital elements for a satellite.", "properties": { "object_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object name.", "title": "Object Name" }, "epoch": { "description": "Epoch.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_motion": { "description": "Mean motion (degrees/second).", "exclusiveMinimum": 0, "title": "Mean Motion", "type": "number" }, "eccentricity": { "description": "Eccentricity.", "maximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "inclination": { "description": "Inclination (degrees).", "maximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "ra_of_asc_node": { "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Ra Of Asc Node", "type": "number" }, "arg_of_pericenter": { "description": "Argument of pericenter (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Arg Of Pericenter", "type": "number" }, "mean_anomaly": { "description": "Mean anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Mean Anomaly", "type": "number" }, "norad_cat_id": { "default": 0, "description": "NORAD catalog identifier.", "minimum": 0, "title": "Norad Cat Id", "type": "integer" }, "bstar": { "default": 0, "description": "Starred ballistic coefficient.", "title": "Bstar", "type": "number" }, "mean_motion_dot": { "default": 0, "description": "First derivative of mean motion (degrees/second^2).", "title": "Mean Motion Dot", "type": "number" }, "mean_motion_ddot": { "default": 0, "description": "Second derivative of mean motion (degrees/second^3).", "title": "Mean Motion Ddot", "type": "number" }, "classification": { "default": "U", "description": "Classification type.", "title": "Classification", "type": "string" }, "international_designator": { "default": "00000A", "description": "International designator.", "title": "International Designator", "type": "string" }, "ephemeris_type": { "default": 0, "description": "Ephemeris type.", "title": "Ephemeris Type", "type": "integer" }, "element_set_num": { "default": 0, "description": "Element set number.", "title": "Element Set Num", "type": "integer" }, "revolution_num": { "default": 0, "description": "Revolution number at epoch.", "title": "Revolution Num", "type": "integer" } }, "required": [ "epoch", "mean_motion", "eccentricity", "inclination", "ra_of_asc_node", "arg_of_pericenter", "mean_anomaly" ], "title": "GeneralPerturbationsElements", "type": "object" }, "GeneralPerturbationsOrbit": { "description": "Orbit defined with general perturbations (GP) elements.\n\nThe orbit is propagated with SGP4, using whichever element's epoch is\nclosest to each time, or, if `element_switch_times` are given, the\nelement between the switches before and after each time (see\n`get_element_index`). Optionally (with `repeat_cycle` and `remove_drag`),\nit is propagated as an orbit maintained against drag on a repeat ground\ntrack, which SGP4 does not model: if the orbit declares a repeat cycle or\none is found (see `GeneralPerturbationsElements.get_repeat_cycle`), times\nbefore the first element's epoch and after the last element's epoch are\ninstead propagated with that element maintained on its repeat ground\ntrack and repeated with its repeat cycle (see `get_repeat_element`). For\nan orbit with a single element, this applies to all times.", "properties": { "type": { "const": "gp", "default": "gp", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "elements": { "description": "General perturbations elements.", "items": { "$ref": "#/$defs/GeneralPerturbationsElements" }, "minItems": 1, "title": "Elements", "type": "array" }, "remove_drag": { "default": false, "description": "True, to propagate the orbit without drag, as for an orbit maintained against drag: the elements' drag terms (B* and the derivatives of mean motion) are ignored, while the Earth's oblateness (and, for deep-space orbits, the Moon and Sun) still perturb the orbit.", "title": "Remove Drag", "type": "boolean" }, "repeat_cycle": { "anyOf": [ { "format": "duration", "type": "string" }, { "const": "auto", "type": "string" }, { "type": "null" } ], "default": null, "description": "Repeat cycle with which the orbit is propagated as maintained on a repeat ground track: None (the default), to propagate the elements directly; `auto`, to use the repeat cycle found from the elements, if any (see `GeneralPerturbationsElements.get_repeat_cycle`); or a duration, to declare the repeat cycle (for example, 91 days, which is refined to the nearest whole number of nodal days, or for a sun-synchronous orbit mean solar days, of the elements maintained on the repeat ground track; see `GeneralPerturbationsElements.get_repeat_element`). A repeat cycle requires `remove_drag`, as the orbit is maintained against drag.", "title": "Repeat Cycle" }, "element_switch_times": { "anyOf": [ { "items": { "format": "date-time", "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Times at which propagation switches from each element (sorted by epoch) to the next, one fewer than the elements, each between the epochs of the elements before and after it: element k is used from switch k - 1 until switch k. None (the default) switches midway between consecutive epochs, using the element whose epoch is closest to each time. Common switch times keep satellites whose elements are published at slightly different times (as in a formation) on elements of the same epochs; see `tatc.utils.align_element_switches`.", "title": "Element Switch Times" } }, "required": [ "elements" ], "title": "GeneralPerturbationsOrbit", "type": "object" }, "GeosynchronousOrbit": { "description": "Orbit defined by geosynchronous parameters: a fixed longitude rather\nthan a right ascension of ascending node.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "default": 35793160.85267107, "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "geosynchronous", "default": "geosynchronous", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "longitude": { "description": "Longitude (decimal degrees) of the sub-satellite point in the WGS 84 coordinate system.", "maximum": 180, "minimum": -180, "title": "Longitude", "type": "number" } }, "required": [ "longitude" ], "title": "GeosynchronousOrbit", "type": "object" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "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" }, "KeplerianOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "keplerian", "default": "keplerian", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "semimajor_axis": { "description": "Semimajor axis (meters).", "exclusiveMinimum": 0, "title": "Semimajor Axis", "type": "number" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "eccentricity": { "default": 0, "description": "Eccentricity.", "exclusiveMaximum": 1, "minimum": 0, "title": "Eccentricity", "type": "number" }, "perigee_argument": { "default": 0, "description": "Perigee argument (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Perigee Argument", "type": "number" } }, "required": [ "semimajor_axis" ], "title": "KeplerianOrbit", "type": "object" }, "MolniyaOrbit": { "description": "Orbit defined by Molniya parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "molniya", "default": "molniya", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "MolniyaOrbit", "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" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "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" }, "SunSynchronousOrbit": { "description": "Orbit defined by sun synchronous parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "exclusiveMaximum": 5980991.228584941, "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "sso", "default": "sso", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "equator_crossing_time": { "description": "Equator crossing time (local solar time).", "format": "time", "title": "Equator Crossing Time", "type": "string" }, "equator_crossing_ascending": { "default": true, "description": "True, if the equator crossing time is ascending (south-to-north).", "title": "Equator Crossing Ascending", "type": "boolean" } }, "required": [ "mean_altitude", "equator_crossing_time" ], "title": "SunSynchronousOrbit", "type": "object" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "type": "object" }, "TundraOrbit": { "description": "Orbit defined by Tundra parameters.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "northern_coverage": { "default": true, "description": "True, if the orbit generates northern hemisphere coverage.", "title": "Northern Coverage", "type": "boolean" }, "perigee_altitude": { "description": "Perigee altitude (meters).", "minimum": 0, "title": "Perigee Altitude", "type": "number" }, "inclination": { "description": "Inclination (degrees). Defaults to the critical inclination (about 63.4 degrees), for which the argument of perigee is frozen; at other inclinations, the argument of perigee (and so the latitude of apogee) precesses as propagated.", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" }, "type": { "const": "tundra", "default": "tundra", "description": "Orbit type discriminator.", "title": "Type", "type": "string" } }, "required": [ "perigee_altitude" ], "title": "TundraOrbit", "type": "object" }, "TwoLineElements": { "description": "Orbit defined by two line elements (TLE).", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "type": { "const": "tle", "default": "tle", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "tle": { "description": "The two TLE lines.", "examples": [ [ "1 25544U 98067A 21156.30527927 .00003432 00000-0 70541-4 0 9993", "2 25544 51.6455 41.4969 0003508 68.0432 78.3395 15.48957534286754" ] ], "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "title": "Tle", "type": "array" } }, "required": [ "tle" ], "title": "TwoLineElements", "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" }, "WalkerConfiguration": { "description": "Enumeration of different Walker constellation configurations.", "enum": [ "delta", "star" ], "title": "WalkerConfiguration", "type": "string" } }, "required": [ "name", "orbit" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude | tatc.schemas.attitude.AttitudeSchedule | None)configuration (tatc.schemas.space.walker.WalkerConfiguration)instruments (list[tatc.schemas.instrument.simple.Instrument | tatc.schemas.instrument.pointed.PointedInstrument | tatc.schemas.instrument.conical.ConicalInstrument])name (str)number_planes (int)number_satellites (int)orbit (tatc.schemas.orbit.circular.CircularOrbit | tatc.schemas.orbit.gp.GeneralPerturbationsOrbit | tatc.schemas.orbit.geosynchronous.GeosynchronousOrbit | tatc.schemas.orbit.keplerian.KeplerianOrbit | tatc.schemas.orbit.molniya.MolniyaOrbit | tatc.schemas.orbit.sun_synchronous.SunSynchronousOrbit | tatc.schemas.orbit.tundra.TundraOrbit | tatc.schemas.orbit.two_line_elements.TwoLineElements)relative_spacing (int)seam_spacing (float | None)type (Literal['walker'])
- Validators:
_check_velocity_frames»all fieldsnumber_planes_le_number_satellites»all fieldsrelative_spacing_lt_number_planes»all fieldsseam_spacing_requires_star»all fields
- field attitude: AllAttitudes | None = None
Attitude of the spacecraft’s body (or a schedule of attitudes), from which the views of its instruments are rotated, or None for a body aligned with the nadir frame (each instrument’s velocity_frame then orients it).
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field configuration: WalkerConfiguration = WalkerConfiguration.DELTA
Walker configuration.
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- 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 assigned instruments.
- Constraints:
min_length = 1
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field name: str [Required]
Space system name.
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field number_planes: int = 1
The number of equally-spaced planes in a Walker Delta constellation. Ranges from 1 to (number of satellites).
- Constraints:
ge = 1
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field number_satellites: int = 1
Number of satellites in the constellation.
- Constraints:
ge = 1
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field orbit: AllOrbits [Required]
Lead orbit for this constellation.
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field relative_spacing: int = 0
Relative spacing of satellites between planes for a Walker Delta constellation. Ranges from 0 for equal mean anomaly to (number of planes) - 1. For example, relative_spacing=1 means the mean anomaly is shifted by 360/number_satellites between adjacent planes.
- Constraints:
ge = 0
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field seam_spacing: float | None = None
Difference in right ascension of ascending node (degrees) across the seam of a Walker star constellation, where the ascending sides of the last plane face the descending sides of the first plane (180 degrees from its ascending node). The other adjacent planes are spaced (180 - seam_spacing) / (number_planes - 1) degrees apart. None (default) spaces all planes equally (180 / number_planes degrees, including across the seam). Satellites moving in opposite directions across the seam cover a narrower street than those in adjacent planes moving in the same direction, so continuous coverage designs such as Iridium’s (six planes 31.6 degrees apart with a 22 degree seam) use a narrower seam.
- Constraints:
gt = 0
lt = 180
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- field type: Literal['walker'] = 'walker'
Space system type discriminator.
- Validated by:
_check_velocity_framesnumber_planes_le_number_satellitesrelative_spacing_lt_number_planesseam_spacing_requires_star
- get_delta_mean_anomaly_between_planes() float[source]
Gets the difference in mean anomaly (decimal degrees) for adjacent member satellites between adjacent planes.
- Returns:
difference in mean anomaly
- Return type:
- get_delta_mean_anomaly_within_planes() float[source]
Gets the difference in mean anomaly (decimal degrees) for adjacent member satellites within a single plane.
- Returns:
difference in mean anomaly
- Return type:
- get_delta_raan_between_planes() float[source]
Gets the difference in right ascension of ascending node (decimal degrees) for adjacent planes of member satellites.
- Returns:
difference in right ascension of ascending node
- Return type:
- get_instrument(index: int = 0) Instrument
Gets an instrument carried by this space system, with its views rotated from the axes of the body in its attitude (see Instrument.bind_attitude).
- Parameters:
index (int) – The index of the instrument.
- Returns:
the instrument
- Return type:
- get_satellites_per_plane() int[source]
Gets the (max) number of satellites per plane.
- Returns:
number of satellites per plane
- Return type:
- get_seam_spacing() float[source]
Gets the difference in right ascension of ascending node (decimal degrees) across the seam, between the ascending sides of the last plane and the descending sides of the first plane. For a delta configuration, which has no seam, this is the spacing between adjacent planes.
- Returns:
difference in right ascension of ascending node across the seam
- Return type:
- validator number_planes_le_number_satellites » all fields[source]
Validates the number of planes given the number of satellites.
MOG Constellation
- pydantic model tatc.schemas.MOGConstellation[source]
A constellation that arranges member satellites following the mutual orbiting group pattern.
Based on Stephen Leroy, Riley Fitzgerald, Kerri Cahoy, James Abel, and James Clark (2020). “Orbital Maintenance of a Constellation of CubeSats for Internal Gravity Wave Tomography,” IEEE Journal of Selected Topics in Applied Earth Observations and Remote Sensing, vol. 13, pp. 307-317. doi: 10.1109/JSTARS.2019.2961084
Show JSON schema
{ "title": "MOGConstellation", "description": "A constellation that arranges member satellites following the mutual orbiting group pattern.\n\nBased on Stephen Leroy, Riley Fitzgerald, Kerri Cahoy, James Abel, and James Clark (2020).\n\"Orbital Maintenance of a Constellation of CubeSats for Internal Gravity Wave Tomography,\"\nIEEE Journal of Selected Topics in Applied Earth Observations and Remote Sensing, vol. 13,\npp. 307-317. doi: 10.1109/JSTARS.2019.2961084", "type": "object", "properties": { "name": { "description": "Space system name.", "examples": [ "International Space Station" ], "title": "Name", "type": "string" }, "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 assigned instruments.", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "attitude": { "anyOf": [ { "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "schedule": "#/$defs/AttitudeSchedule", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" }, { "$ref": "#/$defs/AttitudeSchedule" } ] }, { "type": "null" } ], "default": null, "description": "Attitude of the spacecraft's body (or a schedule of attitudes), from which the views of its instruments are rotated, or `None` for a body aligned with the nadir frame (each instrument's `velocity_frame` then orients it).", "title": "Attitude" }, "type": { "const": "mog", "default": "mog", "description": "Space system type discriminator.", "title": "Type", "type": "string" }, "orbit": { "$ref": "#/$defs/CircularOrbit", "description": "Reference circular orbit for this constellation." }, "parallel_axis": { "description": "Mutual orbit axis length (m) parallel to velocity vector.", "exclusiveMinimum": 0, "title": "Parallel Axis", "type": "number" }, "transverse_axis": { "description": "Mutual orbit axis length (m) transverse to velocity vector.", "exclusiveMinimum": 0, "title": "Transverse Axis", "type": "number" }, "clockwise": { "default": true, "description": "True, if the mutual orbit is clockwise.", "title": "Clockwise", "type": "boolean" }, "number_satellites": { "default": 2, "description": "Number of equally-spaced mutually orbiting satellites.", "exclusiveMinimum": 0, "title": "Number Satellites", "type": "integer" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSchedule": { "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "required": [ "segments" ], "title": "AttitudeSchedule", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "CircularOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion -- circular motion case.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "circular", "default": "circular", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" } }, "required": [ "mean_altitude" ], "title": "CircularOrbit", "type": "object" }, "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" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "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" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "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" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "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": [ "name", "orbit", "parallel_axis", "transverse_axis" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude | tatc.schemas.attitude.AttitudeSchedule | None)clockwise (bool)instruments (list[tatc.schemas.instrument.simple.Instrument | tatc.schemas.instrument.pointed.PointedInstrument | tatc.schemas.instrument.conical.ConicalInstrument])name (str)number_satellites (int)orbit (tatc.schemas.orbit.circular.CircularOrbit)parallel_axis (float)transverse_axis (float)type (Literal['mog'])
- Validators:
_check_velocity_frames»all fields
- field attitude: AllAttitudes | None = None
Attitude of the spacecraft’s body (or a schedule of attitudes), from which the views of its instruments are rotated, or None for a body aligned with the nadir frame (each instrument’s velocity_frame then orients it).
- Validated by:
_check_velocity_frames
- field clockwise: bool = True
True, if the mutual orbit is clockwise.
- Validated by:
_check_velocity_frames
- 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 assigned instruments.
- Constraints:
min_length = 1
- Validated by:
_check_velocity_frames
- field number_satellites: int = 2
Number of equally-spaced mutually orbiting satellites.
- Constraints:
gt = 0
- Validated by:
_check_velocity_frames
- field orbit: CircularOrbit [Required]
Reference circular orbit for this constellation.
- Validated by:
_check_velocity_frames
- field parallel_axis: float [Required]
Mutual orbit axis length (m) parallel to velocity vector.
- Constraints:
gt = 0
- Validated by:
_check_velocity_frames
- field transverse_axis: float [Required]
Mutual orbit axis length (m) transverse to velocity vector.
- Constraints:
gt = 0
- Validated by:
_check_velocity_frames
- field type: Literal['mog'] = 'mog'
Space system type discriminator.
- Validated by:
_check_velocity_frames
- get_instrument(index: int = 0) Instrument
Gets an instrument carried by this space system, with its views rotated from the axes of the body in its attitude (see Instrument.bind_attitude).
- Parameters:
index (int) – The index of the instrument.
- Returns:
the instrument
- Return type:
SOC Constellation
- pydantic model tatc.schemas.SOCConstellation[source]
A constellation that arranges member satellites following the streets of coverage pattern.
For inclined orbits, the satellites follow a Walker delta pattern based on Joshua F. Anderson, Michel-Alexandre Cardin, and Paul T. Grogan (2022). “Design and analysis of flexible multi-layer staged deployment for satellite mega-constellations under demand uncertainty” Acta Astronautica, vol. 198, pp. 179-193. doi: 10.1016/j.actaastro.2022.05.022, with footprint centers on the hexagonal lattice that covers a plane with the fewest circles (rather than the hexagonal lattice of touching circles, which leaves gaps between them).
For near-polar orbits, the satellites follow the polar streets-of-coverage pattern of Lloyd Rider (1985). “Optimized polar orbit constellations for redundant earth coverage” Journal of the Astronautical Sciences, vol. 33, pp. 147-161, and John G. Adams and Lloyd Rider (1987). “Circular polar constellations providing continuous single or multiple coverage above a specified latitude” Journal of the Astronautical Sciences, vol. 35, pp. 155-192: planes spanning 180 degrees of right ascension, in which the ascending (co-rotating) sides of adjacent planes are farther apart than the ascending and descending (counter-rotating) sides of the first and last planes across the “seam”.
Show JSON schema
{ "title": "SOCConstellation", "description": "A constellation that arranges member satellites following the streets of coverage pattern.\n\nFor inclined orbits, the satellites follow a Walker delta pattern based on Joshua F.\nAnderson, Michel-Alexandre Cardin, and Paul T. Grogan (2022). \"Design and analysis\nof flexible multi-layer staged deployment for satellite mega-constellations under\ndemand uncertainty\" Acta Astronautica, vol. 198, pp. 179-193.\ndoi: 10.1016/j.actaastro.2022.05.022, with footprint centers on the hexagonal\nlattice that covers a plane with the fewest circles (rather than the hexagonal\nlattice of touching circles, which leaves gaps between them).\n\nFor near-polar orbits, the satellites follow the polar streets-of-coverage pattern\nof Lloyd Rider (1985). \"Optimized polar orbit constellations for redundant earth\ncoverage\" Journal of the Astronautical Sciences, vol. 33, pp. 147-161, and John\nG. Adams and Lloyd Rider (1987). \"Circular polar constellations providing continuous\nsingle or multiple coverage above a specified latitude\" Journal of the Astronautical\nSciences, vol. 35, pp. 155-192: planes spanning 180 degrees of right ascension,\nin which the ascending (co-rotating) sides of adjacent planes are farther apart than\nthe ascending and descending (counter-rotating) sides of the first and last planes\nacross the \"seam\".", "type": "object", "properties": { "name": { "description": "Space system name.", "examples": [ "International Space Station" ], "title": "Name", "type": "string" }, "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 assigned instruments.", "items": { "oneOf": [ { "$ref": "#/$defs/Instrument" }, { "$ref": "#/$defs/PointedInstrument" }, { "$ref": "#/$defs/ConicalInstrument" } ] }, "minItems": 1, "title": "Instruments", "type": "array" }, "attitude": { "anyOf": [ { "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "schedule": "#/$defs/AttitudeSchedule", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" }, { "$ref": "#/$defs/AttitudeSchedule" } ] }, { "type": "null" } ], "default": null, "description": "Attitude of the spacecraft's body (or a schedule of attitudes), from which the views of its instruments are rotated, or `None` for a body aligned with the nadir frame (each instrument's `velocity_frame` then orients it).", "title": "Attitude" }, "type": { "const": "soc", "default": "soc", "description": "Space system type discriminator.", "title": "Type", "type": "string" }, "orbit": { "$ref": "#/$defs/CircularOrbit", "description": "Reference circular orbit for this constellation." }, "swath_width": { "description": "Observation diameter (meters) at specified elevation.", "exclusiveMinimum": 0, "title": "Swath Width", "type": "number" }, "packing_distance": { "description": "Relative distance between footprint centers (inclined orbits), where 1 places the footprints on the hexagonal lattice that just covers continuously, or relative footprint radius used as a coverage margin (polar orbits). Smaller values add overlap as a coverage margin.", "exclusiveMinimum": 0, "maximum": 1, "title": "Packing Distance", "type": "number" }, "polar": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True, to use the polar streets-of-coverage pattern; False, to use the Walker delta pattern; None (default), to use the polar pattern for near-polar orbits (inclination within 10 degrees of 90 degrees).", "title": "Polar" } }, "$defs": { "Attitude": { "description": "Attitude of a spacecraft's body relative to its orbit. The body is\nrotated from the orbit's nadir frame (its nadir axis and its along-track\naxis, aligned with the velocity in `velocity_frame`) first by the yaw\nangle about the nadir axis, then by the roll angle about the yawed\nalong-track axis, then by the pitch angle about the rolled cross-track\naxis. Each angle is constant or, if its profile is given, varies with the\nsatellite's argument of latitude.\n\nThe instruments of a space system point relative to its body: their\nyaw, roll, and pitch angles, scan azimuths, and pixels are measured from\nthe body's axes. For example, a yaw angle of 180 degrees (flying\nbackward) swaps the left and right of a cross-track scanner and the fore\nand aft of a conical scan. An instrument's field of regard remains\nmeasured from nadir. The attitude is that of the body, shared by every\ninstrument it carries; an instrument's own angles (see\n`PointedInstrument`) orient it on the body, after the body's rotation.", "properties": { "type": { "const": "attitude", "default": "attitude", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (`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)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis, positive turning the front of the body to the left of the direction of motion (180: flying backward).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" }, "roll_angle": { "default": 0, "description": "Rotation (degrees) of the body about its along-track axis, positive tilting its nadir axis to the left of the direction of motion.", "maximum": 180, "minimum": -180, "title": "Roll Angle", "type": "number" }, "pitch_angle": { "default": 0, "description": "Rotation (degrees) of the body about its rolled cross-track axis, positive tilting its nadir axis forward.", "maximum": 180, "minimum": -180, "title": "Pitch Angle", "type": "number" }, "yaw_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Yaw angle (degrees) as a function of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (argument of latitude, yaw angle) pairs interpolated linearly and periodically. If given, it overrides `yaw_angle`.", "title": "Yaw Angle Profile" }, "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 (see `yaw_angle_profile`), for example the roll steering of a synthetic aperture radar. If given, it overrides `roll_angle`.", "title": "Roll Angle Profile" }, "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 (see `yaw_angle_profile`). If given, it overrides `pitch_angle`.", "title": "Pitch Angle Profile" }, "blind_intervals": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Intervals of the satellite's argument of latitude (degrees from the ascending node, 0 to 360), as (start, end) pairs, in which the space system's instruments do not observe, for example while the body or a mechanism moves between attitudes. An interval whose end precedes its start contains the ascending node. Observations in them are not valid (see `Instrument.is_valid_observation`).", "title": "Blind Intervals" } }, "title": "Attitude", "type": "object" }, "AttitudeSchedule": { "description": "Schedule of attitudes over time: each segment's attitude applies from its\nstart until the start of the next segment, and the first segment's\nattitude also applies before its start. For example, a satellite that\nperiodically flips to fly backward (yaw 180 degrees) and forward, or\nthat alternates between observing modes.", "properties": { "type": { "const": "schedule", "default": "schedule", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "segments": { "description": "The segments, each with a start time and an attitude.", "items": { "$ref": "#/$defs/AttitudeSegment" }, "minItems": 1, "title": "Segments", "type": "array" } }, "required": [ "segments" ], "title": "AttitudeSchedule", "type": "object" }, "AttitudeSegment": { "description": "An attitude that applies from a start time (until the start of the next\nsegment of a schedule).", "properties": { "start": { "description": "Time (timezone-aware) from which the attitude applies.", "format": "date-time", "title": "Start", "type": "string" }, "attitude": { "description": "The attitude.", "discriminator": { "mapping": { "attitude": "#/$defs/Attitude", "glint": "#/$defs/GlintAttitude", "target": "#/$defs/TargetAttitude" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Attitude" }, { "$ref": "#/$defs/TargetAttitude" }, { "$ref": "#/$defs/GlintAttitude" } ], "title": "Attitude" } }, "required": [ "start", "attitude" ], "title": "AttitudeSegment", "type": "object" }, "CircularOrbit": { "description": "Orbit specification using Keplerian elements for elliptical motion -- circular motion case.", "properties": { "true_anomaly": { "default": 0, "description": "True anomaly (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "True Anomaly", "type": "number" }, "epoch": { "default": "2020-01-01T00:00:00Z", "description": "Timestamp (epoch) of the initial orbital state.", "format": "date-time", "title": "Epoch", "type": "string" }, "mean_altitude": { "description": "Mean altitude (meters).", "minimum": 0, "title": "Mean Altitude", "type": "number" }, "type": { "const": "circular", "default": "circular", "description": "Orbit type discriminator.", "title": "Type", "type": "string" }, "inclination": { "default": 0, "description": "Inclination (degrees).", "exclusiveMaximum": 180, "minimum": 0, "title": "Inclination", "type": "number" }, "right_ascension_ascending_node": { "default": 0, "description": "Right ascension of ascending node (degrees).", "exclusiveMaximum": 360, "minimum": 0, "title": "Right Ascension Ascending Node", "type": "number" } }, "required": [ "mean_altitude" ], "title": "CircularOrbit", "type": "object" }, "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" }, "GlintAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at the sun\nglint (the specular point, see `tatc.utils.compute_specular_point`), as\nfor the glint mode of a greenhouse gas sounder observing the ocean: at\neach time, toward the specular point, or short of it toward nadir by an\noffset angle (in the plane of the nadir axis and the line of sight to\nthe specular point), while the Sun is at least `min_solar_elevation`\nabove the horizon at the specular point (equal to the satellite's\nelevation angle seen from it) and the body points within\n`max_off_nadir_angle` of nadir, and otherwise along nadir. The body is\nrotated by the yaw angle about the nadir axis and then by the roll and\npitch angles that point its nadir axis (see\n`tatc.utils.compute_view_angles`), which follows the glint as it moves\nwith the satellite and the Sun.\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points.", "properties": { "type": { "const": "glint", "default": "glint", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "max_off_nadir_angle": { "default": 60, "description": "Maximum angle (degrees) from nadir at which the body points toward the glint.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "offset_angle": { "default": 0, "description": "Angle (degrees) by which the body points short of the specular point, toward nadir, as for an instrument that observes near the glint rather than at its center.", "exclusiveMaximum": 90, "minimum": 0, "title": "Offset Angle", "type": "number" }, "offset_angle_profile": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Offset angle (degrees, see `offset_angle`) as a function of the specular point's angle from nadir (degrees), as (off-nadir angle, offset angle) pairs interpolated linearly (and held at the first and last offsets beyond them). If given, it overrides `offset_angle`.", "title": "Offset Angle Profile" }, "min_solar_elevation": { "default": 0, "description": "Minimum solar elevation angle (degrees) at the specular point at which the body points at it.", "exclusiveMaximum": 90, "minimum": 0, "title": "Min Solar Elevation", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "title": "GlintAttitude", "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" }, "Point": { "description": "Surface point in the WGS 84 coordinate system.", "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" ], "title": "Point", "type": "object" }, "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" }, "TargetAttitude": { "description": "Attitude of a spacecraft's body that points its nadir axis at ground\ntargets, as for an agile satellite imaging sites or a target mode: at\neach time, at the target closest to nadir (with the smallest off-nadir\nangle) among those within `max_off_nadir_angle` of nadir and above the\nhorizon, and otherwise along nadir. The body is rotated by the yaw angle\nabout the nadir axis and then by the roll and pitch angles that point\nits nadir axis at the target (see `tatc.utils.compute_view_angles`), so\nthat its along-track axis stays close to the direction of motion. The\nbody turns instantly between targets and nadir (slews are not modeled).\n\nThe fields of regard of its instruments (measured from nadir) should\ninclude the off-nadir angles at which the body points. As an\ninstrument's view stays on a target while the body points at it, the\nepoch of an observation of the target is a time while the body points\nat it (rather than the time a view sweeps over it).", "properties": { "type": { "const": "target", "default": "target", "description": "Attitude type discriminator.", "title": "Type", "type": "string" }, "targets": { "description": "The ground targets at which to point.", "items": { "$ref": "#/$defs/Point" }, "minItems": 1, "title": "Targets", "type": "array" }, "max_off_nadir_angle": { "default": 30, "description": "Maximum angle (degrees) from nadir at which the body points at a target.", "exclusiveMaximum": 90, "exclusiveMinimum": 0, "title": "Max Off Nadir Angle", "type": "number" }, "velocity_frame": { "$ref": "#/$defs/VelocityFrame", "default": "earth_fixed", "description": "Reference frame of the velocity vector that defines the along-track axis (see `Attitude.velocity_frame`)." }, "yaw_angle": { "default": 0, "description": "Rotation (degrees) of the body about the nadir axis before pointing (see `Attitude.yaw_angle`).", "maximum": 180, "minimum": -180, "title": "Yaw Angle", "type": "number" } }, "required": [ "targets" ], "title": "TargetAttitude", "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": [ "name", "orbit", "swath_width", "packing_distance" ] }
- Fields:
attitude (tatc.schemas.attitude.Attitude | tatc.schemas.attitude.TargetAttitude | tatc.schemas.attitude.GlintAttitude | tatc.schemas.attitude.AttitudeSchedule | None)instruments (list[tatc.schemas.instrument.simple.Instrument | tatc.schemas.instrument.pointed.PointedInstrument | tatc.schemas.instrument.conical.ConicalInstrument])name (str)orbit (tatc.schemas.orbit.circular.CircularOrbit)packing_distance (float)polar (bool | None)swath_width (float)type (Literal['soc'])
- Validators:
_check_velocity_frames»all fields
- field attitude: AllAttitudes | None = None
Attitude of the spacecraft’s body (or a schedule of attitudes), from which the views of its instruments are rotated, or None for a body aligned with the nadir frame (each instrument’s velocity_frame then orients it).
- Validated by:
_check_velocity_frames
- 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 assigned instruments.
- Constraints:
min_length = 1
- Validated by:
_check_velocity_frames
- field orbit: CircularOrbit [Required]
Reference circular orbit for this constellation.
- Validated by:
_check_velocity_frames
- field packing_distance: float [Required]
Relative distance between footprint centers (inclined orbits), where 1 places the footprints on the hexagonal lattice that just covers continuously, or relative footprint radius used as a coverage margin (polar orbits). Smaller values add overlap as a coverage margin.
- Constraints:
gt = 0
le = 1
- Validated by:
_check_velocity_frames
- field polar: bool | None = None
True, to use the polar streets-of-coverage pattern; False, to use the Walker delta pattern; None (default), to use the polar pattern for near-polar orbits (inclination within 10 degrees of 90 degrees).
- Validated by:
_check_velocity_frames
- field swath_width: float [Required]
Observation diameter (meters) at specified elevation.
- Constraints:
gt = 0
- Validated by:
_check_velocity_frames
- field type: Literal['soc'] = 'soc'
Space system type discriminator.
- Validated by:
_check_velocity_frames
- generate_members() list[Satellite][source]
Generate member satellites for this streets-of-coverage constellation. In the polar pattern, adjacent co-rotating planes are offset by half the in-plane spacing, so that each plane’s satellites fill the gaps between the footprints of its neighbors.
- generate_walker() WalkerConstellation[source]
Generate a WalkerConstellation fitting the Streets of Coverage description for inclined orbits (the Walker delta pattern). Polar streets-of-coverage designs, whose planes are unequally spaced, are not Walker constellations.
- Returns:
the member satellites following the Walker pattern.
- Return type:
- get_footprint_angle() float[source]
Gets the Earth central angle (degrees) of the footprint radius [Eqs. (19)-(20) in Anderson et al. (2022)].
- Returns:
the footprint Earth central angle
- Return type:
- get_instrument(index: int = 0) Instrument
Gets an instrument carried by this space system, with its views rotated from the axes of the body in its attitude (see Instrument.bind_attitude).
- Parameters:
index (int) – The index of the instrument.
- Returns:
the instrument
- Return type:
- get_number_planes() int[source]
Gets the number of planes.
- Returns:
the number of planes
- Return type:
- get_polar_design() tuple[int, int, float, float][source]
Gets the polar streets-of-coverage design for continuous single coverage with the fewest satellites (Adams and Rider, 1987). With S satellites per plane, footprints of Earth central angle gamma (reduced by the packing distance as a coverage margin) overlap along each plane in a street of half width c, where cos(c) = cos(gamma) / cos(180 / S). Adjacent co-rotating planes may be up to gamma + c apart and the counter-rotating planes across the seam up to 2c apart, so that P planes span 180 degrees if (P - 1) (gamma + c) + 2 c >= 180. Both spacings are scaled down equally to span exactly 180 degrees.