Eirik Hatlen / ctools

Commit 5b8d2af9a1380278d702aa1c1998e93824eb9ece

Authored by Andreas Specovius
Committed by Jürgen Knödlseder
1 parent e2684ff0

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 @5b8d2af
... ... @@ -828,15 +828,25 @@ class csphagen(ctools.csobservation):
828 828 # Return
829 829 return
830 830  
831   - def exclmap(self, mapobj=None):
  831 + def exclregmap(self, regmapobj=None):
832 832 """
833   - Access exclusion map object
  833 + Access exclusion region map object
  834 +
  835 + Parameters
  836 + ----------
  837 + regmapobj : `~gammalib.GSkyRegionMap`
  838 + Excluded regions region map instance
  839 +
  840 + Returns
  841 + -------
  842 + reg : `~gammalib.GSkyRegionMap`
  843 + Excluded regions region map instance
834 844 """
835 845 # Check if exclusion map object was provided
836   - if mapobj is not None:
  846 + if regmapobj is not None:
837 847  
838 848 # Set exclusion region map
839   - self._excl_reg = gammalib.GSkyRegionMap(mapobj)
  849 + self._excl_reg = gammalib.GSkyRegionMap(regmapobj)
840 850  
841 851 # Set has exclusion to yes
842 852 self._has_exclusion = True
... ...