API Documentation

• trafficgen package
  • Submodules
    • trafficgen.check_land_crossing module
      • path_crosses_land()
    • trafficgen.cli module
    • trafficgen.encounter module
      • assign_beta()
      • assign_beta_from_list()
      • assign_future_position_to_target_ship()
      • assign_sog_to_target_ship()
      • assign_vector_time()
      • calculate_min_vector_length_target_ship()
      • calculate_relative_bearing()
      • calculate_ship_cog()
      • check_encounter_evolvement()
      • decide_target_ship()
      • define_own_ship()
      • determine_colreg()
      • find_start_position_target_ship()
      • generate_encounter()
    • trafficgen.marine_system_simulator module
      • flat2llh()
      • llh2flat()
      • ssa()
    • trafficgen.plot_traffic_situation module
      • add_ship_to_map()
      • add_ship_to_plot()
      • calculate_ship_outline()
      • calculate_vector_arrow()
      • find_max_value_for_plot()
      • plot_specific_traffic_situation()
      • plot_traffic_situations()
    • trafficgen.read_files module
      • camel_to_snake()
      • check_input_units()
      • convert_keys_to_snake_case()
      • convert_settings_data_from_maritime_to_si_units()
      • convert_situation_data_from_maritime_to_si_units()
      • read_encounter_settings_file()
      • read_generated_situation_files()
      • read_own_ship_static_file()
      • read_situation_files()
      • read_target_ship_static_files()
    • trafficgen.ship_traffic_generator module
      • generate_traffic_situations()
    • trafficgen.types module
      • Encounter
      • EncounterClassification
      • EncounterRelativeSpeed
      • EncounterSettings
      • EncounterType
      • OwnShipInitial
      • SituationInput
      • to_camel()
    • trafficgen.utils module
      • calculate_bearing_between_waypoints()
      • calculate_destination_along_track()
      • calculate_distance()
      • calculate_position_along_track_using_waypoints()
      • calculate_position_at_certain_time()
      • convert_angle_0_to_2_pi_to_minus_pi_to_pi()
      • convert_angle_minus_pi_to_pi_to_0_to_2_pi()
      • deg_2_rad()
      • knot_2_m_pr_s()
      • m_2_nm()
      • m_pr_s_2_knot()
      • min_2_s()
      • nm_2_m()
      • rad_2_deg()
    • trafficgen.write_traffic_situation_to_file module
      • convert_ship_data_from_si_units_to_maritime()
      • convert_situation_data_from_si_units_to__maritime()
      • write_traffic_situations_to_json_file()