Module comb_tmpl_mod

module comb_tmpl_mod

        ! Uses
    use s2_types_mod
    use comb_error_mod

        ! Subroutines and functions
    public function comb_tmpl_cos_thetaon2 (theta, phi, param) result (val)
    public function comb_tmpl_point (theta, phi, param) result (val)
    public function comb_tmpl_butterfly (theta, phi, param) result (val)
    public function comb_tmpl_gaussian (theta, phi, param) result (val)
    public function comb_tmpl_mexhat (theta, phi, param) result (val)
    public function comb_tmpl_morlet (theta, phi, param) result (val)

end module comb_tmpl_mod

Contains definitions of template functions defined on the sky to initialise comb obj objects.

Author: J. D. McEwen (mcewen[AT]mrao.cam.ac.uk)

Version: 0.1 August 2004

Description of Subroutines and Functions

comb_tmpl_cos_thetaon2

public function comb_tmpl_cos_thetaon2 (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
end function comb_tmpl_cos_thetaon2

Template function defined on the sphere. f(theta,phi) = cos(theta/2.0e0)

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.1 August 2004

comb_tmpl_point

public function comb_tmpl_point (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
    ! Calls: comb_error
end function comb_tmpl_point

Template function defined on the sphere. Point source centered at the north pole.

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.1 May 2005

comb_tmpl_butterfly

public function comb_tmpl_butterfly (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
    ! Calls: comb_error
end function comb_tmpl_butterfly

Template function defined on the sphere. Butterfly is a Gaussian in y direction and first derrivative of Gaussian in x direction.

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.1 August 2004

comb_tmpl_gaussian

public function comb_tmpl_gaussian (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
    ! Calls: comb_error
end function comb_tmpl_gaussian

Template function defined on the sphere. 2d Gaussian.

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.1 August 2004

comb_tmpl_mexhat

public function comb_tmpl_mexhat (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
    ! Calls: comb_error
end function comb_tmpl_mexhat

Template function defined on the sphere. Mexican hat is negative of Laplacian of 2D Gaussian.

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.1 August 2004

comb_tmpl_morlet

public function comb_tmpl_morlet (theta, phi, param) result (val)
    real (kind=s2_sp), intent(in) :: theta
    real (kind=s2_sp), intent(in) :: phi
    real (kind=s2_sp), optional, intent(in), dimension (:) :: param
    real (kind=s2_sp) :: val
    ! Calls: comb_error
end function comb_tmpl_morlet

Template function defined on the sphere. Real Morlet wavelet.

Notes:

One parameter in param array: taken as k0 of wave vector, where k=(k0,0).
Error occurs if param array has length greater than 1.
If no parameter array is given then k0=10

Variables:

theta: Theta spherical coordiante in range [0,pi].
phi: Phi spherical coordinate in range [0,2pi).
[param]: Optional parameter array.

Author: J. D. McEwen

Version: 0.2 - April 2005