LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
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:

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
 
 showAmpGain
 
 markSize
 
 markValue
 
 ampImValue
 
 scaleGain
 

Detailed Description

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

Definition at line 241 of file utils.py.

Constructor & Destructor Documentation

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

Construct a FakeImageDataSource.

Parameters
[in]isTrimmedShould amps be trimmed?
[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 244 of file utils.py.

245  ampImValue=None, scaleGain = lambda gain: (gain*1000)//10):
246  """!Construct a FakeImageDataSource
247 
248  @param[in] isTrimmed Should amps be trimmed?
249  @param[in] showAmpGain color the amp segments with the gain of the amp
250  @param[in] markSize size of the side of the box used to mark the read corner
251  @param[in] markValue value to assing the read corner mark
252  @param[in] ampImValue Value to assing to amps. scaleGain(gain) is used if None
253  @param[in] scaleGain function to scale the gain by
254  """
255  self.isTrimmed = isTrimmed
256  self.showAmpGain = showAmpGain
257  self.markSize = markSize
258  self.markValue = markValue
259  self.ampImValue = ampImValue
260  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 271 of file utils.py.

272  def getAmpImage(self, amp, imageFactory):
273  """!Return an amp segment image
274 
275  @param[in] amp AmpInfoTable for this amp
276  @param[in] imageFactory image constructor fo making the imag
277  """
278  ampImage = makeImageFromAmp(amp, imValue=self.ampImValue, imageFactory=imageFactory,
279  markSize=self.markSize,
280  markValue=self.markValue, scaleGain=self.scaleGain)
281  if self.isTrimmed:
282  ampImage = ampImage.Factory(ampImage, amp.getRawDataBBox(), False)
283  return ampImage
def makeImageFromAmp
Make an image from an amp object.
Definition: utils.py:138
def getAmpImage
Return an amp segment image.
Definition: utils.py:271
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 261 of file utils.py.

262  def getCcdImage(self, det, imageFactory, binSize):
263  """!Return a CCD image for the detector
264 
265  @param[in] det: Detector to use for making the image
266  @param[in] imageFactory: image constructor for making the image
267  @param[in] binSize: number of pixels per bin axis
268  """
269  return makeImageFromCcd(det, isTrimmed=self.isTrimmed, showAmpGain=self.showAmpGain,
270  imageFactory=imageFactory, binSize=binSize)
def getCcdImage
Return a CCD image for the detector.
Definition: utils.py:261
def makeImageFromCcd
Make an Image of a Ccd.
Definition: utils.py:201

Member Data Documentation

lsst.afw.cameraGeom.utils.FakeImageDataSource.ampImValue

Definition at line 258 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.isTrimmed

Definition at line 254 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.markSize

Definition at line 256 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.markValue

Definition at line 257 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.scaleGain

Definition at line 259 of file utils.py.

lsst.afw.cameraGeom.utils.FakeImageDataSource.showAmpGain

Definition at line 255 of file utils.py.


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