AISDB Docs: Index

For a hands-on quick start guide for using AISdb, please refer to the AISdb Tutorials.

API Documentation:

• aisdb package
  • Subpackages
    • aisdb.database package
      • Submodules
        • aisdb.database.create_tables module
        • aisdb.database.dbconn module
        • aisdb.database.dbqry module
        • aisdb.database.decoder module
        • aisdb.database.decoder_csv module
        • aisdb.database.sql_query_strings module
        • aisdb.database.sqlfcn module
        • aisdb.database.sqlfcn_callbacks module
    • aisdb.discretize package
      • Submodules
        • aisdb.discretize.h3 module
    • aisdb.ports package
      • Submodules
        • aisdb.ports.api module
    • aisdb.weather package
      • Submodules
        • aisdb.weather.data_store module
        • aisdb.weather.utils module
        • aisdb.weather.weather_fetch module
    • aisdb.webdata package
      • Submodules
        • aisdb.webdata.bathymetry module
        • aisdb.webdata.load_raster module
        • aisdb.webdata.marinetraffic module
        • aisdb.webdata.shore_dist module
  • Submodules
    • aisdb.aisdb module
      • binarysearch_vector()
      • decoder()
      • encoder_score_fcn()
      • haversine()
      • receiver()
      • simplify_linestring_idx()
    • aisdb.denoising_encoder module
      • InlandDenoising
        • InlandDenoising.data_url
        • InlandDenoising.filter_noisy_points()
      • encode_greatcircledistance()
      • encode_score()
      • remove_pings_wrt_speed()
    • aisdb.gis module
      • Domain
        • Domain.nearest_polygons_to_point()
        • Domain.point_in_polygon()
        • Domain.split_geom()
      • DomainFromPoints
      • DomainFromTxts
      • delta_knots()
      • delta_meters()
      • delta_seconds()
      • distance3D()
      • dt_2_epoch()
      • epoch_2_dt()
      • mask_in_radius_2D()
      • radial_coordinate_boundary()
      • shiftcoord()
      • vesseltrack_3D_dist()
    • aisdb.interp module
      • cubic_spline()
      • geo_interp_time()
      • interp_cubic_spline()
      • interp_spacing()
      • interp_time()
      • np_interp_linear()
    • aisdb.network_graph module
      • graph()
    • aisdb.proc_util module
      • getfiledate()
      • glob_files()
      • tracks_csv()
      • write_csv()
      • write_csv_rows()
    • aisdb.receiver module
      • start_receiver()
    • aisdb.track_gen module
      • EmptyRowsException
      • TrackGen()
      • fence_tracks()
      • min_speed_filter()
      • min_track_length_filter()
      • split_timedelta()
      • split_tracks()
      • zone_mask()
    • aisdb.wsa module
      • wetted_surface_area()
• aisdb.aisdb module
  • binarysearch_vector()
  • decoder()
  • encoder_score_fcn()
  • haversine()
  • receiver()
  • simplify_linestring_idx()
• aisdb.database package
  • Submodules
    • aisdb.database.create_tables module
    • aisdb.database.dbconn module
      • ConnectionType
        • ConnectionType.POSTGRES
      • DBConn
      • PostgresDBConn
        • PostgresDBConn.aggregate_static_msgs()
        • PostgresDBConn.deduplicate_dynamic_msgs()
        • PostgresDBConn.drop_indexes()
        • PostgresDBConn.execute()
        • PostgresDBConn.rebuild_indexes()
    • aisdb.database.dbqry module
      • DBQuery
        • DBQuery.check_marinetraffic()
        • DBQuery.create_qry_params()
        • DBQuery.gen_qry()
    • aisdb.database.decoder module
      • FileChecksums
        • FileChecksums.checksum_exists()
        • FileChecksums.checksums_table()
        • FileChecksums.get_md5()
        • FileChecksums.insert_checksum()
      • decode_msgs()
      • fast_unzip()
      • process_raw_files()
    • aisdb.database.decoder_csv module
      • decode_csv_files()
      • decode_exactearth_csv()
    • aisdb.database.sql_query_strings module
      • has_mmsi()
      • in_bbox()
      • in_bbox_geom()
      • in_mmsi()
      • in_polygon_geom()
      • in_timerange()
      • valid_mmsi()
    • aisdb.database.sqlfcn module
      • crawl_dynamic()
      • crawl_dynamic_static()
      • load_sql()
    • aisdb.database.sqlfcn_callbacks module
      • in_bbox()
      • in_bbox_time()
      • in_bbox_time_geom()
      • in_bbox_time_validmmsi()
      • in_bbox_time_validmmsi_geom()
      • in_time_bbox()
      • in_time_bbox_geom()
      • in_time_bbox_hasmmsi()
      • in_time_bbox_hasmmsi_geom()
      • in_time_bbox_inmmsi()
      • in_time_bbox_inmmsi_geom()
      • in_time_bbox_validmmsi()
      • in_time_bbox_validmmsi_geom()
      • in_time_mmsi()
      • in_timerange_hasmmsi()
      • in_timerange_inmmsi()
      • in_timerange_validmmsi()
      • in_validmmsi_bbox_geom()
• aisdb.database.create_tables module
• aisdb.database.dbconn module
  • ConnectionType
    • ConnectionType.POSTGRES
  • DBConn
  • PostgresDBConn
    • PostgresDBConn.aggregate_static_msgs()
    • PostgresDBConn.deduplicate_dynamic_msgs()
    • PostgresDBConn.drop_indexes()
    • PostgresDBConn.execute()
    • PostgresDBConn.rebuild_indexes()
• aisdb.database.dbqry module
  • DBQuery
    • DBQuery.check_marinetraffic()
    • DBQuery.create_qry_params()
    • DBQuery.gen_qry()
• aisdb.database.decoder module
  • FileChecksums
    • FileChecksums.checksum_exists()
    • FileChecksums.checksums_table()
    • FileChecksums.get_md5()
    • FileChecksums.insert_checksum()
  • decode_msgs()
  • fast_unzip()
  • process_raw_files()
• aisdb.database.decoder_csv module
  • decode_csv_files()
  • decode_exactearth_csv()
• aisdb.database.sql_query_strings module
  • has_mmsi()
  • in_bbox()
  • in_bbox_geom()
  • in_mmsi()
  • in_polygon_geom()
  • in_timerange()
  • valid_mmsi()
• aisdb.database.sqlfcn module
  • crawl_dynamic()
  • crawl_dynamic_static()
  • load_sql()
• aisdb.database.sqlfcn_callbacks module
  • in_bbox()
  • in_bbox_time()
  • in_bbox_time_geom()
  • in_bbox_time_validmmsi()
  • in_bbox_time_validmmsi_geom()
  • in_time_bbox()
  • in_time_bbox_geom()
  • in_time_bbox_hasmmsi()
  • in_time_bbox_hasmmsi_geom()
  • in_time_bbox_inmmsi()
  • in_time_bbox_inmmsi_geom()
  • in_time_bbox_validmmsi()
  • in_time_bbox_validmmsi_geom()
  • in_time_mmsi()
  • in_timerange_hasmmsi()
  • in_timerange_inmmsi()
  • in_timerange_validmmsi()
  • in_validmmsi_bbox_geom()
• aisdb.denoising_encoder module
  • InlandDenoising
    • InlandDenoising.data_url
    • InlandDenoising.filter_noisy_points()
  • encode_greatcircledistance()
  • encode_score()
  • remove_pings_wrt_speed()
• aisdb.discretize package
  • Submodules
    • aisdb.discretize.h3 module
      • Discretizer
        • Discretizer.describe()
        • Discretizer.get_h3_index()
        • Discretizer.get_hexagon_area_at_latitude()
        • Discretizer.get_polygon_from_cells()
        • Discretizer.yield_tracks_discretized_by_indexes()
• aisdb.discretize.h3 module
  • Discretizer
    • Discretizer.describe()
    • Discretizer.get_h3_index()
    • Discretizer.get_hexagon_area_at_latitude()
    • Discretizer.get_polygon_from_cells()
    • Discretizer.yield_tracks_discretized_by_indexes()
• aisdb.gis module
  • Domain
    • Domain.nearest_polygons_to_point()
    • Domain.point_in_polygon()
    • Domain.split_geom()
  • DomainFromPoints
  • DomainFromTxts
  • delta_knots()
  • delta_meters()
  • delta_seconds()
  • distance3D()
  • dt_2_epoch()
  • epoch_2_dt()
  • mask_in_radius_2D()
  • radial_coordinate_boundary()
  • shiftcoord()
  • vesseltrack_3D_dist()
• aisdb.interp module
  • cubic_spline()
  • geo_interp_time()
  • interp_cubic_spline()
  • interp_spacing()
  • interp_time()
  • np_interp_linear()
• aisdb.network_graph module
  • graph()
• aisdb.ports package
  • Submodules
    • aisdb.ports.api module
      • WorldPortIndexClient
        • WorldPortIndexClient.fetch_ports()
        • WorldPortIndexClient.filter_by_cargo_depth()
• aisdb.ports.api module
  • WorldPortIndexClient
    • WorldPortIndexClient.fetch_ports()
    • WorldPortIndexClient.filter_by_cargo_depth()
• aisdb.proc_util module
  • getfiledate()
  • glob_files()
  • tracks_csv()
  • write_csv()
  • write_csv_rows()
• aisdb.receiver module
  • start_receiver()
• aisdb.track_gen module
  • EmptyRowsException
  • TrackGen()
  • fence_tracks()
  • min_speed_filter()
  • min_track_length_filter()
  • split_timedelta()
  • split_tracks()
  • zone_mask()
• aisdb.weather package
  • Submodules
    • aisdb.weather.data_store module
      • WeatherDataStore
        • WeatherDataStore.close()
        • WeatherDataStore.extract_weather()
        • WeatherDataStore.yield_tracks_with_weather()
      • dt_to_iso8601()
      • get_monthly_range()
    • aisdb.weather.utils module
    • aisdb.weather.weather_fetch module
      • ClimateDataStore
        • ClimateDataStore.download_grib_file()
• aisdb.weather.data_store module
  • WeatherDataStore
    • WeatherDataStore.close()
    • WeatherDataStore.extract_weather()
    • WeatherDataStore.yield_tracks_with_weather()
  • dt_to_iso8601()
  • get_monthly_range()
• aisdb.weather.utils module
• aisdb.weather.weather_fetch module
  • ClimateDataStore
    • ClimateDataStore.download_grib_file()
• aisdb.webdata package
  • Submodules
    • aisdb.webdata.bathymetry module
      • Gebco
        • Gebco.fetch_bathymetry_grid()
        • Gebco.merge_tracks()
    • aisdb.webdata.load_raster module
      • RasterFile
    • aisdb.webdata.marinetraffic module
      • VesselInfo
        • VesselInfo.vessel_info_callback()
      • vessel_info()
    • aisdb.webdata.shore_dist module
      • CoastDist
        • CoastDist.data_url
        • CoastDist.get_distance()
      • PortDist
        • PortDist.data_url
        • PortDist.get_distance()
      • ShoreDist
        • ShoreDist.data_url
        • ShoreDist.get_distance()
      • download_unzip()
• aisdb.webdata.bathymetry module
  • Gebco
    • Gebco.fetch_bathymetry_grid()
    • Gebco.merge_tracks()
• aisdb.webdata.load_raster module
  • RasterFile
• aisdb.webdata.marinetraffic module
  • VesselInfo
    • VesselInfo.vessel_info_callback()
  • vessel_info()
• aisdb.webdata.shore_dist module
  • CoastDist
    • CoastDist.data_url
    • CoastDist.get_distance()
  • PortDist
    • PortDist.data_url
    • PortDist.get_distance()
  • ShoreDist
    • ShoreDist.data_url
    • ShoreDist.get_distance()
  • download_unzip()
• aisdb.wsa module
  • wetted_surface_area()

Indices and tables

• Index

• Module Index

• Search Page