LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst.afw.cameraGeom.utils.FakeImageDataSource Class Reference
Inheritance diagram for lsst.afw.cameraGeom.utils.FakeImageDataSource:
lsst.afw.cameraGeom.utils.ButlerImage

Public Member Functions

def __init__
 Construct a FakeImageDataSource. More...
 
def getCcdImage
 Return a CCD image for the detector. More...
 
def getAmpImage
 Return an amp segment image. More...
 

Public Attributes

 isTrimmed
 
 verbose
 
 background
 
 showAmpGain
 
 markSize
 
 markValue
 
 ampImValue
 
 scaleGain
 

Detailed Description

A class to retrieve synthetic images for display by the show* methods

Definition at line 248 of file utils.py.

Constructor & Destructor Documentation

def lsst.afw.cameraGeom.utils.FakeImageDataSource.__init__ (   self,
  isTrimmed = True,
  verbose = False,
  background = numpy.nan,
  showAmpGain = True,
  markSize = 10,
  markValue = 0,
  ampImValue = None,
  scaleGain = lambda gain: (gain*1000)//10 
)

Construct a FakeImageDataSource.

Parameters
[in]isTrimmedShould amps be trimmed?
[in]verboseBe chatty
[in]backgroundThe value of any pixels that lie outside the CCDs
[in]showAmpGaincolor the amp segments with the gain of the amp
[in]markSizesize of the side of the box used to mark the read corner
[in]markValuevalue to assing the read corner mark
[in]ampImValueValue to assing to amps. scaleGain(gain) is used if None
[in]scaleGainfunction to scale the gain by

Definition at line 252 of file utils.py.

253  ampImValue=None, scaleGain=lambda gain: (gain*1000)//10):
254  """!Construct a FakeImageDataSource
255 
256  @param[in] isTrimmed Should amps be trimmed?
257  @param[in] verbose Be chatty
258  @param[in] background The value of any pixels that lie outside the CCDs
259  @param[in] showAmpGain color the amp segments with the gain of the amp
260  @param[in] markSize size of the side of the box used to mark the read corner
261  @param[in] markValue value to assing the read corner mark
262  @param[in] ampImValue Value to assing to amps. scaleGain(gain) is used if None
263  @param[in] scaleGain function to scale the gain by
264  """
265  self.isTrimmed = isTrimmed
266  self.verbose = verbose
267  self.background = background
268  self.showAmpGain = showAmpGain
269  self.markSize = markSize
270  self.markValue = markValue
271  self.ampImValue = ampImValue
272  self.scaleGain = scaleGain

Member Function Documentation

def lsst.afw.cameraGeom.utils.FakeImageDataSource.getAmpImage (   self,
  amp,
  imageFactory 
)

Return an amp segment image.

Parameters
[in]ampAmpInfoTable for this amp
[in]imageFactoryimage constructor fo making the imag

Definition at line 283 of file utils.py.

284  def getAmpImage(self, amp, imageFactory):
285  """!Return an amp segment image
286 
287  @param[in] amp AmpInfoTable for this amp
288  @param[in] imageFactory image constructor fo making the imag
289  """
290  ampImage = makeImageFromAmp(amp, imValue=self.ampImValue, imageFactory=imageFactory,
291  markSize=self.markSize,
292  markValue=self.markValue, scaleGain=self.scaleGain)
293  if self.isTrimmed:
294  ampImage = ampImage.Factory(ampImage, amp.getRawDataBBox(), False)
295  return ampImage
def makeImageFromAmp
Make an image from an amp object.
Definition: utils.py:145
def getAmpImage
Return an amp segment image.
Definition: utils.py:283
def lsst.afw.cameraGeom.utils.FakeImageDataSource.getCcdImage (   self,
  det,
  imageFactory,
  binSize 
)

Return a CCD image for the detector.

Parameters
[in]det:Detector to use for making the image
[in]imageFactory:image constructor for making the image
[in]binSize:number of pixels per bin axis

Definition at line 273 of file utils.py.

274  def getCcdImage(self, det, imageFactory, binSize):
275  """!Return a CCD image for the detector
276 
277  @param[in] det: Detector to use for making the image
278  @param[in] imageFactory: image constructor for making the image
279  @param[in] binSize: number of pixels per bin axis
280  """
281  return makeImageFromCcd(det, isTrimmed=self.isTrimmed, showAmpGain=self.showAmpGain,
282  imageFactory=imageFactory, binSize=binSize)
def getCcdImage
Return a CCD image for the detector.
Definition: utils.py:273
def makeImageFromCcd
Make an Image of a Ccd.
Definition: utils.py:208

Member Data Documentation

lsst.afw.cameraGeom.utils.FakeImageDataSource.ampImValue

Definition at line 270 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.background

Definition at line 266 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.isTrimmed

Definition at line 264 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.markSize

Definition at line 268 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.markValue

Definition at line 269 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.scaleGain

Definition at line 271 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.showAmpGain

Definition at line 267 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.verbose

Definition at line 265 of file utils.py.


The documentation for this class was generated from the following file: