bbi.camera.satellite

pydantic model SatelliteCameraUpdateParam

Bases: AnimationFrame

field azimuth: float | None = None
field ground_target: tuple[float, float] | None = None
field gsd: float | None = None
field resolution: tuple[int, int] | None = None
class SatelliteCamera(node_id: str, resolution: tuple[int, int], sensor_preset: CameraProfile, gsd_m: float = _DEFAULT_GSD)

Bases: BaseOrthographicCamera, SupportsPanchromatic, Animatable[SatelliteCameraUpdateParam]

An orthographic camera for satellite-based workflows.

Parameters:
  • resolution (tuple[int, int]) – The resolution of the capture output.

  • gsd_m (float) – The Ground Sample Distance (GSD) of the camera in meters per pixel.

property gsd: float

The Ground Sample Distance (GSD) of the camera in meters per pixel.

property ground_target: tuple[float, float]

The x and y position of the camera’s ground target.

property azimuth: float

The azimuth of the camera in degrees.

set_gsd(gsd_m: float) → None

Set the GSD of the camera.

set_ground_target(xy: tuple[float, float]) → None

Sets the x and y position of the camera’s ground target.

Parameters:

xy (tuple[float, float]) – The x and y position.

set_azimuth(azimuth: float) → None

Set the azimuth of the camera.

set_resolution(resolution: tuple[int, int]) → None

Sets the resolution of the capture output.

Parameters:

resolution (tuple[int, int]) – The resolution of the capture output.

set_off_nadir_skew(x_skew: float, y_skew: float)

Set camera off-nadir skew in x and y directions.

Parameters:
  • x_skew (float) – The off-nadir skew in the x direction normalized to individual Asset radius.

  • y_skew (float) – The off-nadir skew in the y direction normalized to individual Asset radius.

execute(frame_id: int, frame_max: int, delta_seconds: float) → None

Updates the SatelliteCamera state to the specified frame.

Parameters:
  • frame_id (int) – The frame ID.

  • frame_max (int) – Max frame count in the current loop.

  • delta_seconds (float) – The target real-time in seconds between frames. This is used to calculate physical displacement for certain assets.