pybacktrack.merge_paleo_bathymetry_grid
- pybacktrack.merge_paleo_bathymetry_grid(time, grid_spacing_degrees, output_filename, backtracked_paleo_bathymetry_filename, external_paleo_bathymetry_filename, *, interpolate_dynamic_topography_model=None, external_bathymetry_is_positive_below_sea_level=False, output_positive_bathymetry_below_sea_level=False, output_xyz=False)
Merge a backtracked paleobathymetry grid with an external paleobathymetry grid and write to a merged output grid file.
- Parameters:
time (float) – The reconstruction time associated with the paleobathymetry. This is only used to sample dynamic topography (when it’s specified).
grid_spacing_degrees (float) – Lat/lon grid spacing of the merged output grid (in degrees).
output_filename (string) – The filename of the merged output paleo bathymetry grid.
backtracked_paleo_bathymetry_filename (string) – The reconstructed, backtracked paleobathymetry grid (that will be merged with the external grid).
external_paleo_bathymetry_filename (string) – External paleobathymetry grid to merge into the reconstructed, backtracked paleobathymetry in
backtracked_paleo_bathymetry_filename. This is useful for filling in regions of sediment-covered crust that have subducted before present day. Regions not covered by backtracked paleobathymetry are filled with external paleobathymetry after adding dynamic topography (if specified) to them.interpolate_dynamic_topography_model (string, optional) – Optional dynamic topography model to add to external paleobathymetry grids. If specified then it should match the dynamic topography used to generate
backtracked_paleo_bathymetry_filename. Represents a time-dependent dynamic topography raster grid (in mantle frame). This is either the name of a bundled dynamic topography model (seepybacktrack.InterpolateDynamicTopography.create_from_bundled_model()), or a user-provided model specified as the filename of the grid list file (see parameter ofpybacktrack.InterpolateDynamicTopography.__init__()).external_bathymetry_is_positive_below_sea_level (bool, optional) – Whether the external bathymetry values below sea level are positive. However topography/bathymetry grids typically have negative values below sea level (and positive above). So the default (
False) matches typical topography/bathymetry grids (ie, outputs negative bathymetry values below sea level).output_positive_bathymetry_below_sea_level (bool, optional) – Whether to output positive bathymetry values below sea level (the same as backtracked water depths at a drill site). However topography/bathymetry grids typically have negative values below sea level (and positive above). So the default (
False) matches typical topography/bathymetry grids (ie, outputs negative bathymetry values below sea level).output_xyz (bool, optional) – Whether to also create a GMT xyz file (with “.xyz” extension) from the merged output paleobathymetry. Each row of each xyz file contains “longitude latitude bathymetry”. Default is to only create a grid file (no xyz).
Notes
Added in version 1.5.