Program cswt_mask_apply

program cswt_mask_apply

        ! Uses
    use s2_types_mod
    use cswt_tr_mod

        ! Calls
    call cswt_tr_free
    call cswt_tr_io_fits_write_wcoeff
    call cswt_tr_mask_apply
    call parse_options

        ! Variables
    character (len=S2_STRING_LEN) :: filename_wcoeff
    character (len=S2_STRING_LEN) :: filename_mask
    character (len=S2_STRING_LEN) :: filename_out
    type (cswt_tr) :: tr
    type (cswt_tr) :: tr_mask
    logical, parameter :: DISPLAY_MASK_DEFAULT = .false.
    logical :: display_mask = DISPLAY_MASK_DEFAULT

        ! Subroutines and functions
    subroutine parse_options ()

end program cswt_mask_apply

Apply an extended coefficient exclusion mask to wavelet coefficients.

Notes:

Important: Only specify the display flag if the output may is only used for display purposes. If subsequent processing is applied erroneous results amy occur.

Usage: cswt_mask_apply

[-help]: Display usage information.
[-wcoeff filename_wcoeff]: Name of input file containing wavelet coefficients.
[-mask filename_mask]: Name of input file containing extended coefficient mask defined over the same domain as the wavelet coefficients (hence saved in wavelet coefficient fits file).
[-display display_mask]: Logical to specified whether a display mask is to be applied. If that is the case then the pixels in the tr structure corresponding to the zeros with be replaced with a large negative value so that they appear grey in output images.
[-out filename_out]: Name of output file to write the masked wavelet coefficient to.

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

Version: 0.1 - November 2004

Description of Variables

filename_wcoeff

character (len=S2_STRING_LEN) :: filename_wcoeff

filename_mask

character (len=S2_STRING_LEN) :: filename_mask

filename_out

character (len=S2_STRING_LEN) :: filename_out

tr

type (cswt_tr) :: tr

tr_mask

type (cswt_tr) :: tr_mask

DISPLAY_MASK_DEFAULT

logical, parameter :: DISPLAY_MASK_DEFAULT = .false.

display_mask

logical :: display_mask = DISPLAY_MASK_DEFAULT

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