Home > src > main > matlab > s2let_transform_axisym_analysis_hpx.m

s2let_transform_axisym_analysis_hpx

PURPOSE ^

s2let_transform_axisym_analysis_hpx

SYNOPSIS ^

function [f_wav, f_scal] = s2let_transform_axisym_analysis_hpx(f, varargin)

DESCRIPTION ^

 s2let_transform_axisym_analysis_hpx 
 Compute axisymmetric wavelet transform, output as HEALPIX maps.

 Default usage :

   [f_wav, f_scal] = s2let_transform_axisym_analysis_hpx(f, <options>)

 f is the input field -- HEALPIX sampling,
 f_wav contains the output wavelet contributions,
 f_scal contains the output scaling contributions,

 Option :
  'nside'           = { HEALPIX resolution; (default=guessed)}
  'B'               = { Dilation factor; B > 1 (default=2) }
  'L'               = { Harmonic band-limit; L > 1 (default=2*nside) }
  'J_min'           = { Minimum wavelet scale to consider;
                        0 <= J_min < log_B(L) (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 [f_wav, f_scal] = s2let_transform_axisym_analysis_hpx(f, varargin)
0002 
0003 % s2let_transform_axisym_analysis_hpx
0004 % Compute axisymmetric wavelet transform, output as HEALPIX maps.
0005 %
0006 % Default usage :
0007 %
0008 %   [f_wav, f_scal] = s2let_transform_axisym_analysis_hpx(f, <options>)
0009 %
0010 % f is the input field -- HEALPIX sampling,
0011 % f_wav contains the output wavelet contributions,
0012 % f_scal contains the output scaling contributions,
0013 %
0014 % Option :
0015 %  'nside'           = { HEALPIX resolution; (default=guessed)}
0016 %  'B'               = { Dilation factor; B > 1 (default=2) }
0017 %  'L'               = { Harmonic band-limit; L > 1 (default=2*nside) }
0018 %  'J_min'           = { Minimum wavelet scale to consider;
0019 %                        0 <= J_min < log_B(L) (default=0) }
0020 %
0021 % S2LET package to perform Wavelets transform on the Sphere.
0022 % Copyright (C) 2012-2015  Boris Leistedt & Jason McEwen
0023 % See LICENSE.txt for license details
0024 
0025 sz = size(f);
0026 nsideguessed = sqrt(max(sz)/12);
0027 Lguessed = 2*nsideguessed;
0028 
0029 p = inputParser;
0030 p.addRequired('f', @isnumeric); 
0031 p.addParamValue('nside', nsideguessed, @isnumeric);   
0032 p.addParamValue('B', 2, @isnumeric);   
0033 p.addParamValue('L', Lguessed, @isnumeric);   
0034 p.addParamValue('J_min', 0, @isnumeric); 
0035 p.parse(f, varargin{:});
0036 args = p.Results;
0037 
0038 [f_wav_vec, f_scal] = s2let_transform_axisym_analysis_hpx_mex(f, args.nside, args.B, args.L, args.J_min);
0039 
0040 J = s2let_jmax(args.L, args.B);
0041 npix = 12*args.nside*args.nside;
0042 f_wav = cell(J+1-args.J_min, 1);
0043 offset = 1;
0044 for j = args.J_min:J
0045   f_wav{j+1-args.J_min} = f_wav_vec(offset:offset+npix-1);
0046   offset = offset + npix;
0047 end

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