Home > src > main > matlab > s2let_wavelet_tiling.m

s2let_wavelet_tiling

PURPOSE ^

s2let_wavelet_tiling - Compute tiling in harmonic space.

SYNOPSIS ^

function [psi_lm phi_l] = s2let_wavelet_tiling(B, L, N, Spin, J_min, varargin)

DESCRIPTION ^

 s2let_wavelet_tiling - Compute tiling in harmonic space.
 -- Spin directional wavelets on the sphere.

 Default usage :

   [psi_lm phi_l] = s2let_wavelet_tiling(B, L, N, Spin, J_min, <options>)

 psi_lm is an array containing the wavelet spherical harmonic coefficients.
 phi_l is an array containing the scaling function spherical harmonic coefficients (l only).
 B is the wavelet parameter,
 L is the angular band-limit,
 N is the azimuthal/directional band-limit,
 Spin is the spin number,
 J_min the first wavelet to be used.

 Options consist of parameter type and value pairs.
 Valid options include:
  'OriginalSpin' = [integer; if the SpinLowered option is used, this
                       option indicates which spin number the wavelets
                       should be lowered from (default = 0)]

 S2LET package to perform Wavelets transform on the Sphere.
 Copyright (C) 2012-2015  Boris Leistedt & Jason McEwen
 See LICENSE.txt for license details

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [psi_lm phi_l] = s2let_wavelet_tiling(B, L, N, Spin, J_min, varargin)
0002 
0003 % s2let_wavelet_tiling - Compute tiling in harmonic space.
0004 % -- Spin directional wavelets on the sphere.
0005 %
0006 % Default usage :
0007 %
0008 %   [psi_lm phi_l] = s2let_wavelet_tiling(B, L, N, Spin, J_min, <options>)
0009 %
0010 % psi_lm is an array containing the wavelet spherical harmonic coefficients.
0011 % phi_l is an array containing the scaling function spherical harmonic coefficients (l only).
0012 % B is the wavelet parameter,
0013 % L is the angular band-limit,
0014 % N is the azimuthal/directional band-limit,
0015 % Spin is the spin number,
0016 % J_min the first wavelet to be used.
0017 %
0018 % Options consist of parameter type and value pairs.
0019 % Valid options include:
0020 %  'OriginalSpin' = [integer; if the SpinLowered option is used, this
0021 %                       option indicates which spin number the wavelets
0022 %                       should be lowered from (default = 0)]
0023 %
0024 % S2LET package to perform Wavelets transform on the Sphere.
0025 % Copyright (C) 2012-2015  Boris Leistedt & Jason McEwen
0026 % See LICENSE.txt for license details
0027 
0028 p = inputParser;
0029 p.addRequired('B', @isnumeric);
0030 p.addRequired('L', @isnumeric);
0031 p.addRequired('N', @isnumeric);
0032 p.addRequired('Spin', @isnumeric);
0033 p.addRequired('J_min', @isnumeric);
0034 p.addParamValue('OriginalSpin', 0, @isnumeric);
0035 p.parse(B, L, N, Spin, J_min, varargin{:});
0036 args = p.Results;
0037 
0038 [psi_lm phi_l] = s2let_wavelet_tiling_mex(B, L, N, Spin, J_min, args.OriginalSpin);
0039 
0040 end

Generated on Fri 11-Nov-2016 11:50:36 by m2html © 2005