Program s2fil_filter_construct

program s2fil_filter_construct

        ! Uses
    use s2_types_mod
    use s2_sky_mod
    use s2_pl_mod
    use s2_vect_mod, only: s2_vect_arcmin_to_rad
    use s2fil_filter_mod
    use s2fil_error_mod
    use comb_tmpl_mod
    use cswt_tr_mod, only: cswt_tr_io_txt_dilation_read

        ! Calls
    call cswt_tr_io_txt_dilation_read
    call parse_options
    call s2_pl_conv
    call s2_pl_free
    call s2_sky_free
    call s2fil_error
    call s2fil_filter_free
    call s2fil_filter_io_fits_write

        ! Variables
    integer, parameter :: NUM_COMMENT_LINES_BKGND_FILE = 29
    character (len=S2_STRING_LEN) :: filter_type_string = S2FIL_FILTER_TYPE_STR_MF
    character (len=S2_STRING_LEN) :: scale_type_string = S2FIL_FILTER_SCALE_TYPE_STR_TMPL
    integer :: filter_type = S2FIL_FILTER_TYPE_MF
    integer :: scale_type = S2FIL_FILTER_SCALE_TYPE_TMPL
    character (len=S2_STRING_LEN) :: filename_background_cmb
    logical :: cmb_present = .false.
    logical :: noise_present = .false.
    logical :: beam_present = .false.
    real (kind=s2_sp) :: noise_var = 0.0e0
    real (kind=s2_sp) :: beam_fwhm = 0.0e0
    character (len=S2_STRING_LEN) :: filename_dil
    character (len=S2_STRING_LEN) :: filename_filter
    character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_GAUSSIAN = 'gaussian'
    character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_MEXHAT = 'mexhat'
    character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_MORLET = 'morlet'
    character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_BUTTERFLY = 'butterfly'
    character (len=S2_STRING_LEN) :: tmpl_type
    integer :: nside
    integer :: lmax
    integer :: mmax
    integer :: pix_scheme
    integer :: background_read_lmin
    logical :: norm_pres_dil
    logical :: background_read_scale
    logical :: filter_heu = .true.
    real (kind=s2_sp), allocatable, dimension (:,:) :: scale
    type (s2_sky) :: tmpl
    type (s2_pl) :: background
    type (s2_pl) :: background_cmb
    type (s2_pl) :: background_noise
    type (s2_pl) :: beam
    type (s2fil_filter) :: filter

        ! Subroutines and functions
    subroutine parse_options ()

end program s2fil_filter_construct

Notes:

• Complete for current version of s2fil_filter_mod but will no doubt change as s2fil_filter_mod is extended to additional functionality. (Extensions planned: save full filter structure; functionality for SAF; ability to construct multiple dilations; dilatable filter; others)
  • - these additions have now been implemented.

• [-help]: Display usage information.
• [-out filename_filter]: Name of filter file to save.
• [-nside nside]: Healpix nside resolution of construction.
• [-filename_dil filename_dil]: Filename containing dilations to construct filter for.
• [-bkgnd_cmb filename_background_cmb]:
• [-noise_var noise_var]: Variance of noise to add.
• [-tmpl tmpl_type]: String defining template function type.
• [-beam_fwhm beam_fwhm (arcmin)]: FWHM in arcmin of beam to apply. If not present then no beam is applied.
• [-filter_heu filter_heu]: Logical to specify whether heuristic truncation of optimal filter alms is to be performed (recommended).
• [-filter_type filter_type_string]: String defining filter type (either mf or saf).
• [-scale_type scale_type_string]: String defining scale type (either tmpl or filter).

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

Version: 0.2 - April 2005

Description of Variables

integer, parameter :: NUM_COMMENT_LINES_BKGND_FILE = 29

character (len=S2_STRING_LEN) :: filter_type_string = S2FIL_FILTER_TYPE_STR_MF

character (len=S2_STRING_LEN) :: scale_type_string = S2FIL_FILTER_SCALE_TYPE_STR_TMPL

integer :: filter_type = S2FIL_FILTER_TYPE_MF

integer :: scale_type = S2FIL_FILTER_SCALE_TYPE_TMPL

character (len=S2_STRING_LEN) :: filename_background_cmb

logical :: cmb_present = .false.

logical :: noise_present = .false.

logical :: beam_present = .false.

real (kind=s2_sp) :: noise_var = 0.0e0

real (kind=s2_sp) :: beam_fwhm = 0.0e0

character (len=S2_STRING_LEN) :: filename_dil

character (len=S2_STRING_LEN) :: filename_filter

character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_GAUSSIAN = 'gaussian'

character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_MEXHAT = 'mexhat'

character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_MORLET = 'morlet'

character (len=S2_STRING_LEN), parameter :: TMPL_TYPE_BUTTERFLY = 'butterfly'

character (len=S2_STRING_LEN) :: tmpl_type

integer :: nside

integer :: lmax

integer :: mmax

integer :: pix_scheme

integer :: background_read_lmin

logical :: norm_pres_dil

logical :: background_read_scale

logical :: filter_heu = .true.

real (kind=s2_sp), allocatable, dimension (:,:) :: scale

type (s2_sky) :: tmpl

type (s2_pl) :: background

type (s2_pl) :: background_cmb

type (s2_pl) :: background_noise

type (s2_pl) :: beam

type (s2fil_filter) :: filter

Description of Subroutines and Functions

subroutine parse_options ()
    ! Calls: getArgument
end subroutine parse_options

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

Version: 0.1 - February 2005