Eirik Hatlen / ctools

Commit 26abd1602b74749455207c4aeedb03c7926bb708

Authored by Andreas Specovius
Committed by Luigi Tibaldo
1 parent 4940664e

For clarification I renamed the mapobj parameter to regmapobj as it handles GSky… 

…RegionMap instead of GSkyMap. Updated function documentation.
Inline Side-by-side
Showing 1 changed file with 14 additions and 4 deletions
cscripts/csphagen.py
  View file @26abd16
... ... @@ -829,15 +829,25 @@ class csphagen(ctools.csobservation):
829 829 # Return
830 830 return
831 831  
832   - def exclmap(self, mapobj=None):
  832 + def exclregmap(self, regmapobj=None):
833 833 """
834   - Access exclusion map object
  834 + Access exclusion region map object
  835 +
  836 + Parameters
  837 + ----------
  838 + regmapobj : `~gammalib.GSkyRegionMap`
  839 + Excluded regions region map instance
  840 +
  841 + Returns
  842 + -------
  843 + reg : `~gammalib.GSkyRegionMap`
  844 + Excluded regions region map instance
835 845 """
836 846 # Check if exclusion map object was provided
837   - if mapobj is not None:
  847 + if regmapobj is not None:
838 848  
839 849 # Set exclusion region map
840   - self._excl_reg = gammalib.GSkyRegionMap(mapobj)
  850 + self._excl_reg = gammalib.GSkyRegionMap(regmapobj)
841 851  
842 852 # Set has exclusion to yes
843 853 self._has_exclusion = True
... ...