API

Configuration

SHTns.SHTnsCfg — Type
mutable struct SHTnsCfg{TR<:Union{Real,Complex}, N<:SHTnsNorm, T<:SHTnsType}
  • cfg::Ptr{shtns_info}
  • norm::N
  • shtype::T
  • robert_form::Bool
  • nlm::Int
  • lmax::Int
  • mmax::Int
  • mres::Int
  • nlat_2::Int
  • nlat::Int
  • nphi::Int
  • nspat::Int
  • li::Vector{Int}
  • mi::Vector{Int}
  • ct::Vector{Float64}
  • st::Vector{Float64}
  • nlat_padded::Int
  • nlm_cplx::Int
  • howmany::Int

Configuration of spherical harmonic transform.

source

Transform types (SHTnsType)

SHTns.SHTnsType — Type
abstract type SHTnsType

SHTnsType is an abstract type for the spherical harmonic transform types. All subtypes contain the following keyword arguments:

  • contiguous_lat::Bool=true
  • contiguous_phi::Bool=false
  • padding::Bool=false
  • gpu::Bool=false
  • southpolefirst::Bool=false
  • float32::Bool=false
source

Spherical harmonic normalizations (SHTnsNorm)

Transforms

The transforms from spatial space to spectral space, also called analysis, are available through SHTns.analys and SHTns.analys!. The transforms from spectral space to spatial space, also called synthesis, are available through SHTns.synth and SHTns.synth!.

SHTns.analys — Function
analys(cfg::SHTnsCfg, v)
analys(cfg::SHTnsCfg, utheta, uphi)
analys(cfg::SHTnsCfg, ur, utheta, uphi)

Transforms the spatial data into spherical harmonics coefficients qlm; slm and tlm; qlm, slm and tlm for scalar; 2D; 3D fields, respectively.

source
SHTns.analys! — Function
analys!(cfg::SHTnsCfg, v, qlm)
analys!(cfg::SHTnsCfg, utheta, uphi, slm, tlm)
analys!(cfg::SHTnsCfg, ur, utheta, uphi, qlm, slm, tlm)

In-place transforms of the spatial data into spherical harmonics coefficients for scalar, 2D or 3D fields.

Warning

This function modifies the input arrays v, ur, utheta and uphi.

source
SHTns.synth — Function
synth(cfg::SHTnsCfg, qlm)
synth(cfg::SHTnsCfg, slm, tlm)
synth(cfg::SHTnsCfg, qlm, slm, tlm)

Transforms spherical harmonics coefficients qlm into spatial data v; slm and tlm into spatial data utheta and uphi; qlm, slm and tlm into spatial data ur, utheta and uphi.

source
SHTns.synth! — Function
synth!(cfg::SHTnsCfg, qlm, v)
synth!(cfg::SHTnsCfg, slm, tlm, utheta, uphi)
synth!(cfg::SHTnsCfg, qlm, slm, tlm, ur, utheta, uphi)

In-place transforms of the spherical harmonics coefficients into spatial data for scalar, 2D or 3D fields.

source

Miscellaneous

SHTns.LM — Function
LM(cfg::SHTnsCfg{Real,T,N}, l, m)

Returns index corresponding to l and m in real spherical harmonic expansion.

source
LM(cfg::SHTnsCfg{Complex,T,N}, l, m)

Returns index corresponding to l and m in complex spherical harmonic expansion.

source
SHTns.gauss_weights — Function
gauss_weights(cfg::SHTnsCfg)

Returns Gauss quadrature weights of length cfg.nlat (shtns_gauss_wts only returns half of the symmetric weights).

source
SHTns.grid — Function
grid(cfg::SHTnsCfg)

Returns latitudes lat::Vector{Float64} and longitudes lon::Vector{Float64}.

source