Home > src > main > matlab > s2let_hpx_map2alm.m

s2let_hpx_map2alm

PURPOSE ^

s2let_hpx_axisym_analysis

SYNOPSIS ^

function flm = s2let_hpx_map2alm(f, varargin)

DESCRIPTION ^

 s2let_hpx_axisym_analysis 
 Compute axisymmetric wavelet transform, output as HEALPIX maps.

 Default usage :

   flm = s2let_hpx_map2alm(f, <options>)

 f is the input field -- HEALPIX sampling,
 flm is the output spherical harmonic decomposition.

 Option :
  'nside'           = { HEALPIX resolution; (default=guessed)}
  'L'               = { Harmonic band-limit; L > 1 (default=2*nside) }

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function flm = s2let_hpx_map2alm(f, varargin)
0002 
0003 % s2let_hpx_axisym_analysis
0004 % Compute axisymmetric wavelet transform, output as HEALPIX maps.
0005 %
0006 % Default usage :
0007 %
0008 %   flm = s2let_hpx_map2alm(f, <options>)
0009 %
0010 % f is the input field -- HEALPIX sampling,
0011 % flm is the output spherical harmonic decomposition.
0012 %
0013 % Option :
0014 %  'nside'           = { HEALPIX resolution; (default=guessed)}
0015 %  'L'               = { Harmonic band-limit; L > 1 (default=2*nside) }
0016 
0017 % S2LET package to perform Wavelets transform on the Sphere.
0018 % Copyright (C) 2012-2015  Boris Leistedt & Jason McEwen
0019 % See LICENSE.txt for license details
0020 
0021 sz = size(f);
0022 nsideguessed = sqrt(max(sz)/12);
0023 Lguessed = 2*nsideguessed;
0024 
0025 p = inputParser;
0026 p.addRequired('f', @isnumeric); 
0027 p.addParamValue('nside', nsideguessed, @isnumeric);   
0028 p.addParamValue('L', Lguessed, @isnumeric);   
0029 p.parse(f, varargin{:});
0030 args = p.Results;
0031 
0032 flm = s2let_hpx_map2alm_mex(f, args.nside, args.L);
0033 
0034 end

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