Coverage for python/lsst/sims/photUtils/PhotometricParameters.py : 100%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
""" This class will just contain a bunch of dict which store the default PhotometricParameters for LSST Bandpasses
Users should not access this class (which is why it is not included in the __all__ declaration for this file).
It is only used to initialize PhotometricParameters off of a bandpass name. """
# Obviously, some of these parameters (effarea, gain, platescale, # darkcurrent, and readnoise) will not change as a function of bandpass; # we are just making them dicts here to be consistent with # everything else (and to make it possible for # PhotometricParameters to access them using the bandpass name # passed to its constructor) # # Note: all dicts contain an 'any' key which will be the default # value if an unknown bandpass is asked for # # 'any' values should be kept consistent with r band
bandpassNames = ('u', 'g', 'r', 'i', 'z', 'y', 'any')):
# exposure time in seconds
# number of exposures
# effective area in cm^2
# electrons per ADU
# electrons per pixel per exposure
# electrons per pixel per second
# electrons per pixel per exposure
# arcseconds per pixel
# systematic squared error in magnitudes # see Table 14 of the SRD document # https://docushare.lsstcorp.org/docushare/dsweb/Get/LPM-17 'any':0.005}
nexp=None, effarea=None, gain=None, readnoise=None, darkcurrent=None, othernoise=None, platescale=None, sigmaSys=None, bandpass=None):
""" @param [in] exptime exposure time in seconds (defaults to LSST value)
@param [in] nexp number of exposures (defaults to LSST value)
@param [in] effarea effective area in cm^2 (defaults to LSST value)
@param [in] gain electrons per ADU (defaults to LSST value)
@param [in] readnoise electrons per pixel per exposure (defaults to LSST value)
@param [in] darkcurrent electons per pixel per second (defaults to LSST value)
@param [in] othernoise electrons per pixel per exposure (defaults to LSST value)
@param [in] platescale arcseconds per pixel (defaults to LSST value)
@param [in] sigmaSys systematic error in magnitudes (defaults to LSST value)
@param [in] bandpass is the name of the bandpass to which these parameters correspond. If set to an LSST bandpass, the constructor will initialize PhotometricParameters to LSST default values for that bandpass, excepting any parameters that have been set by hand, i.e
myPhotParams = PhotometricParameters(nexp=3, bandpass='u')
will initialize a PhotometricParameters object to u bandpass defaults, except with 3 exposures instead of 2.
If bandpass is left as None, other parameters will default to LSST r band values (except for those values set by hand). The bandpass member variable of PhotometricParameters will, however, remain None. """
# readnoise, darkcurrent and othernoise are measured in electrons. # This is taken from the specifications document LSE-30 on Docushare # Section 3.4.2.3 states that the total noise per pixel shall be 12.7 electrons per visit # which the defaults sum to (remember to multply darkcurrent by the number # of seconds in an exposure=15). [9 e- per 15 second exposure]
# This is so we do not set the self._bandpass member variable # without the user's explicit consent, but we can still access # default values from the PhotometricParameterDefaults else:
def bandpass(self): """ The name of the bandpass associated with these parameters (can be None) """
def bandpass(self, value): "Just instantiate a new case of PhotometricParameters")
def exptime(self): """ exposure time in seconds """
def exptime(self, value): "Just instantiate a new case of PhotometricParameters")
def nexp(self): """ number of exposures """
def nexp(self, value): "Just instantiate a new case of PhotometricParameters")
def effarea(self): """ effective area in cm^2 """
def effarea(self, value): "Just instantiate a new case of PhotometricParameters")
def gain(self): """ electrons per ADU """
def gain(self, value): "Just instantiate a new case of PhotometricParameters")
def platescale(self): """ arcseconds per pixel """
def platescale(self, value): "Just instantiate a new case of PhotometricParameters")
def readnoise(self): """ electrons per pixel per exposure """
def readnoise(self, value): "Just instantiate a new case of PhotometricParameters")
def darkcurrent(self): """ electrons per pixel per second """
def darkcurrent(self, value): "Just instantiate a new case of PhotometricParameters")
def othernoise(self): """ electrons per pixel per exposure """
def othernoise(self,value): "Just instantiate a new case of PhotometricParameters")
def sigmaSys(self): """ systematic error in magnitudes """
def sigmaSys(self, value): "Just instantiate a new case of PhotometricParameters") |