Module s2_pl_mod

module s2_pl_mod

        ! Uses
    use s2_types_mod
    use s2_error_mod

        ! Types
    public type s2_pl

        ! Interfaces
    public interface s2_pl_init
    public interface s2_pl_conv

        ! Subroutines and functions
    private function s2_pl_init_array (data) result (pl)
    private function s2_pl_init_array_const (const, lmax) result (pl)
    private function s2_pl_init_file_ascii (filename, lmin, lmax, ncomment, scale_in, line_nos_in) result (pl)
    private function s2_pl_init_file_fits (filename) result (pl)
    private function s2_pl_init_copy (orig) result (copy)
    private function s2_pl_init_copy_truncate (orig, lmax) result (copy)
    public function s2_pl_init_guassian (fwhm, lmax) result (pl)
    public subroutine s2_pl_free (pl)
    public function s2_pl_add (pl1, pl2) result (pl_sum)
    private subroutine s2_pl_conv_alm (pl, alm)
    private subroutine s2_pl_conv_pl (pl1, pl2)
    public function s2_pl_power (pl) result (power)
    public subroutine s2_pl_plot (pl, filename, scale_to_dl_in, title)
    public subroutine s2_pl_io_ascii_write (filename, pl, dl_scale)
    public subroutine s2_pl_io_fits_write (filename, pl, comment)
    private subroutine s2_pl_io_fits_read (filename, pl)
    private subroutine s2_pl_io_fits_error_check (status, halt)
    private subroutine s2_pl_io_fits_exists (filename, status, exists)
    private subroutine s2_pl_io_fits_del (filename, status)
    public function s2_pl_get_init (pl) result (init)
    public function s2_pl_get_lmax (pl) result (lmax)
    public subroutine s2_pl_get_spec (pl, pl_spec)
    public function s2_pl_get_spec_l (pl, l) result (pl_val)

end module s2_pl_mod

Provides functionality to support and manipulate a p(l) (l spectrum) function.

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

Version: 0.1 August 2004

Description of Types

s2_pl

public type s2_pl
    private
    logical :: init = .false.
    integer :: lmax = 0
    real (kind=s2_sp), allocatable, dimension (:) :: pl
end type s2_pl

Description of Interfaces

s2_pl_init

public interface s2_pl_init
    module procedure s2_pl_init_array
    module procedure s2_pl_init_array_const
    module procedure s2_pl_init_file_ascii
    module procedure s2_pl_init_file_fits
    module procedure s2_pl_init_copy
    module procedure s2_pl_init_copy_truncate
end interface s2_pl_init

s2_pl_conv

public interface s2_pl_conv
    module procedure s2_pl_conv_alm
    module procedure s2_pl_conv_pl
end interface s2_pl_conv

Description of Subroutines and Functions

s2_pl_init_array

private function s2_pl_init_array (data) result (pl)
    real (kind=s2_sp), intent(in), dimension (:) :: data
    type (s2_pl) :: pl
    ! Calls: s2_error
end function s2_pl_init_array

Initiliase a pl from a array of data values.

Variables:

data: Data array to initialise pl spectrum.
pl: Initialised pl.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_init_array_const

private function s2_pl_init_array_const (const, lmax) result (pl)
    real (kind=s2_sp), intent(in) :: const
    integer, intent(in) :: lmax
    type (s2_pl) :: pl
    ! Calls: s2_error
end function s2_pl_init_array_const

Initiliase a pl with a constant value over all l.

Variables:

const: Constant values used to array to initialise pl spectrum.
lmax: Lmax of the constructed pl spectrum.
pl: Initialised pl.

Author: J. D. McEwen

Version: 0.1 February 2005

s2_pl_init_file_ascii

private function s2_pl_init_file_ascii (filename, lmin, lmax, ncomment, scale_in, line_nos_in) result (pl)
    character (len=*), intent(in) :: filename
    integer, intent(in) :: lmin
    integer, intent(in) :: lmax
    integer, intent(in) :: ncomment
    logical, optional, intent(in) :: scale_in
    logical, optional, intent(in) :: line_nos_in
    type (s2_pl) :: pl
    ! Calls: s2_error
end function s2_pl_init_file_ascii

Initialise a pl from a ascii file.

Variables:

filename: Name of ascii file to read spectrum from.
lmin: Minimum l to read (first value read starts at this index ). (Pl values below lmin are set to zero.)
lmax: Pl lmax.
ncomment: Number of initial comment lines in ascii file to ignore.
[scale_in]: Logical to specify whether to scale the real in pl values. If true the values are scaled by 2*pi/(l*(l+1)) (necessary to scale input cmb cl spectrums to get actual pl values). If not present defaults to false.
[line_nos_in]: Logical to specify whether each line in the file contains a preceeding l count. Defaults to true.
pl: Initialised pl.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_init_file_fits

private function s2_pl_init_file_fits (filename) result (pl)
    character (len=*), intent(in) :: filename
    type (s2_pl) :: pl
    ! Calls: s2_error, s2_pl_io_fits_read
end function s2_pl_init_file_fits

Wrapper to initialise a pl data structure from a s2_pl fits file. The pl structure is read and initialised by the routine s2_pl_io_fits_read.

Variables:

filename: Name of s2_pl fits file containing the pl data to be read.
pl: Returned pl structure initialised with the data contained in the input s2_pl fits file.

Author: J. D. McEwen

Version: 0.1 - April 2005

s2_pl_init_copy

private function s2_pl_init_copy (orig) result (copy)
    type (s2_pl), intent(in) :: orig
    type (s2_pl) :: copy
    ! Calls: s2_error
end function s2_pl_init_copy

Initialse a pl from a copy of another pl.

Variables:

orig: Original pl to copy.
copy: Copied pl.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_init_copy_truncate

private function s2_pl_init_copy_truncate (orig, lmax) result (copy)
    type (s2_pl), intent(in) :: orig
    integer, intent(in) :: lmax
    type (s2_pl) :: copy
    ! Calls: s2_error
end function s2_pl_init_copy_truncate

Initialse a pl from a copy of another pl but truncate to a lower lmax.

Variables:

orig: Original pl to copy.
lmax: Lmax of copy pl to truncate to.
copy: Copied pl.

Author: J. D. McEwen

Version: 0.1 Januray 2005

s2_pl_init_guassian

public function s2_pl_init_guassian (fwhm, lmax) result (pl)
    real (kind=s2_sp), intent(in) :: fwhm
    integer, intent(in) :: lmax
    type (s2_pl) :: pl
    ! Calls: s2_error
end function s2_pl_init_guassian

Initiliase a pl with a Gaussian beam with specified full width half max.

Notes:

Gaussian beam defined as exp(-l(l+1)*sigma2), where sigma2 = fwhm**2.0e0 / (8.0e0 * log(2.0e0)).

Variables:

fwhm: Full width half maximum of Gaussian beam (in radians).
lmax: Lmax of the constructed pl spectrum.
pl: Initialised pl with Gaussian beam.

Author: J. D. McEwen

Version: 0.1 May 2005

s2_pl_free

public subroutine s2_pl_free (pl)
    type (s2_pl), intent(inout) :: pl
    ! Calls: s2_error
end subroutine s2_pl_free

Free all data associated with an initialised pl and reset all other attributes.

Variables:

pl: The pl to free.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_add

public function s2_pl_add (pl1, pl2) result (pl_sum)
    type (s2_pl), intent(in) :: pl1
    type (s2_pl), intent(in) :: pl2
    type (s2_pl) :: pl_sum
    ! Calls: s2_error
end function s2_pl_add

All two pl spectrums.

Notes:

The returned pl_sum object is initialised herein and must be freed by the calling routine.

Variables:

pl1: First pl spectrum to be added.
pl2: Second pl spectru to be added.
pl_sum: Summed spectrum.

Author: J. D. McEwen

Version: 0.1 May 2005

s2_pl_conv_alm

private subroutine s2_pl_conv_alm (pl, alm)
    type (s2_pl), intent(in) :: pl
    complex (kind=s2_spc), intent(inout), dimension (0:,0:) :: alm
    ! Calls: s2_error
end subroutine s2_pl_conv_alm

Convolve an alm with the pl. The original alm is overwritten with the convolved alm on ouput. If length of alm is shorter than pl then neglect larger pl values. If length of alm is greater than pl then effectivly pad the pl with zeros, i.e. set high l alm values to zero.

Variables:

pl: Pl to convolve.
alm: Alm to convolve. Overwritten with new alm on output.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_conv_pl

private subroutine s2_pl_conv_pl (pl1, pl2)
    type (s2_pl), intent(inout) :: pl1
    type (s2_pl), intent(in) :: pl2
    ! Calls: s2_error
end subroutine s2_pl_conv_pl

Convolve two power spectra. Pl1 is overwritten with the convolved spectrum on output. (Spectra must have same lmax.)

Variables:

pl1: First pl to convolve. Overwritten with new spectrum on output.
pl2: Second pl to convolve.

Author: J. D. McEwen

Version: 0.1 May 2005

s2_pl_power

public function s2_pl_power (pl) result (power)
    type (s2_pl), intent(in) :: pl
    real (kind=s2_sp) :: power
    ! Calls: s2_error
end function s2_pl_power

Compute full power from a pl spectrum

Variables:

pl: Pl structure containing power spectrum to compute total power of.
power: Full power computed.

Author: J. D. McEwen

Version: 0.1 May 2006

s2_pl_plot

public subroutine s2_pl_plot (pl, filename, scale_to_dl_in, title)
    type (s2_pl), intent(in) :: pl
    character (len=*), intent(in) :: filename
    logical, optional, intent(in) :: scale_to_dl_in
    character (len=*), optional, intent(in) :: title
    ! Calls: pgclos, pgenv, pgline, pgmtxt, pgopen, s2_error
end subroutine s2_pl_plot

Plot the pl angular power spectrum as a postscript.

Notes:

l=0 term (dc term) is not plotted. In almost all cases this will be zero anyway.

Variables:

pl: Pl structure containing power spectrum to plot.
filename: Name of output postscript file (including .ps extension but excluding local /cps device flag).
[scale_to_dl_in]: Logical to specify whether to scale the pl cl spectrum to a dl spectrum, where d(l) = c(l) * l * (l+1) / (2*pi). (Default is true.)

Author: J. D. McEwen

Version: 0.1 February 2005

s2_pl_io_ascii_write

public subroutine s2_pl_io_ascii_write (filename, pl, dl_scale)
    character (len=*), intent(in) :: filename
    type (s2_pl), intent(in) :: pl
    logical, optional, intent(in) :: dl_scale
end subroutine s2_pl_io_ascii_write

Write a s2_pl object to an ascii file.

Variables:

filename: Name of the output fits file to write the pl structure data to.
pl: The pl structure containing the data to be written to the output fits file.
[dl_scale]: Logical specifying whether to scale to a dl spectrum.

Author: J. D. McEwen

Version: 0.1 - June 2005

s2_pl_io_fits_write

public subroutine s2_pl_io_fits_write (filename, pl, comment)
    character (len=*), intent(in) :: filename
    type (s2_pl), intent(in) :: pl
    character (len=*), optional, intent(in) :: comment
    ! Calls: ftclos, ftfiou, ftgiou, ftibin, ftinit, ftpcle, ftpcom, ftpdat, ftphpr, ftpkyj, s2_error, s2_pl_io_fits_error_check, s2_pl_io_fits_exists
end subroutine s2_pl_io_fits_write

Write a s2_pl object to a fits file.

Variables:

filename: Name of the output fits file to write the pl structure data to.
pl: The pl structure containing the data to be written to the output fits file.
[comment]: Optional comment string to be added to the output fits file header if present.

Author: J. D. McEwen

Version: 0.1 - April 2005

s2_pl_io_fits_read

private subroutine s2_pl_io_fits_read (filename, pl)
    character (len=*), intent(in) :: filename
    type (s2_pl), intent(out) :: pl
    ! Calls: ftclos, ftfiou, ftgcve, ftgiou, ftgkyj, ftmahd, ftopen, ftthdu, s2_error, s2_pl_io_fits_error_check, s2_pl_io_fits_exists
end subroutine s2_pl_io_fits_read

Read a fits pl file and allocate a new pl structure with the data read.

Variables:

filename: Name of s2_pl file containing the pl spectrum data to be read.
pl: Returned pl structure initialised with the data contained in the input s2_pl fits file.

Author: J. D. McEwen

Version: 0.1 - April 2005

s2_pl_io_fits_error_check

private subroutine s2_pl_io_fits_error_check (status, halt)
    integer, intent(inout) :: status
    logical, intent(in) :: halt
    ! Calls: ftgerr, ftgmsg
end subroutine s2_pl_io_fits_error_check

Check if a fits error has occured and print error message. Halt program execution if halt flag is set.

Notes:

Copied form cswt_tr_mod module.

Variables:

status: Fits integer status code.
halt: Logical to indicate whether to halt program execution if an error is detected.

Author: J. D. McEwen

Version: 0.1 - November 2004

s2_pl_io_fits_exists

private subroutine s2_pl_io_fits_exists (filename, status, exists)
    character (len=*), intent(in) :: filename
    integer, intent(inout) :: status
    logical, intent(out) :: exists
    ! Calls: ftclos, ftfiou, ftgiou, ftopen, s2_pl_io_fits_error_check
end subroutine s2_pl_io_fits_exists

Check if a fits file exists.

Notes:

Copied form cswt_tr_mod module.

Variables:

filename: Name of fits file to check existence of.
status: Fits integer status code.
exists: Logical indicating whether the fits file already exists.

Author: J. D. McEwen

Version: 0.1 - November 2004

s2_pl_io_fits_del

private subroutine s2_pl_io_fits_del (filename, status)
    character (len=*), intent(in) :: filename
    integer, intent(inout) :: status
    ! Calls: ftcmsg, ftdelt, ftfiou, ftgiou, ftopen
end subroutine s2_pl_io_fits_del

Delete a fits file.

Notes:

Copied form cswt_tr_mod module.

Variables:

filename: Name of fits file to detele.
status: Fits integer status code.

Author: J. D. McEwen

Version: 0.1 - November 2004

s2_pl_get_init

public function s2_pl_get_init (pl) result (init)
    type (s2_pl), intent(in) :: pl
    logical :: init
end function s2_pl_get_init

Get init variable from the passed pl.

Variables:

pl: Pl object to get the variable of.
init: Object init variable returned.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_get_lmax

public function s2_pl_get_lmax (pl) result (lmax)
    type (s2_pl), intent(in) :: pl
    integer :: lmax
    ! Calls: s2_error
end function s2_pl_get_lmax

Get lmax variable from the passed pl.

Variables:

pl: Pl object to get the variable of.
lmax: Object lmax variable returned.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_get_spec

public subroutine s2_pl_get_spec (pl, pl_spec)
    type (s2_pl), intent(in) :: pl
    real (kind=s2_sp), intent(out), dimension (:) :: pl_spec
    ! Calls: s2_error
end subroutine s2_pl_get_spec

Get pl spectrum variable from the passed pl.

Variables:

pl: Pl object to get the variable of.
pl_spec: Object pl spec variable returned.

Author: J. D. McEwen

Version: 0.1 August 2004

s2_pl_get_spec_l

public function s2_pl_get_spec_l (pl, l) result (pl_val)
    type (s2_pl), intent(in) :: pl
    integer, intent(in) :: l
    real (kind=s2_sp) :: pl_val
    ! Calls: s2_error
end function s2_pl_get_spec_l

Get spectrum value for a given l from the pl.

Variables:

pl: Pl object to get the variable of.
l: l value to get value of.
pl_val: Spectrum value for specified l.

Author: J. D. McEwen

Version: 0.1 August 2004