The following routines are tagged as

TitleExcerpt
BAtoHilm (Fortran) Calculate iteratively the relief along an interface of constant density contrast that corresponds to a given Bouguer anomaly using the algorithm of Wieczorek and Phillips (1998). Usage call BAtoHilm (cilm, ba, grid, lmax, nmax, mass, <code class="language-plaintext...
BAtoHilmRhoH (Fortran) Calculate iteratively the relief along an interface with lateral density variations that corresponds to a given Bouguer anomaly using the algorithm of Wieczorek and Phillips (1998). Usage call BAtoHilmRhoH (cilm, ba, grid, lmax, nmax, mass, <code class="language-plaintext...
CilmMinus (Fortran) Calculate the gravitational potential interior to relief referenced to a spherical interface using the finite-amplitude algorithm of Wieczorek and Phillips (1998). Usage call CilmMinus (cilm, gridin, lmax, nmax, mass, d, rho, gridtype, <code...
CilmMinusRhoH (Fortran) Calculate the gravitational potential interior to relief referenced to a spherical interface with laterally varying density using the finite amplitude algorithm of Wieczorek (2007). Usage call CilmMinusRhoH (cilm, gridin, lmax, nmax, mass, d, rho, <code...
CilmPlus (Fortran) Calculate the gravitational potential exterior to relief referenced to a spherical interface using the finite-amplitude algorithm of Wieczorek and Phillips (1998). Usage call CilmPlus (cilm, gridin, lmax, nmax, mass, d, rho, gridtype, <code...
CilmPlusRhoH (Fortran) Calculate the gravitational potential exterior to relief referenced to a spherical interface with laterally varying density using the finite amplitude algorithm of Wieczorek (2007). Usage call CilmPlusRhoH (cilm, gridin, lmax, nmax, mass, d, rho, <code...
ComputeDG82 (Fortran) Compute the tridiagonal matrix of Grunbaum et al. (1982) that commutes with the space-concentration kernel of a spherical cap. Usage call ComputeDG82 (dg82, lmax, m, theta0, exitstatus) Parameters dg82 : output, real(dp), dimension (<code class="language-plaintext...
ComputeDM (Fortran) Compute the space-concentration kernel of a spherical cap. Usage call ComputeDM (dm, lmax, m, theta0, degrees, exitstatus) Parameters dm : output, real(dp), dimension (lmax+1, lmax+1) The space-concentration kernel of...
ComputeDMap (Fortran) Compute the space-concentration kernel of an arbitrary mask on the sphere. Usage call ComputeDMap (dij, dh_mask, n, lmax, sampling, degrees, exitstatus) Parameters dij : output, real(dp), dimension ( (lmax+1)**2,...
Curve2Mask (Fortran) Given a set of latitude and longitude coordinates representing a closed curve, output a gridded binary mask. Usage call Curve2Mask (mask_dh, n, sampling, profile, nprofile, np, extend, exitstatus) Parameters <code class="language-plaintext...
DHaj (Fortran) Compute the latitudinal weights used in the Driscoll and Healy (1994) spherical harmonic transform. Usage call DHaj (n, aj, exitstatus) Parameters n : input, integer(int32) The number of samples in latitude used in the spherical harmonic transform. This must...
djpi2 (Fortran) Compute the rotation matrix d(pi/2) used in rotating data expressed in spherical harmonics. Usage call djpi2 (dj, lmax, exitstatus) Parameters dj : output, real(dp), dimension (lmax+1, lmax+1, lmax+1) The rotation matrix dj(pi/2). <code...
DownContFilterMA (Fortran) Compute the minimum-amplitude downward continuation filter of Wieczorek and Phillips (1998). Usage wl = DownContFilterMA (l, half, r, d) Parameters wl : output, real(dp) The amplitude of the downward continuation filter. l :...
DownContFilterMC (Fortran) Calculate a minimum-curvature downward continuation filter for a given spherical harmonic degree. Usage wl = DownContFilterMC (l, half, r, d) Parameters wl : output, real(dp) The amplitude of the downward continuation filter. l...
EigValSym (Fortran) Compute the eigenvalues of a real symmetric matrix. Usage call EigValSym (ain, n, eval, ul) Parameters ain : input, real(dp), dimension (n, n) The input real symmetric matrix. By default, only the upper...
EigValVecSym (Fortran) Compute the eigenvalues and eigenvectors of a real symmetric matrix. Usage call EigValVecSym (ain, n, eval, evec, ul, k, exitstatus) Parameters ain : input, real(dp), dimension (n, <code class="language-plaintext...
EigValVecSymTri (Fortran) Compute the eigenvalues and eigenvectors of a real symmetric tridiagonal matrix. Usage call EigValVecSymTri (ain, n, eval, evec, ul, exitstatus) Parameters ain : input, real(dp), dimension (n, n) The...
GLQGridCoord (Fortran) Compute the latitude and longitude coordinates used in Gauss-Legendre quadrature grids. Usage call GLQGridCoord (latglq, longlq, lmax, nlat, nlong, extend, exitstatus) Parameters latglq : output, real(dp), dimension (lmax+1) The...
LSQ_G (Fortran) Compute the data kernel matrix G that is used when computing spherical harmonic coefficients by least squares inversion. Usage call LSQ_G (g, lat, lon, nmax, lmax, norm, csphase, exitstatus) Parameters <code...
MakeCircleCoord (Fortran) Compute the coordinates of a circle placed at a given latitude and longitude. Usage call MakeCircleCoord (coord, lat, lon, theta0, cinterval, cnum, exitstatus) Parameters coord : output, real(dp), dimension(360/cinterval,...
MakeEllipseCoord (Fortran) Compute the coordinates of an ellipse placed at a given latitude and longitude. Usage call MakeEllipseCoord (coord, lat, lon, dec, a_theta, b_theta, cinterval, cnum, exitstatus) Parameters coord...
MakeGeoidGrid (Fortran) Create a global map of the geoid. Usage call MakeGeoidGrid (geoid, cilm, lmax, r0, gm, potref, omega, r, gridtype, order, nlat, nlong, interval,...
MakeGradientDH (Fortran) Compute the gradient of a scalar function and return grids of the two horizontal components that conform with Driscoll and Healy’s (1994) sampling theorem. Usage call MakeGradientDH (cilm, lmax, theta, phi, n, sampling, lmax_calc, <code...
MakeGravGradGridDH (Fortran) Create 2D cylindrical maps on a flattened ellipsoid of the components of the gravity “gradient” tensor in a local north-oriented reference frame. Usage call MakeGravGradGridDH (cilm, lmax, gm, r0, a, f, vxx, vyy,...
MakeGravGridDH (Fortran) Create 2D cylindrical maps on a flattened and rotating ellipsoid of all three components of the gravity, the gravity disturbance, and the gravity potential. Usage call MakeGravGridDH (cilm, lmax, gm, r0, a, f, rad, <code...
MakeGravGridPoint (Fortran) Determine the three components of the gravity vector at a single point. Usage value = MakeGravGridPoint (cilm, lmax, gm, r0, r, lat, lon, omega, dealloc) Parameters <code...
MakeGrid2D (Fortran) Create a 2D cylindrical map of arbitrary grid spacing from a set of spherical harmonic coefficients. Usage call MakeGrid2D (grid, cilm, lmax, interval, nlat, nlong, norm, csphase, f, a,...
MakeGridDH (Fortran) Create a 2D map from a set of spherical harmonic coefficients that conforms with Driscoll and Healy’s (1994) sampling theorem. Usage call MakeGridDH (griddh, n, cilm, lmax, norm, sampling, csphase, lmax_calc, <code class="language-plaintext...
MakeGridDHC (Fortran) Create a 2D complex map from a set of complex spherical harmonic coefficients that conforms with Driscoll and Healy’s (1994) sampling theorem. Usage call MakeGridDHC (griddh, n, cilm, lmax, norm, sampling, csphase, lmax_calc,...
MakeGridGLQ (Fortran) Create a 2D map from a set of spherical harmonic coefficients sampled on the Gauss-Legendre quadrature nodes. Usage call MakeGridGLQ (gridglq, cilm, lmax, plx, zero, norm, csphase, lmax_calc, extend, <code class="language-plaintext...
MakeGridGLQC (Fortran) Create a 2D complex map from a set of complex spherical harmonic coefficients sampled on the Gauss-Legendre quadrature nodes. Usage call MakeGridGLQC (gridglq, cilm, lmax, plx, zero, norm, csphase, lmax_calc, extend,...
MakeGridPoint (Fortran) Evaluate a real function expressed in real spherical harmonics at a single point. Usage value = MakeGridPoint (cilm, lmax, lat, lon, norm, csphase, dealloc) Parameters value : output, real(dp)...
MakeGridPointC (Fortran) Evaluate a complex function expressed in complex spherical harmonics at a single point. Usage value = MakeGridPointC (cilm, lmax, lat, lon, norm, csphase, dealloc) Parameters value : output, complex(dp)...
MakeMagGradGridDH (Fortran) Create 2D cylindrical maps on a flattened ellipsoid of the components of the magnetic field tensor in a local north-oriented reference frame. Usage call MakeMagGradGridDH (cilm, lmax, r0, a, f, vxx, vyy, vzz,...
MakeMagGridDH (Fortran) Create 2D cylindrical maps on a flattened ellipsoid of all three vector components of the magnetic field, the magnitude of the magnetic field, and the magnetic potential. Usage call MakeMagGridDH (cilm, lmax, r0, a, f, rad, <code...
MakeMagGridPoint (Fortran) Determine the three components of the magnetic field vector at a single point. Usage value = MakeMagGridPoint (cilm, lmax, a, r, lat, lon, dealloc) Parameters value : output, real(dp),...
NormalGravity (Fortran) Calculate the normal gravity on an ellipsoid or sphere using geocentric coordinates. Usage value = NormalGravity (geocentriclat, gm, omega, a, b) Parameters value : output, real(dp) The normal gravity in SI units. <code...
PlanetsConstants The PlanetsConstants module defines several constants that are used in analyzing gravity, topography, and magnetic field data of the terrestrial planets. Confer with the Python attributes of the constant for exact values and references. All units...
PlBar (Fortran) Compute all the 4-pi (geodesy) normalized Legendre polynomials. Usage call PlBar (p, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of geodesy-normalized Legendre polynomials up to degree lmax. Degree...
PlBar_d1 (Fortran) Compute all the 4-pi (geodesy) normalized Legendre polynomials and first derivatives. Usage call PlBar_d1 (p, dp, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of 4-pi (geodesy) normalized Legendre...
PLegendre (Fortran) Compute all the unnormalized Legendre polynomials. Usage call PLegendre (p, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of unnormalized Legendre polynomials up to degree lmax. Degree <code class="language-plaintext...
PLegendre_d1 (Fortran) Compute all the unnormalized Legendre polynomials and first derivatives. Usage call PLegendre_d1 (p, dp, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of unnormalized Legendre polynomials up to degree...
PLegendreA (Fortran) Compute all the unnormalized associated Legendre functions. Usage call PLegendreA (p, lmax, z, csphase, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2) An array of unnormalized associated Legendre functions up to...
PLegendreA_d1 (Fortran) Compute all the unnormalized associated Legendre functions and first derivatives. Usage call PLegendreA_d1 (p, dp, lmax, z, csphase, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2) An array of...
PlmBar (Fortran) Compute all the 4-pi (geodesy) normalized associated Legendre functions. Usage call PlmBar (p, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2) An array of 4-pi...
PlmBar_d1 (Fortran) Compute all the 4-pi (geodesy) normalized associated Legendre functions and first derivatives. Usage call PlmBar_d1 (p, dp, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(<code...
PlmIndex (Fortran) Compute the index of an array corresponding to degree l and angular order m. Usage index = PlmIndex (l, m) Parameters index : function output, integer(int32) Index of an array of associated Legendre functions corresponding...
PlmON (Fortran) Compute all the orthonormalized associated Legendre functions. Usage call PlmON (p, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2) An array of orthonormalized associated Legendre...
PlmON_d1 (Fortran) Compute all the orthonormalized associated Legendre functions and first derivatives. Usage call PlmON_d1 (p, dp, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2)...
PlmSchmidt (Fortran) Compute all the Schmidt semi-normalized associated Legendre functions. Usage call PlmSchmidt (p, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(lmax+2)/2) An array of Schmidt-normalized associated...
PlmSchmidt_d1 (Fortran) Compute all the Schmidt semi-normalized associated Legendre functions and first derivatives. Usage call PlmSchmidt_d1 (p, dp, lmax, z, csphase, cnorm, exitstatus) Parameters p : output, real(dp), dimension ((lmax+1)*(<code class="language-plaintext...
PlON (Fortran) Compute all the orthonormalized Legendre polynomials. Usage call PlON (p, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of orthonormalized Legendre polynomials up to degree lmax. Degree <code class="language-plaintext...
PlON_d1 (Fortran) Compute all the orthonormalized Legendre polynomials and first derivatives. Usage call PlON_d1 (p, dp, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of orthonormalized Legendre polynomials up to degree...
PlSchmidt (Fortran) Compute all the Schmidt-normalized Legendre polynomials. Usage call PlSchmidt (p, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of Schmidt-normalized Legendre polynomials up to degree lmax. Degree <code class="language-plaintext...
PlSchmidt_d1 (Fortran) Compute all the Schmidt-normalized Legendre polynomials and first derivatives. Usage call PlSchmidt_d1 (p, dp, lmax, z, exitstatus) Parameters p : output, real(dp), dimension (lmax+1) An array of Schmidt-normalized Legendre polynomials up to degree...
PreGLQ (Fortran) Calculate the weights and nodes used in integrating a function by Gauss-Legendre quadrature. Usage call PreGLQ (lower, upper, n, zero, w, exitstatus) Parameters lower : input, real(dp) The lower bound of the integration....
RandomGaussian (Fortran) Return a pseudo-Gaussian deviate of zero mean and unit variance. Usage rg = RandomGaussian (seed) Parameters rg : output, real(dp) The radom Gaussian deviate. seed : input/output, integer(int32) Input a negative integer to (re-)initialize the random number generator. Afterwards,...
RandomN (Fortran) Return a pseudo uniform random deviate between 0 and 1 using the algorithm of Park and Miller with a Marsaglia shift sequence. Usage rn = RandomN (seed) Parameters rn : output, real(dp) The uniform random deviate. seed : input/output,...
SHAdmitCorr (Fortran) Calculate the admittance and correlation spectra of two real functions. Usage call SHAdmitCorr (gilm, tilm, lmax, admit, corr, admit_error, exitstatus) Parameters gilm : input, real(dp), dimension (2, lmaxg+1, <code...
SHBias (Fortran) Calculate the (cross-)power spectrum expectation of a windowed function from its global spectrum. Usage call SHBias (shh, lwin, incspectra, ldata, outcspectra, save_cg, exitstatus) Parameters shh : input, real(dp), dimension (<code class="language-plaintext...
SHBiasAdmitCorr (Fortran) Calculate the expected multitaper admittance and correlation spectra associated with the input global cross-power spectra of two functions. Usage call SHBiasAdmitCorr (sgt, sgg, stt, lmax, tapers, lwin, k, admit, corr, <code...
SHBiasK (Fortran) Calculate the multitaper (cross-)power spectrum expectation of a function localized by spherical cap windows. Usage call SHBiasK (tapers, lwin, k, incspectra, ldata, outcspectra, taper_wt, save_cg, exitstatus) Parameters <code class="language-plaintext...
SHBiasKMask (Fortran) Calculate the multitaper (cross-)power spectrum expectation of a function localized by arbitrary windows derived from a mask. Usage call SHBiasK (tapers, lwin, k, incspectra, ldata, outcspectra, taper_wt, save_cg, exitstatus) Parameters...
SHCilmToCindex (Fortran) Convert a three-dimensional array of spherical harmonic coefficients to a two-dimensional indexed array. Usage call SHCilmToCindex (cilm, cindex, degmax, exitstatus) Parameters cilm : input, real(dp), dimension (2, lmaxin+1, lmaxin+1) The input spherical harmonic...
SHCilmToVector (Fortran) Convert a three-dimensional array of real spherical harmonic coefficients to a 1-dimensional indexed vector. Usage call SHCilmToVector (cilm, vector, lmax, exitstatus) Parameters cilm : input, real(dp), dimension (2, lmax+1, lmax+1) The input real...
SHCindexToCilm (Fortran) Convert a two-dimensional indexed array of spherical harmonic coefficients to a three-dimensional array. Usage call SHCindexToCilm (cindex, cilm, degmax, exitstatus) Parameters cindex : input, real(dp), dimension (2, (lmaxin+1)*(lmaxin+2)/2) The indexed spherical harmonic coefficients....
SHConfidence (Fortran) Compute the probability that two functions are correlated at a given spherical harmonic degree for a given correlation coefficient. Usage prob = SHConfidence (l, corr) Parameters prob : output, real(dp) Probability that two functions expressed in spherical coefficients with...
SHCrossPowerDensityL (Fortran) Compute the cross-power spectral density of two real functions for a single spherical harmonic degree. Usage cpsd = SHCrossPowerDensityL (cilm1, cilm2, l) Parameters cpsd : output, real(dp) Cross-power spectral density of the two real functions for spherical...
SHCrossPowerDensityLC (Fortran) Compute the cross-power spectral density of two complex functions for a single spherical harmonic degree. Usage cpsd = SHCrossPowerDensityLC (cilm1, cilm2, l) Parameters cpsd : output, complex(dp) The cross-power spectral density of the two complex functions for...
SHCrossPowerL (Fortran) Compute the cross-power of two real functions for a single spherical harmonic degree. Usage cpower = SHCrossPowerL (cilm1, cilm2, l) Parameters cpower : output, real(dp) The cross power of the two functions for spherical harmonic degree <code...
SHCrossPowerLC (Fortran) Compute the cross-power of two complex functions for a single spherical harmonic degree. Usage cpower = SHCrossPowerLC (cilm1, cilm2, l) Parameters cpower : output, complex(dp) Cross power of the two complex functions for spherical harmonic degree <code...
SHCrossPowerSpectrum (Fortran) Compute the cross-power spectrum of two real functions. Usage call SHCrossPowerSpectrum (cilm1, cilm2, lmax, cspectrum, exitstatus) Parameters cilm1 : input, real(dp), dimension (2, lmaxin1+1, lmaxin1+1) The first function expressed in real...
SHCrossPowerSpectrumC (Fortran) Compute the cross-power spectrum of two complex functions. Usage call SHCrossPowerSpectrumC (cilm1, cilm2, lmax, cspectrum, exitstatus) Parameters cilm1 : input, complex(dp), dimension (2, lmaxin1+1, lmaxin1+1) The complex spherical harmonics of the...
SHCrossPowerSpectrumDensity (Fortran) Compute the cross-power spectral density of two real functions. Usage call SHCrossPowerSpectrumDensity (cilm1, cilm2, lmax, cspectrum, exitstatus) Parameters cilm1 : input, real(dp), dimension (2, lmaxin1+1, lmaxin1+1) The first function expressed in...
SHCrossPowerSpectrumDensityC (Fortran) Compute the cross-power spectral density of two complex functions. Usage call SHCrossPowerSpectrumDensityC (cilm1, cilm2, lmax, cspectrum, exitstatus) Parameters cilm1 : input, complex(dp), dimension (2, lmaxin1+1, lmaxin1+1) The complex spherical harmonics of...
SHctor (Fortran) Convert complex spherical harmonics to real form. Usage call SHctor (ccilm, rcilm, degmax, convention, switchcs, exitstatus) Parameters ccilm : input, real(dp), dimension (2, lmaxin+1, lmaxin+1) The input complex spherical...
SHExpandDH (Fortran) Expand an equally sampled or equally spaced grid into spherical harmonics using Driscoll and Healy’s (1994) sampling theorem. Usage call SHExpandDH (griddh, n, cilm, lmax, norm, sampling, csphase, lmax_calc, exitstatus) <h2...
SHExpandDHC (Fortran) Expand an equally sampled or equally spaced complex grid into complex spherical harmonics using Driscoll and Healy’s (1994) sampling theorem. Usage call SHExpandDHC (griddh, n, cilm, lmax, norm, sampling, csphase, lmax_calc, <code class="language-plaintext...
SHExpandGLQ (Fortran) Expand a 2D grid sampled on the Gauss-Legendre quadrature nodes into spherical harmonics. Usage call SHExpandGLQ (cilm, lmax, gridglq, w, plx, zero, norm, csphase, lmax_calc, exitstatus) Parameters ...
SHExpandGLQC (Fortran) Expand a 2D grid sampled on the Gauss-Legendre quadrature nodes into spherical harmonics. Usage call SHExpandGLQC (cilm, lmax, gridglq, w, plx, zero, norm, csphase, lmax_calc, exitstatus) Parameters ...
SHExpandLSQ (Fortran) Determine the spherical harmonic coefficients of an irregularly sampled function using a (weighted) least squares inversion. Usage call SHExpandLSQ (cilm, d, lat, lon, nmax, lmax, norm, chi2, csphase, weights,...
SHFindLWin (Fortran) Determine the spherical-harmonic bandwidth that is necessary to achieve a certain concentration factor. Usage lwin = SHFindLWin (theta0, m, alpha, taper_number) Parameters lwin : output, integer(int32) The spherical harmonic bandwidth theta0 : input,...
SHGLQ (Fortran) Precompute weights, nodes, and associated Legendre functions used in the Gauss-Legendre quadrature based spherical harmonics routines. Usage call SHGLQ (lmax, zero, w, plx, norm, csphase, cnorm, exitstatus) Parameters lmax...
SHLocalizedAdmitCorr (Fortran) Calculate the localized admittance and correlation spectra of two functions at a given location using spherical cap localization windows. Usage call SHLocalizedAdmitCorr (tapers, taper_order, lwin, lat, lon, gilm, tilm, lmax, admit,...
SHMagPowerL (Fortran) Compute the power of the magnetic field for a single degree l given the Schmidt seminormalized magnetic potential spherical harmonic coefficients. Usage power = SHMagPowerL (cilm, a, r, l) Parameters power : output,...
SHMagPowerSpectrum (Fortran) Compute the power spectrum of the magnetic field given the Schmidt seminormalized magnetic potential spherical harmonic coefficients. Usage call SHMagPowerSpectrum (cilm, a, r, lmax, spectrum, exitstatus) Parameters cilm : input, real(dp), dimension (2,...
SHMTCouplingMatrix (Fortran) This routine returns the multitaper coupling matrix for a given set of power spectra of arbitrary localization windows. This matrix relates the expectation of the localized multitaper spectrum to the expectation of the power spectrum of the global function. Usage call SHMTCouplingMatrix (mmt, lmax,<code class="language-plaintext...
SHMTDebias (Fortran) Invert for the global power spectrum given a multitaper spectrum estimate formed with spherical cap localization windows. Usage call SHMTDebias (mtdebias, mtspectra, lmax, tapers, lwin, k, nl, lmid, n, <code class="language-plaintext...
SHMTVar (Fortran) Calculate the theoretical variance of a multitaper spectral estimate for a given input power spectrum. Usage call SHMTVar (l, tapers, taper_order, lwin, kmax, sff, variance, taper_wt, unweighted_covar, nocross, <code...
SHMTVarOpt (Fortran) Calculate the theoretical minimum variance of a localized multitaper spectral estimate and the corresponding optimal weights to apply to each localized spectrum. Usage call SHMTVarOpt (l, tapers, taper_order, lwin, kmax, sff, var_opt, var_unit,...
SHMultiply (Fortran) Multiply two functions and determine the spherical harmonic coefficients of the resulting function. Usage call SHMultiply (cilmout, cilm1, lmax1, cilm2, lmax2, precomp, norm, csphase, exitstatus) Parameters cilmout...
SHMultiTaperCSE (Fortran) Perform a localized multitaper cross-spectral analysis using spherical cap windows. Usage call SHMultiTaperCSE (mtse, sd, cilm1, lmax1, cilm2, lmax2, tapers, taper_order, lmaxt, k, alpha, lat,...
SHMultiTaperMaskCSE (Fortran) Perform a localized multitaper cross-spectral analysis using using arbitrary windows derived from a mask. Usage call SHMultiTaperMaskCSE (mtse, sd, cilm1, lmax1, cilm2, lmax2, tapers, lmaxt, k, taper_wt, <code class="language-plaintext...
SHMultiTaperMaskSE (Fortran) Perform a localized multitaper spectral analysis using arbitrary windows derived from a mask. Usage call SHMultiTaperMaskSE (mtse, sd, cilm, lmax, tapers, lmaxt, k, taper_wt, norm, csphase, exitstatus)...
SHMultiTaperSE (Fortran) Perform a localized multitaper spectral analysis using spherical cap windows. Usage call SHMultiTaperSE (mtse, sd, cilm, lmax, tapers, taper_order, lmaxt, k, alpha, lat, lon, taper_wt,...
SHPowerDensityL (Fortran) Compute the power spectral density of a real function for a single spherical harmonic degree. Usage psd = SHPowerDensityL (cilm, l) Parameters psd : output, real(dp) Power spectral density of the function for the spherical harmonic degree <code class="language-plaintext...
SHPowerDensityLC (Fortran) Compute the power spectral density of a complex function for a single spherical harmonic degree. Usage psd = SHPowerDensityLC (cilm, l) Parameters psd : output, real(dp) Power spectral density of the complex function for spherical harmonic degree <code class="language-plaintext...
SHPowerL (Fortran) Compute the power of a real function for a single spherical harmonic degree. Usage power = SHPowerL (cilm, l) Parameters power : output, real(dp) Power of the function for a single spherical harmonic degree l. <code class="language-plaintext...
SHPowerLC (Fortran) Compute the power of a complex function for a single spherical harmonic degree. Usage power = SHPowerLC (cilm, l) Parameters power : output, real(dp) Power of the complex function for spherical harmonic degree l. cilm...
SHPowerSpectrum (Fortran) Compute the power spectrum of a real function. Usage call SHPowerSpectrum (cilm, lmax, pspectrum, exitstatus) Parameters cilm : input, real(dp), dimension (2, lmaxin+1, lmaxin+1) The function expressed in real spherical harmonics. <code class="language-plaintext...
SHPowerSpectrumC (Fortran) Compute the power spectrum of a complex function. Usage call SHPowerSpectrumC (cilm, lmax, pspectrum, exitstatus) Parameters cilm : input, complex(dp), dimension (2, lmaxin+1, lmaxin+1) The complex function expressed in complex spherical harmonics. <code...
SHPowerSpectrumDensity (Fortran) Compute the power spectral density of a real function. Usage call SHPowerSpectrumDensity (cilm, lmax, pspectrum, exitstatus) Parameters cilm : input, real(dp), dimension (2, lmaxin+1, lmaxin+1) The real function expressed in real spherical harmonics....
SHPowerSpectrumDensityC (Fortran) Compute the power spectral density of a complex function. Usage call SHPowerSpectrumDensityC (cilm, lmax, pspectrum, exitstatus) Parameters cilm : input, complex(dp), dimension (2, lmaxin+1, lmaxin+1) The complex function expressed in complex spherical harmonics....
SHRead (Fortran) Read spherical harmonic coefficients from an ascii-formatted file. Usage call SHRead (filename, cilm, lmax, skip, header, error, exitstatus) Parameters filename : input, character(:) The filename of the ascii file containing the...
SHRead2 (Fortran) Read spherical harmonic coefficients from a CHAMP or GRACE-like ascii-formatted file. Usage call SHRead2 (filename, cilm, lmax, gm, r0_pot, error, dot, doystart, doyend, epoch, exitstatus) Parameters...
SHReadJPL (Fortran) Read spherical harmonic coefficients from a JPL ascii-formatted file. Usage call SHReadJPL (filename, cilm, lmax, error, gm, formatstring, exitstatus) Parameters filename : input, character(*) The filename of the JPL ascii formatted...
SHReturnTapers (Fortran) Calculate the eigenfunctions of the spherical-cap concentration problem. Usage call SHReturnTapers (theta0, lmax, tapers, eigenvalues, taper_order, degrees, exitstatus) Parameters theta0 : input, real(dp) The angular radius of the spherical cap in...
SHReturnTapersM (Fortran) Calculate the eigenfunctions of the spherical-cap concentration problem for a single angular order. Usage call SHReturnTapersM (theta0, lmax, m, tapers, eigenvalues, shannon, degrees, ntapers, exitstatus) Parameters theta0...
SHReturnTapersMap (Fortran) Calculate the eigenfunctions and eigenvalues of the space-concentration problem for an arbitrary region. Usage call SHReturnTapersMap (tapers, eigenvalues, dh_mask, n, lmax, sampling, ntapers, degrees, exitstatus) Parameters tapers...
SHRotateCoef (Fortran) Determine the spherical harmonic coefficients of a real function expressed in complex harmonics rotated by three Euler angles. Usage call SHRotateCoef (x, coef, rcoef, dj, lmax, exitstatus) Parameters x : input, real(dp), dimension(3)...
SHRotateRealCoef (Fortran) Determine the spherical harmonic coefficients of a real function rotated by three Euler angles. Usage call SHRotateRealCoef (cilmrot, cilm, lmax, x, dj, exitstatus) Parameters cilmrot : output, real(dp), dimension (2, lmax+1,...
SHRotateTapers (Fortran) Rotate orthogonal spherical-cap Slepian functions centered at the North pole to a different location. Usage call SHRotateTapers(tapersrot, tapers, taper_order, lmax, nrot, x, dj, exitstatus) Parameters tapersrot : output, real(dp),...
SHrtoc (Fortran) Convert real spherical harmonics to complex form. Usage call SHrtoc (rcilm, ccilm, degmax, convention, switchcs, exitstatus) Parameters rcilm : input, real(dp), dimension (2, lmaxin+1, lmaxin+1) The input real spherical...
SHSCouplingMatrix (Fortran) This routine returns the spherical harmonic coupling matrix for a given set of Slepian basis functions. This matrix relates the power spectrum expectation of the function expressed in a subset of the best-localized Slepian functions to the expectation of the global power spectrum. Usage call SHSCouplingMatrix (kij,...
SHSCouplingMatrixCap (Fortran) This routine returns the spherical harmonic coupling matrix for a given set of spherical-cap Slepian basis functions. This matrix relates the power spectrum expectation of the function expressed in a subset of the best-localized Slepian functions to the expectation of the global power spectrum. Usage call SHSCouplingMatrixCap (<code class="language-plaintext...
SHSjkPG (Fortran) Calculate the expectation of the product of two functions, each multiplied by a different data taper, for a given spherical harmonic degree and two different angular orders. Usage value = SHSjkPG (incspectra, l, m, mprime, hj_real, <code...
SHSlepianVar (Fortran) Calculate the theoretical variance of the power of a function expanded in spherical-cap Slepian functions for a given spherical harmonic degree. Usage call SHSlepianVar (l, galpha, galpha_order, lmax, kmax, sff, variance, exitstatus) <h2...
SHTOOLS (Fortran) SHTOOLS is a Fortran-95 library that can be used for spherical harmonic transforms, multitaper spectral analyses, expansions of gridded data into Slepian basis functions, and standard operations on global gravitational and magnetic field data. Features Supports all standard normalizations and phase conventions of the spherical harmonic functions. Use...
SHVectorToCilm (Fortran) Convert a 1-dimensional indexed vector of real spherical harmonic coefficients to a three-dimensional array. Usage call SHVectorToCilm (vector, cilm, lmax, exitstatus) Parameters vector : input, real(dp), dimension ( (lmax+1)**2 ) The input 1-D indexed array...
SlepianCoeffs (Fortran) Determine the expansion coefficients of a function for a given set of input Slepian functions. Usage call SlepianCoeffs(falpha, galpha, film, lmax, nmax, exitstatus) Parameters falpha : output, real(dp), dimension (nmax) A...
SlepianCoeffsToSH (Fortran) Convert a function expressed in Slepian coefficients to spherical harmonic coefficients. Usage call SlepianCoeffsToSH(film, falpha, galpha, lmax, nmax, exitstatus) Parameters film : output, real(dp), dimension (2, lmax+1, lmax+1) The...
SphericalCapCoef (Fortran) Calculate the spherical harmonic coefficients of a spherical cap. Usage call SphericalCapCoef (coef, theta, lmax, exitstatus) Parameters coef : output, real(dp), dimension(lmaxin+1) The zonal spherical harmonic coefficients of a spherical cap centered over the north...
Wigner3j (Fortran) Compute the Wigner-3j symbols for all allowable values of J. ## Usage call Wigner3j (`w3j`, `jmin`, `jmax`, `j2`, `j3`, `m1`, `m2`, `m3`, `exitstatus`) ## Parameters `w3j` : output, real(dp), dimension (`j2`+`j3`+1) : An array of the Wigner-3j symbols evaluated for all allowable values of `j`. The minimum and maximum values...
YilmIndexVector (Fortran) Compute the index of an 1D array of spherical harmonic coefficients corresponding to `i`, `l`, and `m`. ## Usage `index` = YilmIndexVector (`i`, `l`, `m`) ## Parameters `index` : output, integer(int32) : Index of an 1D array of spherical harmonic coefficients corresponding to `i`, `l`, and `m`. `i` : input,...
Edit me