Skip to content

Latest commit

 

History

History
111 lines (56 loc) · 3.83 KB

shreturntapersmap.pod

File metadata and controls

111 lines (56 loc) · 3.83 KB
Raw

SHReturnTapersMap

SHReturnTapersMap -

Calculate the eigenfunctions and eigenvalues of the space-concentration problem for an arbitrary region.

SYNOPSIS

SUBROUTINE SHReturnTapersMap (

TAPERS, EIGENVALUES, DH_MASK, N, SAMPLING, LMAX, NTAPERS )

    REAL*8

    TAPERS ( (LMAX+1)**2, (LMAX+1)**2 ) or ( (LMAX+1)**2, NTAPERS ), EIGENVALUES( LMAX+1 ) or (NTAPERS)

    INTEGER

    DH_MASK (N, N) or (N, 2*N), N, SAMPLING, LMAX

    INTEGER, OPTIONAL

    NTAPERS

DESCRIPTION

SHReturnTapersMap will calculate the eigenfunctions (i.e., localization windows) of the space-concentration problem for an arbitrary concentration region specified in DH_MASK (see Simons et al. (2006) for further details). The input mask DH_MASK must be sampled according to the Driscoll and Healy (1994) sampling theorem with N samples in latitude, and possess a value of 1 inside the concentration region, and 0 elsewhere. DH_MASK can either possess N samples in longitude (SAMPLING=1) or 2*N samples in longitude (SAMPLING=2). Given the approximate way in which the elements of the space-concentration kernel are calculated (see ComputeDMap for details), SAMPLING=2 should be preferred. Furthermore, the effective spherical harmonic bandwidth (L=N/2-1) of the grid DH_MASK determines the accuracy of the results, and experience shows that this should be about 4 times larger than LMAX.

The spherical harmonic coefficients of each window are given in the columns of TAPERS, and the corresponding concentration factors are given in EIGENVAULES. The spherical harmonic coefficients are ordered according to the scheme described in YilmIndex, which can be converted to matrix form using SHVectorToCilm, and the columns of TAPERS are ordered from best to worst concentrated. The localization windows are normalized such that they have unit power. If the optional parameter NTAPERS is specified, then only the NTAPERS largest eigenvalues and corresponding eigenfunctions will be calculated and returned.

ARGUMENTS

TAPERS

(input) REAL*8 DIMENSION ( (LMAX+1)**2, (LMAX+1)**2 ) or ( (LMAX+1)**2, NTAPERS )

The spherical harmonic coefficients of the tapers, arranged in columns, from best to worst concentrated. The spherical harmonic coefficients in each column are indexed according to the scheme described in YilmIndex.

EIGENVALUES

(input) REAL*8 DIMENSION ( (LMAX+1)**2 ) or ( NTAPERS )

The concentration factor for each localization window specified in the columns of TAPERS.

DH_MASK

(input) INTEGER, DIMENSION (N, N) or DIMENSION (N, 2*N)

A Driscoll and Healy (1994) sampled grid describing the concentration region R. All elements should either be 1 (for inside the concentration region) or 0 (for outside R).

N

(input) INTEGER

The number of latitudinal samples in DH_MASK. The effective spherical harmonic bandwidth of this grid is L = N/2 - 1.

SAMPLING

(input) INTEGER

For 1, DH_MASK has N x N samples. For 2, DH_MASK has N x 2N samples.

LMAX

(input) INTEGER

The spherical harmonic bandwidth of the localization windows.

NTAPERS

(input) INTEGER, OPTIONAL

The number of best concentrated eigenvalues and corresponding eigenfunctions to return in TAPERS and EIGENVALUES.

SEE ALSO

computedmap(1), yilmindex(1), shvectortocilm(1)

http://shtools.ipgp.fr/

REFERENCES

Driscoll, J.R. and D.M. Healy, Computing Fourier transforms and convolutions on the 2-sphere, Adv. Appl. Math., 15, 202-250, 1994.

Simons, F.J., F.A. Dahlen, and M.A. Wieczorek, Spatiospectral concentration on a sphere, SIAM Review, 48, 504-536, 2006.

COPYRIGHT AND LICENSE

Copyright 2012 by Mark Wieczorek <wieczor@ipgp.fr>.

This is free software; you can distribute and modify it under the terms of the revised BSD license.