Skip to content

Commit

Permalink
add docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jchiang87 committed Jul 8, 2019
1 parent e04e752 commit b19d587
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions python/desc/imsim/skyModel.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,25 @@ def get_chip_center(chip_name, camera):

return center_x, center_y


class NullSkyModel(NoiseAndBackgroundBase):
"""
Class to disable the sky model entirely. Can be used to produce
FITS file for object injection or for testing individual object
rendering.
"""
def __init__(self):
pass

def addNoiseAndBackground(self, image, **kwds):
"""
Return the image as-is, i.e., without adding any sky background
photons.
"""
return image

def getNoiseModel(self, **kwds):
raise NotImplementedError("This should not be called.")

def sky_counts(self, chipName):
"""Return zero sky background counts."""
return 0

class ESOSkyModel(NoiseAndBackgroundBase):
Expand Down

0 comments on commit b19d587

Please sign in to comment.