s2shores package
Subpackages
- s2shores.bathy_debug package
- Submodules
- s2shores.bathy_debug.display_utils module
- s2shores.bathy_debug.local_bathy_estimator_debug module
- s2shores.bathy_debug.polar_display module
- s2shores.bathy_debug.sinogram_display module
- s2shores.bathy_debug.spatial_correlation_bathy_estimator_debug module
- s2shores.bathy_debug.spatial_correlation_wave_fields_display module
- s2shores.bathy_debug.spatial_dft_bathy_estimator_debug module
- s2shores.bathy_debug.spatial_dft_wave_fields_display module
- s2shores.bathy_debug.temporal_correlation_bathy_estimator_debug module
- s2shores.bathy_debug.waves_image_display module
- Module contents
- s2shores.bathylauncher package
- s2shores.data_model package
- Submodules
- s2shores.data_model.bathymetry_sample_estimation module
- s2shores.data_model.bathymetry_sample_estimations module
- s2shores.data_model.bathymetry_sample_inversion module
- s2shores.data_model.estimated_bathy module
- s2shores.data_model.estimated_carto_bathy module
- s2shores.data_model.estimated_points_bathy module
- s2shores.data_model.wave_field_sample_dynamics module
- s2shores.data_model.wave_field_sample_estimation module
- s2shores.data_model.wave_field_sample_geometry module
- Module contents
- s2shores.data_providers package
- s2shores.generic_utils package
- Submodules
- s2shores.generic_utils.constrained_dict module
- s2shores.generic_utils.directional_array module
- s2shores.generic_utils.directions_quantizer module
- s2shores.generic_utils.image_filters module
- s2shores.generic_utils.image_utils module
- s2shores.generic_utils.numpy_utils module
- s2shores.generic_utils.quantized_directions_dict module
- s2shores.generic_utils.signal_filters module
- s2shores.generic_utils.signal_utils module
- s2shores.generic_utils.symmetric_radon module
- s2shores.generic_utils.tiling_utils module
- Module contents
- s2shores.global_bathymetry package
- Submodules
- s2shores.global_bathymetry.bathy_config module
- s2shores.global_bathymetry.bathy_estimator module
- s2shores.global_bathymetry.bathy_estimator_parameters module
- s2shores.global_bathymetry.bathy_estimator_providers module
- s2shores.global_bathymetry.ortho_bathy_estimator module
- Module contents
- s2shores.image package
- s2shores.image_processing package
- s2shores.local_bathymetry package
- Submodules
- s2shores.local_bathymetry.local_bathy_estimator module
- s2shores.local_bathymetry.local_bathy_estimator_factory module
- s2shores.local_bathymetry.spatial_correlation_bathy_estimation module
- s2shores.local_bathymetry.spatial_correlation_bathy_estimator module
- s2shores.local_bathymetry.spatial_dft_bathy_estimation module
- s2shores.local_bathymetry.spatial_dft_bathy_estimator module
- s2shores.local_bathymetry.temporal_correlation_bathy_estimation module
- s2shores.local_bathymetry.temporal_correlation_bathy_estimator module
- Module contents
Submodules
s2shores.bathy_physics module
s2shores.waves_exceptions module
Exceptions used in bathymetry estimation
- authors:
see AUTHORS file
- organization:
CNES, LEGOS, SHOM
- copyright:
2021 CNES. All rights reserved.
- license:
see LICENSE file
- created:
20 mai 2021
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- exception s2shores.waves_exceptions.CorrelationComputationError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when correlation can not be computed
- exception s2shores.waves_exceptions.DebugDisplayError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when debug display fails
- exception s2shores.waves_exceptions.NotExploitableSinogram(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when sinogram can not be exploited
- exception s2shores.waves_exceptions.ProductNotFound(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when a product cannot be found
- exception s2shores.waves_exceptions.SequenceImagesError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when sequence images can not be properly exploited
- exception s2shores.waves_exceptions.WavesEstimationAttributeError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when an attribute is not available in an estimation.
- exception s2shores.waves_exceptions.WavesEstimationError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when an error occurs in bathymetry estimation
- exception s2shores.waves_exceptions.WavesException(reason: str | None = None)[source]
Bases:
ExceptionBase class for all waves estimation exceptions
- exception s2shores.waves_exceptions.WavesIndexingError(reason: str | None = None)[source]
Bases:
WavesExceptionException raised when a point cannot be found in the sampling with its coordinates.