XMM-Newton Science Analysis System


fitsutils (fitsutils-1.10.1) [xmmsas_20230412_1735-21.0.0]

getAnnularMask

This function is a wrapper for the function ssclib/array_utils/getAnnularMaskAry (See the documentation of ssclib), accepting an input 2-dimensional FITS image, and returns a 2-dimensional logical mask array. The input FITS image just provides the size and axes of the returned mask.

  interface getAnnularMask
    function getAnnularMaskDoubleName(imageSetName, centX, centY &
       , rOuter, rInner, extNum) result(arMask)
      logical, allocatable :: arMask(:,:)	! result
      character(*), intent(in) :: imageSetName
      real(double), intent(in) :: centX, centY, rOuter
      real(double), intent(in), optional :: rInner	! 0 in default.
      integer(int32), intent(in), optional :: extNum	! Extention number of the image array in the input FITS file.
    end function getAnnularMaskDoubleName
  
    function getAnnularMaskDoubleSet(imageSet, centX, centY &
       , rOuter, rInner, extNum) result(arMask)
      logical, allocatable :: arMask(:,:)	! result
      type(DataSetT), intent(in) :: imageSet
      real(double), intent(in) :: centX, centY, rOuter
      real(double), intent(in), optional :: rInner	! 0 in default.
      integer(int32), intent(in), optional :: extNum	! Extention number of the image array in the input FITS file.
    end function getAnnularMaskDoubleSet
  
    function getAnnularMaskSingleName(imageSetName, centX, centY &
       , rOuter, rInner, extNum) result(arMask)
      logical, allocatable :: arMask(:,:)	! result
      character(*), intent(in) :: imageSetName
      real(single), intent(in) :: centX, centY, rOuter
      real(single), intent(in), optional :: rInner	! 0 in default.
      integer(int32), intent(in), optional :: extNum	! Extention number of the image array in the input FITS file.
    end function getAnnularMaskSingleName
  
    function getAnnularMaskSingleSet(imageSet, centX, centY &
       , rOuter, rInner, extNum) result(arMask)
      logical, allocatable :: arMask(:,:)	! result
      type(DataSetT), intent(in) :: imageSet
      real(single), intent(in) :: centX, centY, rOuter
      real(single), intent(in), optional :: rInner	! 0 in default.
      integer(int32), intent(in), optional :: extNum	! Extention number of the image array in the input FITS file.
    end function getAnnularMaskSingleSet
  end interface