Program s2dw_analysis

program s2dw_analysis

        ! Uses
    use s2dw_types_mod
    use s2dw_error_mod
    use s2dw_fileio_mod
    use s2dw_core_mod
    use s2_sky_mod

        ! Calls
    call parse_options
    call s2_sky_compute_alm
    call s2_sky_free
    call s2_sky_get_alm
    call s2dw_core_analysis_flm2wav_dynamic
    call s2dw_core_free_wavdyn
    call s2dw_core_init_directionality
    call s2dw_core_init_kernels
    call s2dw_error
    call s2dw_fileio_fits_wav_write
    call s2dw_fileio_matlab_wav_write

        ! Variables
    complex (kind=dpc), allocatable, dimension (:,:) :: flm
    complex (kind=spc), allocatable, dimension (:,:) :: flm_temp
    real (kind=dp), allocatable, dimension (:,:) :: K_gamma
    real (kind=dp), allocatable, dimension (:) :: Phi2
    complex (kind=dpc), allocatable, dimension (:,:) :: Slm
    real (kind=dp), allocatable, dimension (:) :: admiss
    type (s2dw_wav_abg), allocatable, dimension (:) :: wavdyn
    complex (kind=dpc), allocatable, dimension (:,:) :: scoeff
    integer :: J
    integer :: J_max
    integer :: B
    logical :: B_in = .false.
    integer :: N
    integer :: bl_scoeff
    real (kind=dp) :: alpha
    integer :: nside
    logical :: admiss_pass
    type (s2_sky) :: sky
    integer :: fail = 0
    logical :: use_Jmax
    character (len=STRING_LEN) :: filename_in
    character (len=STRING_LEN) :: filename_out
    integer :: file_extension = 1
    character (len=*), parameter :: FILE_TYPE_FITS = 'fits'
    character (len=*), parameter :: FILE_TYPE_MAT = 'm'
    character (len=STRING_LEN) :: file_type = FILE_TYPE_FITS
    character (len=STRING_LEN) :: error_string

        ! Subroutines and functions
    subroutine parse_options ()

end program s2dw_analysis

Computes the S2DW wavelet and scaling coefficients of a Healpix sky map.

Notes:

The harmonic band limit B is set to 2*nside, where nside is the Healpix resolution parameter of the input sky map.
The spherical harmonic transform and inverse provided by Healpix is not exact, hence these reduce the numerical precision of the `exact' reconstruction of the original real space map from its wavelet coefficients.

Usage: s2dw_analysis

[-help]: Displays usage information.
[-inp filename_in]: Name of input Healpix sky fits map.
[-out filename_out]: Name of output S2DW formatted fits/matlab file containing wavelet and scaling coefficients.
[-file_type file_type (fits; m)]: String specifying type of output S2DW file to write (fits or matlab m) [default=fits].
[-B B]: Harmonic band limit (if not specified set to 2*nside).
[-N N]: Azimuthal band limit [default=3].
[-alpha alpha]: Basis dilation factor [default=2].
[-J J]: Maximum analysis scale (optional) [default=Jmax].

Author: J. D. McEwen (mcewen@mrao.cam.ac.uk)

Version: 0.1 - November 2007

Description of Variables

flm

complex (kind=dpc), allocatable, dimension (:,:) :: flm

flm_temp

complex (kind=spc), allocatable, dimension (:,:) :: flm_temp

K_gamma

real (kind=dp), allocatable, dimension (:,:) :: K_gamma

Phi2

real (kind=dp), allocatable, dimension (:) :: Phi2

Slm

complex (kind=dpc), allocatable, dimension (:,:) :: Slm

admiss

real (kind=dp), allocatable, dimension (:) :: admiss

wavdyn

type (s2dw_wav_abg), allocatable, dimension (:) :: wavdyn

scoeff

complex (kind=dpc), allocatable, dimension (:,:) :: scoeff

J

integer :: J

J_max

integer :: J_max

B

integer :: B

B_in

logical :: B_in = .false.

N

integer :: N

bl_scoeff

integer :: bl_scoeff

alpha

real (kind=dp) :: alpha

nside

integer :: nside

admiss_pass

logical :: admiss_pass

sky

type (s2_sky) :: sky

fail

integer :: fail = 0

use_Jmax

logical :: use_Jmax

filename_in

character (len=STRING_LEN) :: filename_in

filename_out

character (len=STRING_LEN) :: filename_out

file_extension

integer :: file_extension = 1

FILE_TYPE_FITS

character (len=*), parameter :: FILE_TYPE_FITS = 'fits'

FILE_TYPE_MAT

character (len=*), parameter :: FILE_TYPE_MAT = 'm'

file_type

character (len=STRING_LEN) :: file_type = FILE_TYPE_FITS

error_string

character (len=STRING_LEN) :: error_string

Description of Subroutines and Functions

parse_options

subroutine parse_options ()
    ! Calls: getArgument
end subroutine parse_options

Parses the options passed when program called. ! @author J. D. McEwen (mcewen@mrao.cam.ac.uk)

Version: 0.1 - November 2007