Program cswt_mask_gen

program cswt_mask_gen

        ! Uses
    use s2_types_mod
    use s2_sky_mod
    use cswt_error_mod
    use cswt_tr_mod

        ! Calls
    call cswt_error
    call cswt_tr_free
    call cswt_tr_io_fits_write_wcoeff
    call cswt_tr_mask_gen
    call parse_options
    call s2_sky_free

        ! Variables
    character (len=S2_STRING_LEN), parameter :: WAV_TYPE_MEXHAT = 'mexhat'
    character (len=S2_STRING_LEN), parameter :: WAV_TYPE_MORLET = 'morlet'
    real (kind=s2_sp), parameter :: THRES1_PROP_MEXHAT = 0.25e0
    real (kind=s2_sp), parameter :: THRES2_PROP_MEXHAT = 0.9e0
    real (kind=s2_sp), parameter :: THRES1_PROP_MORLET = 0.8e0
    real (kind=s2_sp), parameter :: THRES2_PROP_MORLET = 0.01e0
    real (kind=s2_sp), parameter :: THRES1_MIN_MEXHAT = 1.0e-3
    real (kind=s2_sp), parameter :: THRES1_MIN_MORLET = 5.0e-4
    character (len=S2_STRING_LEN) :: filename_wcoeff
    character (len=S2_STRING_LEN) :: filename_sky
    character (len=S2_STRING_LEN) :: filename_out
    character (len=S2_STRING_LEN) :: wavelet_type
    integer :: file_extension_sky
    type (s2_sky) :: sky_mask
    type (cswt_tr) :: tr_mask
    logical :: mode_cswt = .false.
    logical :: mode_morph = .false.
    logical :: mode_convert = .false.

        ! Subroutines and functions
    subroutine parse_options ()

end program cswt_mask_gen

Generate an extended coefficient exclusion mask defined in the ecp wavelet coefficient domain from an original mask defined on the sky and the spherical wavelet transform of the original mask.

Notes:

Morphological operation method is reccommended. Otherwise parameters must be tunned to application.

Usage: cswt_mask_gen

[-help]: Display usage information.
[-wcoeff filename_wcoeff]: Name of input wavelet coefficient file containing coefficients of the original mask considered.
[-sky filename_sky]: Name of the input mask sky file containing the original mask defined on the sky
[-ext file_extension]: File extension number mask sky is stored in.
[-morph mode_morph]: If true use morphological operator method.
[-convert mode_convert]: If true just convert sky mask to wavelet domain.
[-cswt mode_cswt]: If true use spherical wavelet coefficients and thresholding technique.
[-out filename_out]: Name of output extended coefficient exclusion mask file.
[-wav wavelet_type (only required if method is cswt)]: Wavelet type mask corresponds to. (Alters parameters used to generate the extended mask.)

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

Version: 0.1 - November 2004

Description of Variables

WAV_TYPE_MEXHAT

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

WAV_TYPE_MORLET

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

THRES1_PROP_MEXHAT

real (kind=s2_sp), parameter :: THRES1_PROP_MEXHAT = 0.25e0

reduce slowly increase slowly

THRES2_PROP_MEXHAT

real (kind=s2_sp), parameter :: THRES2_PROP_MEXHAT = 0.9e0

reduce slowly increase slowly

THRES1_PROP_MORLET

real (kind=s2_sp), parameter :: THRES1_PROP_MORLET = 0.8e0

reduce slowly increase slowly

THRES2_PROP_MORLET

real (kind=s2_sp), parameter :: THRES2_PROP_MORLET = 0.01e0

reduce slowly increase slowly

THRES1_MIN_MEXHAT

real (kind=s2_sp), parameter :: THRES1_MIN_MEXHAT = 1.0e-3

reduce slowly increase slowly

THRES1_MIN_MORLET

real (kind=s2_sp), parameter :: THRES1_MIN_MORLET = 5.0e-4

reduce slowly increase slowly

filename_wcoeff

character (len=S2_STRING_LEN) :: filename_wcoeff

filename_sky

character (len=S2_STRING_LEN) :: filename_sky

filename_out

character (len=S2_STRING_LEN) :: filename_out

wavelet_type

character (len=S2_STRING_LEN) :: wavelet_type

file_extension_sky

integer :: file_extension_sky

sky_mask

type (s2_sky) :: sky_mask

tr_mask

type (cswt_tr) :: tr_mask

mode_cswt

logical :: mode_cswt = .false.

mode_morph

logical :: mode_morph = .false.

mode_convert

logical :: mode_convert = .false.

Description of Subroutines and Functions

parse_options

subroutine parse_options ()
    ! Calls: getArgument
end subroutine parse_options

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

Version: 0.1 - November 2004