LandSea.jl

Appearance

What is a LandSea Dataset? ​

A LandSeaData type contains information on:

  • The longitude and latitude that define the grid for the Land-Sea mask of the region of interest

  • The Land-Sea mask containing information on how where land and ocean are in the region of interest

  • The topography, where available, of the region of interest

LandSea.LandSeaData Type
julia
LandSeaData

Abstract supertype for LandSea Datasets. All LandSeaData types contain the following fields:

  • lon - Vector containing the longitude points for the Land-Sea Dataset

  • lat - Vector containing the latitude points for the Land-Sea Dataset

  • lsm - Vector or Matrix containing data regarding the Land-Sea Mask. 1 is Land, 0 is Ocean, NaN is outside the bounds of the GeoRegion.

Info

If lsm is a vector, then lon, lat and lsm all must have the same length. Otherwise if lsm is a matrix, then its first and second dimensions are longitude and latitude respectively, and it must have size length(lon) and length(lat).

source

The LandSeaData abstract type has two subtypes:

  1. LandSeaFlat type, which contains only information on the Land-Sea mask but has no information on topography

  2. LandSeaTopo type, which contains information on both the Land-Sea mask and the topography

The LandSeaFlat Type ​

LandSea.LandSeaFlat Type
julia
LandSeaFlat <: LandSeaData

A LandSea Dataset that contains only information on the land-sea mask and no topography.

A LandSeaFlat type can be created using the function:

julia
LandSeaFlat(
    lon :: Vector{FT1},
    lat :: Vector{FT1},
    lsm :: Union{Vector{FT2},Matrix{FT2}}
) where {FT1 <: Real, FT2 <: Real} -> LandSeaTopo
source

The LandSeaTopo Type ​

LandSea.LandSeaTopo Type
julia
LandSeaTopo <: LandSeaData

A LandSea Dataset that also contains information on the topographic height.

A LandSeaTopo type will also contain the following field:

  • z - Vector or Array containing data regarding the Orographic Height in meters. NaN is outside the bounds of the GeoRegion

A LandSeaTopo type can be created using the function:

julia
LandSeaTopo(
    lon :: Vector{FT1},
    lat :: Vector{FT1},
    lsm :: Union{Vector{FT2},Matrix{FT2}},
    z   :: Union{Vector{FT2},Matrix{FT2}}
) where {FT1 <: Real, FT2 <: Real} -> LandSeaTopo

Info

z and lsm must both be either (1) vectors or (2) matrices of the same size. If lsm and z are vectors, then lon, lat, lsm and z all must have the same length. Otherwise if lsm and z are matrices, then their first and second dimensions are longitude and latitude respectively, and they are of size length(lon) and length(lat).

source