XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


ssclib (ssclib-4.36.1) [xmmsas_20230412_1735-21.0.0]


getAnnularMaskAry

Return a Logical 2-dimensional mask array for a given size, where the area of the pixels at (rInner $<=$ radius $<$ rOuter) are True.

Note: Make sure to deallocate the returned array after use.

  interface getAnnularMaskAry
    function getAnnularMaskAry(sizeX, sizeY, centX, centY &
       , rOuter, rInner) result(arMask)
      logical, allocatable :: arMask(:,:)
      integer(int32), intent(in) :: sizeX, sizeY
      real(double),   intent(in) :: centX, centY, rOuter
      real(double),   intent(in), optional :: rInner	! 0 in default.
    end function getAnnularMaskAry
  end interface



XMM-Newton SOC -- 2023-04-16