Package index • ocean3d

All functions

SpatEnvelope-class: 2.5D min-max envelope: exactly depth_min, depth_max
SpatVolume-class: Union of the package's 3D domain representations
SpatVoxel-class: 3D voxel model: one layer per standard depth level
as_envelope(): Coerce a 2D footprint to a 2.5D min-max envelope
as_voxel(): Create a voxel object
calc_volume_overlap(): Per-cell 3D volume overlap between two rasterized domains
create_study_raster(): Create a study area raster grid
depths(): Depths of a voxel's layers
envelope_to_voxel(): Convert Envelope 2.5D -> Voxel 3D
extract2d(): Extract values from a 2D netCDF variable
extract3d_all(): Extract nearest, surface and bottom values from a 3D netCDF variable
extract3d_bottom(): Extract the bottom available layer from a 3D netCDF variable
extract3d_nearest(): Extract the nearest valid depth layer from a 3D netCDF variable
extract3d_surface(): Extract the surface layer from a 3D netCDF variable
extract_to_area(): Extract a 3D raster to an area and a depth band
extract_to_point(): Extract values from netCDFs to one or more point observations
fetch_species_assessments(): Fetch species assessment data from IUCN Red List API
fill_missing_depths(): Fill missing depth values
gfw_effort_to_raster(): Rasterise a GFW effort tibble onto a target grid
intersect_3d(): The 3D space two objects share
intersects_3d(): Do two objects share any 3D space?
load_gebco_bathymetry(): Load GEBCO bathymetry raster
mask(<SpatVoxel>,<SpatEnvelope>) mask(<SpatVoxel>,<SpatVoxel>) mask(<SpatEnvelope>,<SpatEnvelope>) mask(<SpatEnvelope>,<SpatVoxel>) mask(<SpatRaster>,<SpatEnvelope>) mask(<SpatRaster>,<SpatVoxel>): Keep a raster's values inside a 3D domain
occupied(): Reduce a variable voxel to a presence voxel
vect_to_envelope(): Convert SpatVector or sf to SpatEnvelope
volume(): Total 3D volume of a rasterized domain
profile_flat() profile_equal(): Vertical profiles for voxel building
voxel_to_envelope(): Collapse Voxel 3D -> Envelope 2.5D
woa_cache_clear(): Clear the WOA cache
woa_cache_dir(): WOA cache directory
woa_download(): Download a WOA NetCDF file (with caching)
woa_load_nc(): Load a WOA NetCDF file