API Reference

This section provides comprehensive documentation for all modules, classes, and functions in the es_sfgtools package. The package is organized into several main categories that support the complete seafloor geodesy data processing workflow.

Complete API Reference

• es_sfgtools

Core Package

• es_sfgtools package
  • Subpackages

Configuration Management

Configuration modules for environment setup, file paths, and processing parameters.

• es_sfgtools.config package
  • Submodules

Data Management

Modules for data organization, asset catalogs, and directory structure management.

• es_sfgtools.data_mgmt package
  • Subpackages
  • Submodules
• es_sfgtools.data_mgmt.assetcatalog package
  • Submodules
• es_sfgtools.data_mgmt.directorymgmt package
  • CampaignDir
  • DirectoryHandler
  • GARPOSSurveyDir
  • NetworkDir
  • StationDir
  • SurveyDir
  • TileDBDir
  • Submodules

Data Models

Pydantic models for metadata, observables, and data validation.

• es_sfgtools.data_models package
  • Subpackages
  • Submodules
• es_sfgtools.data_models.metadata package
  • Benchmark
  • Campaign
  • Site
  • Survey
  • SurveyType
  • Vessel
  • classify_survey_type()
  • import_site()
  • import_vessel()
  • Submodules
• es_sfgtools.data_models.observables module
  • AcousticDataFrame
  • IMUPositionDataFrame
  • KinPositionDataFrame
  • ShotDataFrame
  • SoundVelocityDataFrame
• es_sfgtools.data_models.sv3_models module
  • NovatelAHRSData
  • NovatelGNSSData
  • NovatelHeadingData
  • NovatelINSData
  • NovatelInterrogationEvent
  • NovatelObservations
  • NovatelPositionType
  • NovatelRangeData
  • NovatelRangeDiagnosticData
  • NovatelRangeEvent
  • NovatelRangeReplyData
  • NovatelSolutionStatus
  • SV3GPSQuality
  • TimeData

Logging System

Logging utilities and structured logging for workflow tracking.

• es_sfgtools.logging package
  • change_all_logger_dirs()
  • remove_all_loggers_from_console()
  • route_all_loggers_to_console()
  • set_all_logger_levels()
  • Submodules

Modeling Tools

GARPOS modeling tools and acoustic positioning analysis.

• es_sfgtools.modeling package
  • Subpackages
• es_sfgtools.modeling.garpos_tools package
  • Submodules

Instrument-Specific Tools

Tools for processing data from specific GNSS and acoustic instruments.

NOVATEL GNSS Tools

Processing tools for NOVATEL GNSS receivers.

• es_sfgtools.novatel_tools package
  • Submodules

PRIDE-PPPAR Tools

Tools for precise GNSS processing using PRIDE-PPPAR.

• es_sfgtools.pride_tools package
  • Submodules

Sonardyne Acoustic Tools

Processing tools for Sonardyne acoustic positioning systems.

• es_sfgtools.sonardyne_tools package
  • dfop00_to_SFGDSTFSeafloorAcousticData()
  • dfop00_to_shotdata()
  • merge_interrogation_reply()
  • novatelInterrogation_to_garpos_interrogation()
  • novatelReply_to_garpos_reply()
  • Submodules

Seafloor Site Tools

Tools for seafloor site metadata and sound velocity processing.

• es_sfgtools.seafloor_site_tools package
  • Submodules

Data Processing Components

Pre-filtering

Data quality control and filtering utilities.

• es_sfgtools.prefiltering package
  • Submodules

TileDB Integration

Tools for TileDB array storage and management.

• es_sfgtools.tiledb_tools package
  • Submodules

Workflow Management

High-level workflow orchestration and processing pipelines.

• es_sfgtools.workflows package
  • Subpackages
  • Submodules
• es_sfgtools.workflows.preprocess_ingest package
  • Submodules
• es_sfgtools.workflows.midprocess package
  • Submodules
• es_sfgtools.workflows.modeling package
  • Submodules
• es_sfgtools.workflows.pipelines package
  • Submodules

Utilities

General utility functions and helper modules.

• es_sfgtools.utils package
  • Submodules

Module Index

Alphabetical listing of all modules:

• es_sfgtools.config.env_config module
• es_sfgtools.config.file_config module
• es_sfgtools.config.garpos_config module
• es_sfgtools.config.loadconfigs module
• es_sfgtools.config.shotdata_filters module
• es_sfgtools.config.tiledb_s3_config module
• es_sfgtools.data_mgmt.assetcatalog.handler module
• es_sfgtools.data_mgmt.assetcatalog.schemas module
• es_sfgtools.data_mgmt.assetcatalog.tables module
• es_sfgtools.data_mgmt.directorymgmt.config module
• es_sfgtools.data_mgmt.directorymgmt.handler module
• es_sfgtools.data_mgmt.directorymgmt.schemas module
• es_sfgtools.data_mgmt.utils module
• es_sfgtools.data_models.community_standards module
• es_sfgtools.data_models.constants module
• es_sfgtools.data_models.log_models module
• es_sfgtools.data_models.metadata.benchmark module
• es_sfgtools.data_models.metadata.campaign module
• es_sfgtools.data_models.metadata.catalogs module
• es_sfgtools.data_models.metadata.site module
• es_sfgtools.data_models.metadata.utils module
• es_sfgtools.data_models.metadata.vessel module
• es_sfgtools.data_models.observables module
• es_sfgtools.data_models.sv3_models module
• es_sfgtools.logging.loggers module
• es_sfgtools.modeling.garpos_tools.data_prep module
• es_sfgtools.modeling.garpos_tools.functions module
• es_sfgtools.modeling.garpos_tools.load_utils module
• es_sfgtools.modeling.garpos_tools.plotting module
• es_sfgtools.modeling.garpos_tools.schemas module
• es_sfgtools.novatel_tools.novatel_ascii_operations module
• es_sfgtools.novatel_tools.novatel_binary_operations module
• es_sfgtools.novatel_tools.utils module
• es_sfgtools.prefiltering.schemas module
• es_sfgtools.prefiltering.utils module
• es_sfgtools.pride_tools.gnss_product_operations module
• es_sfgtools.pride_tools.gnss_product_schemas module
• es_sfgtools.pride_tools.kin_file_operations module
• es_sfgtools.pride_tools.pride_cli_config module
• es_sfgtools.pride_tools.pride_file_config module
• es_sfgtools.pride_tools.pride_operations module
• es_sfgtools.pride_tools.rinex_utils module
• es_sfgtools.seafloor_site_tools.soundspeed_operations module
• es_sfgtools.sonardyne_tools.sv2_operations module
• es_sfgtools.sonardyne_tools.sv3_operations module
• es_sfgtools.sonardyne_tools.utils module
• es_sfgtools.tiledb_tools.tiledb_operations module
• es_sfgtools.tiledb_tools.tiledb_schemas module
• es_sfgtools.tiledb_tools.utils module
• es_sfgtools.utils.command_line_utils module
• es_sfgtools.utils.custom_warnings_exceptions module
• es_sfgtools.utils.model_update module
• es_sfgtools.utils.rinex_histogram module
• es_sfgtools.workflows.midprocess.mid_processing module
• es_sfgtools.workflows.midprocess.utils module
• es_sfgtools.workflows.modeling.garpos_handler module
• es_sfgtools.workflows.pipelines.config module
• es_sfgtools.workflows.pipelines.exceptions module
• es_sfgtools.workflows.pipelines.plotting module
• es_sfgtools.workflows.pipelines.shotdata_gnss_refinement module
• es_sfgtools.workflows.pipelines.sv2_ops module
• es_sfgtools.workflows.pipelines.sv2_pipeline module
• es_sfgtools.workflows.pipelines.sv3_pipeline module
• es_sfgtools.workflows.preprocess_ingest.data_handler module
• es_sfgtools.workflows.workflow_handler module