Integrate code (#3248)

Jürgen Knödlseder
1 parent 20133af4
Showing 3 changed files with 91 additions and 120 deletions
cscripts/csphagen.par
cscripts/csphagen.py
doc/source/users/reference_manual/csphagen.rst
@@ -43,8 +43,8 @@ glon,          r, a, 184.56,0,360, &quot;Galactic longitude of source region centre (
 glat,          r, a, -5.79,-90,90, "Galactic latitude of source region centre (deg)"
 rad,           r, a, 0.2,0,180, "Radius of source region circle (deg)"
 width,         r, a, 0.2,0,180, "Width of source region rectangle (deg)"
-height,        r, a, 0.2,0,180, "Width of source region rectangle (deg)"
-posang,        r, a, 0,-360,360, "Position angle of source region rectangle ccw from North (deg)"
+height,        r, a, 0.2,0,180, "Height of source region rectangle (deg)"
+posang,        r, a, 0.0,-360,360, "Position angle of source region rectangle (deg)"
 srcregfile,    f, a, on.reg,,, "Source region file (ds9 or FITS WCS)"
 bkgmethod,     s, a, REFLECTED,REFLECTED|CUSTOM,, "Method for background estimation"
 bkgregfile,    f, a, bkg.reg,,, "Background regions file (ds9 or FITS WCS)"
@@ -149,6 +149,34 @@ class csphagen(ctools.csobservation):
         # Return
         return
+    def _compute_posang(self, pnt_dir, a, b):
+        """
+        Compute the difference in position angle wrt the pointing in degrees
+
+        Parameters
+        ----------
+        pnt_dir : `~gammalib.GSkyDir`
+            Pointing direction
+        a : `~gammalib.GSkyDir`
+            First sky direction
+        a : `~gammalib.GSkyDir`
+            Second sky direction
+
+        Returns
+        -------
+        posang : float
+            Position angle (degrees)
+        """
+        # Compute position angles
+        posang_a = pnt_dir.posang_deg(a) % 360
+        posang_b = pnt_dir.posang_deg(b) % 360
+
+        # Compute difference
+        posang = abs(posang_a - posang_b)
+
+        # Return position angle
+        return posang
+
     def _get_regions(self, filename):
         """
         Get regions from DS9 file or FITS file
@@ -192,26 +220,24 @@ class csphagen(ctools.csobservation):
         self['bkgregmin'].integer()
         self['bkgregskip'].integer()
-        # Set source region (so far only CIRCLE is supported)
+        # If source shape is a circle the append GSkyRegionCircle
         if self._srcshape == 'CIRCLE':
             # Set circular source region
             self._rad = self['rad'].real()
             self._src_reg.append(gammalib.GSkyRegionCircle(self._src_dir, self._rad))
+        # ... otherwise if source shape is a rectangle then append GSkyRegionRect
         elif self._srcshape == 'RECT':
             # Set rectangular source region
             self._reg_width  = self['width'].real()
             self._reg_height = self['height'].real()
             self._reg_posang = self['posang'].real()
-            self._src_reg.append(gammalib.GSkyRegionRect(self._src_dir
-                                                        ,self._reg_width
-                                                        ,self._reg_height
-                                                        ,self._reg_posang
-                                                        )
-                                )
-
+            self._src_reg.append(gammalib.GSkyRegionRect(self._src_dir,
+                                                         self._reg_width,
+                                                         self._reg_height,
+                                                         self._reg_posang))
         # Query usage of background model
         self['use_model_bkg'].boolean()
@@ -357,118 +383,49 @@ class csphagen(ctools.csobservation):
             model    = gammalib.GModelSky(spatial, spectral)
             model.name('Dummy')
             self._models.append(model)
-            self._srcname       = 'Dummy'
+            self._srcname = 'Dummy'
             self['use_model_bkg'].boolean(False)
         # Return
         return
     def _compute_region_separation(self, pnt_dir):
-        """ Compute the separation angle for reflected off regions in radians.
+        """
+        Compute the separation angle for reflected off regions in radians
         Returns
         -------
-        angle : `float`
-            Separation angle of two off regions (rad)
+        angle : float
+            Separation angle of two off regions (radians)
         """
         # Initialise the result
-        separation = -1
+        separation = -1.0
         # Compute offset of reflected regions to pointing position
         offset = pnt_dir.dist_deg(self._src_dir)
+        # If shape is a circle then compute apparent diameter of the circle
+        # as separation
         if self._srcshape == 'CIRCLE':
-
-            # Compute apparent diameter of the circle
             separation = 2.0 * self._rad / offset
+        # ... otherwise if shape is a rectangle then compute the opening angle
+        # towards combinations of rectangle corners. This method overestimates
+        # the real need of space between the ectangles, so the method may be
+        # optimised to gain more off regions! Anyway, it is assured that the
+        # off regions will never overlap.
         elif self._srcshape == 'RECT':
-            # Compute the opening angle towards combinations of rectangle corners.
-            # This method overestimates the real need of space between the
-            # rectangles, so the method may be optimised to gain more off regions!
-            # Anyway, it is assured that the off regions will never overlap.
-
-            # Get the corners
+            # Get the sky directions of the corners of the rectangle
             cs = [self._src_reg[0].get_corner(icorner) for icorner in range(4)]
-            # Auxillary, local method for opening angle computation
-            def __compute_posang(pnt_dir,a,b):
-                """ Compute the difference in position angle to the pointing in
-                    degrees.
-                """
-                posang_a = pnt_dir.posang_deg(a) %360
-                posang_b = pnt_dir.posang_deg(b) %360
-                posang = abs(posang_a - posang_b)
-                return posang
-
             # Compute the 6 opening angles
             combinations = [[0,1], [0,2], [0,3], [1,2], [1,3], [2,3]]
-            angles = [__compute_posang(pnt_dir, cs[i], cs[j]) for i,j in combinations]
+            angles       = [self._compute_posang(pnt_dir, cs[i], cs[j]) \
+                            for i,j in combinations]
             # The desired separation is the maximum opening angle
-            separation = max(angles) *gammalib.deg2rad
-
-
-            ## Different approach:
-            ## Find the separation angle for which two rectangles to not overlap
-            ## Issue: Scanning not optimal.
-            # posang    = pnt_dir.posang_deg(self._src_dir)
-            # dphi_incr = 0.1
-            # dphi      = dphi_incr
-            # print("Src ctr direction: ra={} dec={}".format(self._src_dir.ra_deg(), self._src_dir.dec_deg()))
-            # print(self._src_reg)
-            # while dphi<360:
-
-            #     ctr_dir = pnt_dir.clone()
-            #     ctr_dir.rotate_deg(posang + dphi, offset)
-            #     print("Query ctr direction: ra={} dec={}".format(ctr_dir.ra_deg(), ctr_dir.dec_deg()))
-
-            #     # Create test rectangle
-            #     reg = gammalib.GSkyRegionRect(ctr_dir
-            #                                  ,self._reg_width
-            #                                  ,self._reg_height
-            #                                  ,self._reg_posang + dphi
-            #                                  )
-            #     print(reg)
-
-            #     # Check test rectangle corner containment in reference rectangle
-            #     is_corner_contained = self._src_reg.overlaps(reg)
-            #     # is_corner_contained = False
-            #     # for icorner in range(4):
-            #     #     corner_dir = reg.get_corner(icorner)
-            #     #     is_corner_contained |= self._src_reg.contains(corner_dir)
-
-            #     # Check if any corner was contained
-            #     if not is_corner_contained:
-            #         diameter = dphi
-            #         break
-
-            #     # Increment dphi
-            #     dphi += dphi_incr
-
-
-            ## Very different approach: Compute the width along the circular
-            ## region placement path.
-            ## Issue: Long regions will overlap in the inner part.
-            # def l(w,h,phi):
-            #     """ Super complicated method to compute the height along dec-axis
-            #         of a rotated rectangle.
-            #     """
-            #     phi = np.deg2rad(phi) % (2*np.pi)
-            #     phi_c = np.arctan2(w,h)
-            #     if phi>=(0.5*np.pi) and (phi<np.pi):
-            #         phi = np.pi-phi
-            #     elif (phi>=np.pi) and (phi<(1.5*np.pi)):
-            #         phi -=np.pi
-            #     elif (phi>=(1.5*np.pi)) and (phi<(2*np.pi)):
-            #         phi = 2*np.pi - phi
-
-            #     if (0<=phi) and (phi<phi_c):
-            #         result = h/2/np.cos(phi)
-            #     else:
-            #         result = w/2/np.sin(phi)
-            #     return 2*result
+            separation = max(angles) * gammalib.deg2rad
         # Return
         return separation
@@ -551,11 +508,10 @@ class csphagen(ctools.csobservation):
                             region = gammalib.GSkyRegionCircle(ctr_dir, self._rad)
                         elif self._srcshape == 'RECT':
                             # Adjust the posang of the rectangle correspondingly
-                            region = gammalib.GSkyRegionRect(ctr_dir
-                                                            ,self._reg_width
-                                                            ,self._reg_height
-                                                            ,self._reg_posang + dphi
-                                                            )
+                            region = gammalib.GSkyRegionRect(ctr_dir,
+                                                             self._reg_width,
+                                                             self._reg_height,
+                                                             self._reg_posang + dphi)
                         if self._has_exclusion:
                             if self._excl_reg.overlaps(region):
@@ -16,22 +16,27 @@ the OGIP format normally used in X-ray astronomy (PHA, ARF, RMF),
 If the ``bkgmethod`` parameter is ``REFLECTED``, the script will use an On region
 shape defined by the ``srcshape`` parameter and generate reflected regions by
-placing regions of the same shape that are reflected with respect to the pointing
-direction. So far only circular regions are supported, with a center that is
-specified by the ``ra`` and ``dec`` parameters if ``coordsys=CEL`` or the ``glon``
-and ``glat`` parameters if ``coordsys=GAL``, and a radius that is specified by the
-``rad`` parameter. Reflected regions are only generated for offset angles with
-respect to the pointing direction that are smaller than the value specified by
-the ``maxoffset`` parameter. If less than ``bkgregmin`` reflected regions can be
-found because the offset angle between source and pointing direction is too small,
-the observation will be skipped. Regions to be excluded for background
-determination can be specified using a FITS mask file that is specified using the
-``inexclusion`` parameter. A mask is a sky map where all pixel values that
-differ from zero will be used as exclusion region. If the FITS file
-contains multiple extensions and the user does not specify which one
-to use, the extention ``EXCLUSION`` will be used if available (e.g.,
-if you use a skymap generated by :ref:`ctskymap`).
-Otherwise the primary extension will be used.  
+placing regions of the same shape that are reflected with respect to the
+pointing direction. So far circular and rectangular regions are supported.
+Circular regions are defined by a center that is specified by the ``ra`` and
+``dec`` parameters if ``coordsys=CEL`` or the ``glon`` and ``glat`` parameters if
+``coordsys=GAL``, and a radius that is specified by the ``rad`` parameter.
+Rectangular regions are defined by a center, again specified by either the
+``ra`` and ``dec`` or the ``glon`` and ``glat`` parameters, a ``width`` parameter,
+a ``height`` parameter and a ``posang`` parameter that specified the position
+angle measured counter clockwise from celestial North. Note that the ``height``
+axis is pointing in the direction of the position angle. Reflected regions are
+only generated for offset angles with respect to the pointing direction that are
+smaller than the value specified by the ``maxoffset`` parameter. If less than
+``bkgregmin`` reflected regions can be found because the offset angle between
+source and pointing direction is too small, the observation will be skipped.
+Regions to be excluded for background determination can be specified using a
+FITS mask file that is specified using the ``inexclusion`` parameter. A mask is
+a sky map where all pixel values that differ from zero will be used as exclusion
+region. If the FITS file contains multiple extensions and the user does not
+specify which one to use, the extention ``EXCLUSION`` will be used if available
+(e.g., if you use a skymap generated by :ref:`ctskymap`). Otherwise the primary
+extension will be used.
 Alternatively, if ``bkgmethod=CUSTOM`` is specified, the source and background
 regions will be specified using the ``srcregfile`` and ``bkgregfile`` parameters,
@@ -132,9 +137,9 @@ General parameters
     Exponent of the power law for ``POW`` energy binning. An exponent of 1.0
     corresponds to a logarithmic energy binning.
-``(srcshape = CIRCLE) <CIRCLE> [string]``
-    Shape of the source region. So far only ``CIRCLE`` exists which defines a
-    circular region around given position.
+``srcshape <CIRCLE|RECT> [string]``
+    Shape of the source region. ``CIRCLE`` defines a circular region around given
+    position, ``RECT`` defines a rectangle centred on a given position.
 ``coordsys <CEL|GAL> [string]``
     Coordinate system (CEL - celestial, GAL - galactic).
@@ -154,6 +159,16 @@ General parameters
 ``rad [real]``
     Radius of source region circle (deg).
+``width [real]``
+    Width of source region rectangle (deg).
+
+``height [real]``
+    Height of source region rectangle (deg).
+
+``posang [real]``
+    Position angle of source region rectangle, counted counterclockwise from
+    celestial North (deg).
+
 ``srcregfile [file]``
     Source region file (ds9 or FITS WCS map).