trafficgen.ship_traffic_generator

Functions to generate traffic situations.

Functions

generate_traffic_situations(situations_data, ...)

Generate traffic situations based on the provided input files.
trafficgen.ship_traffic_generator.generate_traffic_situations(situations_data: Path | SituationInput | list[SituationInput], own_ship_data: Path | ShipStatic, target_ships_data: Path | list[ShipStatic], settings_data: Path | EncounterSettings, ownship_coordinate: str | None = None) → list[TrafficSituation]

Generate traffic situations based on the provided input files.

Parameters:

  • situations_data (Path | SituationInput | list[SituationInput]) – Path to situation file/folder, or one/many situation JSON payloads.

  • own_ship_data (Path | ShipStatic) – Path to own ship static file, or own ship static JSON payload.

  • target_ships_data (Path | list[ShipStatic]) – Path to target ship static folder, or list of target ship static JSON payloads.

  • settings_data (Path | EncounterSettings) – Path to encounter settings file, or encounter settings JSON payload.

  • ownship_coordinate (str | None) – The ownship start coordinate as ‘lat,lon’ in decimal degrees.

Returns:

A list of generated traffic situations.

Return type:

list[TrafficSituation]