Home > src > main > matlab > s2let_hpx_map2alm_spin.m

s2let_hpx_map2alm_spin

PURPOSE ^

s2let_hpx_axisym_analysis_spin

SYNOPSIS ^

function [flmQ, flmU] = s2let_hpx_map2alm_spin(fQ, fU, varargin)

DESCRIPTION ^

 s2let_hpx_axisym_analysis_spin

 Default usage :

   flmQ, flmU = s2let_hpx_map2alm_spin(fQ, fU, <options>)

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

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

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

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