LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.afw.cameraGeom.utils Namespace Reference

Classes

class  ButlerImage
 
class  FakeImageDataSource
 

Functions

 prepareWcsData (wcs, amp, isTrimmed=True)
 
 plotFocalPlane (camera, fieldSizeDeg_x=0, fieldSizeDeg_y=None, dx=0.1, dy=0.1, figsize=(10., 10.), useIds=False, showFig=True, savePath=None)
 
 makeImageFromAmp (amp, imValue=None, imageFactory=afwImage.ImageU, markSize=10, markValue=0, scaleGain=lambda gain:(gain *1000)//10)
 
 calcRawCcdBBox (ccd)
 
 makeImageFromCcd (ccd, isTrimmed=True, showAmpGain=True, imageFactory=afwImage.ImageU, rcMarkSize=10, binSize=1)
 
 rawCallback (im, ccd=None, imageSource=None, correctGain=False, subtractBias=False, convertToFloat=False, obeyNQuarter=True)
 
 overlayCcdBoxes (ccd, untrimmedCcdBbox=None, nQuarter=0, isTrimmed=False, ccdOrigin=(0, 0), display=None, binSize=1)
 
 showAmp (amp, imageSource=FakeImageDataSource(isTrimmed=False), display=None, overlay=True, imageFactory=afwImage.ImageU)
 
 showCcd (ccd, imageSource=FakeImageDataSource(), display=None, overlay=True, imageFactory=afwImage.ImageF, binSize=1, inCameraCoords=False)
 
 getCcdInCamBBoxList (ccdList, binSize, pixelSize_o, origin)
 
 getCameraImageBBox (camBbox, pixelSize, bufferSize)
 
 makeImageFromCamera (camera, detectorNameList=None, background=numpy.nan, bufferSize=10, imageSource=FakeImageDataSource(), imageFactory=afwImage.ImageU, binSize=1)
 
 showCamera (camera, imageSource=FakeImageDataSource(), imageFactory=afwImage.ImageF, detectorNameList=None, binSize=10, bufferSize=10, overlay=True, title="", showWcs=None, ctype=afwDisplay.GREEN, textSize=1.25, originAtCenter=True, display=None, **kwargs)
 
 makeFocalPlaneWcs (pixelSize, referencePixel)
 
 findAmp (ccd, pixelPosition)
 

Variables

 _LOG = logging.getLogger(__name__)
 

Detailed Description

Support for displaying cameraGeom objects.

Function Documentation

◆ calcRawCcdBBox()

lsst.afw.cameraGeom.utils.calcRawCcdBBox ( ccd)
Calculate the raw ccd bounding box.

Parameters
----------
ccd : `lsst.afw.cameraGeom.Detector`
    Detector for which to calculate the un-trimmed bounding box.

Returns
-------
bbox : `lsst.geom.Box2I` or `None`
    Bounding box of the un-trimmed Detector, or `None` if there is not enough
    information to calculate raw BBox.

Definition at line 244 of file utils.py.

244def calcRawCcdBBox(ccd):
245 """Calculate the raw ccd bounding box.
246
247 Parameters
248 ----------
249 ccd : `lsst.afw.cameraGeom.Detector`
250 Detector for which to calculate the un-trimmed bounding box.
251
252 Returns
253 -------
254 bbox : `lsst.geom.Box2I` or `None`
255 Bounding box of the un-trimmed Detector, or `None` if there is not enough
256 information to calculate raw BBox.
257 """
258 bbox = lsst.geom.Box2I()
259 for amp in ccd:
260 tbbox = amp.getRawBBox()
261 tbbox.shift(amp.getRawXYOffset())
262 bbox.include(tbbox)
263 return bbox
264
265
An integer coordinate rectangle.
Definition Box.h:55

◆ findAmp()

lsst.afw.cameraGeom.utils.findAmp ( ccd,
pixelPosition )
Find the Amp with the specified pixel position within the composite

Parameters
----------
ccd : `lsst.afw.cameraGeom.Detector`
    Detector to look in.
pixelPosition : `lsst.geom.Point2I`
    The pixel position to find the amp for.

Returns
-------
`lsst.afw.table.AmpInfoCatalog`
    Amp record in which ``pixelPosition`` falls or `None` if no Amp found.

Definition at line 1064 of file utils.py.

1064def findAmp(ccd, pixelPosition):
1065 """Find the Amp with the specified pixel position within the composite
1066
1067 Parameters
1068 ----------
1069 ccd : `lsst.afw.cameraGeom.Detector`
1070 Detector to look in.
1071 pixelPosition : `lsst.geom.Point2I`
1072 The pixel position to find the amp for.
1073
1074 Returns
1075 -------
1076 `lsst.afw.table.AmpInfoCatalog`
1077 Amp record in which ``pixelPosition`` falls or `None` if no Amp found.
1078 """
1079 for amp in ccd:
1080 if amp.getBBox().contains(pixelPosition):
1081 return amp
1082
1083 return None

◆ getCameraImageBBox()

lsst.afw.cameraGeom.utils.getCameraImageBBox ( camBbox,
pixelSize,
bufferSize )
Get the bounding box of a camera sized image in pixels

Parameters
----------
camBbox : `lsst.geom.Box2D`
    Camera bounding box in focal plane coordinates (mm).
pixelSize : `float`
    Size of a detector pixel in mm.
bufferSize : `int`
    Buffer around edge of image in pixels.

Returns
-------
box : `lsst.geom.Box2I`
    The resulting bounding box.

Definition at line 829 of file utils.py.

829def getCameraImageBBox(camBbox, pixelSize, bufferSize):
830 """Get the bounding box of a camera sized image in pixels
831
832 Parameters
833 ----------
834 camBbox : `lsst.geom.Box2D`
835 Camera bounding box in focal plane coordinates (mm).
836 pixelSize : `float`
837 Size of a detector pixel in mm.
838 bufferSize : `int`
839 Buffer around edge of image in pixels.
840
841 Returns
842 -------
843 box : `lsst.geom.Box2I`
844 The resulting bounding box.
845 """
846 pixMin = lsst.geom.Point2I(int(camBbox.getMinX()//pixelSize.getX()),
847 int(camBbox.getMinY()//pixelSize.getY()))
848 pixMax = lsst.geom.Point2I(int(camBbox.getMaxX()//pixelSize.getX()),
849 int(camBbox.getMaxY()//pixelSize.getY()))
850 retBox = lsst.geom.Box2I(pixMin, pixMax)
851 retBox.grow(bufferSize)
852 return retBox
853
854

◆ getCcdInCamBBoxList()

lsst.afw.cameraGeom.utils.getCcdInCamBBoxList ( ccdList,
binSize,
pixelSize_o,
origin )
Get the bounding boxes of a list of Detectors within a camera sized pixel grid

Parameters
----------
ccdList : `lsst.afw.cameraGeom.Detector`
    List of Detector.
binSize : `int`
    Bin the image by this factor in both dimensions.
pixelSize_o : `float`
    Size of the pixel in mm.
origin : `int`
    Origin of the camera pixel grid in pixels.

Returns
-------
boxList : `list` [`lsst.geom.Box2I`]
    A list of bounding boxes in camera pixel coordinates.

Definition at line 785 of file utils.py.

785def getCcdInCamBBoxList(ccdList, binSize, pixelSize_o, origin):
786 """Get the bounding boxes of a list of Detectors within a camera sized pixel grid
787
788 Parameters
789 ----------
790 ccdList : `lsst.afw.cameraGeom.Detector`
791 List of Detector.
792 binSize : `int`
793 Bin the image by this factor in both dimensions.
794 pixelSize_o : `float`
795 Size of the pixel in mm.
796 origin : `int`
797 Origin of the camera pixel grid in pixels.
798
799 Returns
800 -------
801 boxList : `list` [`lsst.geom.Box2I`]
802 A list of bounding boxes in camera pixel coordinates.
803 """
804 boxList = []
805 for ccd in ccdList:
806 if not pixelSize_o == ccd.getPixelSize():
807 raise RuntimeError(
808 "Cameras with detectors with different pixel scales are not currently supported")
809
810 dbbox = lsst.geom.Box2D()
811 for corner in ccd.getCorners(FOCAL_PLANE):
812 dbbox.include(corner)
813 llc = dbbox.getMin()
814 nQuarter = ccd.getOrientation().getNQuarter()
815 cbbox = ccd.getBBox()
816 ex = cbbox.getDimensions().getX()//binSize
817 ey = cbbox.getDimensions().getY()//binSize
818 bbox = lsst.geom.Box2I(
819 cbbox.getMin(), lsst.geom.Extent2I(int(ex), int(ey)))
820 bbox = rotateBBoxBy90(bbox, nQuarter, bbox.getDimensions())
821 bbox.shift(lsst.geom.Extent2I(int(llc.getX()//pixelSize_o.getX()/binSize),
822 int(llc.getY()//pixelSize_o.getY()/binSize)))
823 bbox.shift(lsst.geom.Extent2I(-int(origin.getX()//binSize),
824 -int(origin.getY())//binSize))
825 boxList.append(bbox)
826 return boxList
827
828
A floating-point coordinate rectangle geometry.
Definition Box.h:413

◆ makeFocalPlaneWcs()

lsst.afw.cameraGeom.utils.makeFocalPlaneWcs ( pixelSize,
referencePixel )
Make a WCS for the focal plane geometry
(i.e. one that returns positions in "mm")

Parameters
----------
pixelSize : `float`
    Size of the image pixels in physical units
referencePixel : `lsst.geom.Point2D`
    Pixel for origin of WCS

Returns
-------
`lsst.afw.geom.Wcs`
    Wcs object for mapping between pixels and focal plane.

Definition at line 1032 of file utils.py.

1032def makeFocalPlaneWcs(pixelSize, referencePixel):
1033 """Make a WCS for the focal plane geometry
1034 (i.e. one that returns positions in "mm")
1035
1036 Parameters
1037 ----------
1038 pixelSize : `float`
1039 Size of the image pixels in physical units
1040 referencePixel : `lsst.geom.Point2D`
1041 Pixel for origin of WCS
1042
1043 Returns
1044 -------
1045 `lsst.afw.geom.Wcs`
1046 Wcs object for mapping between pixels and focal plane.
1047 """
1048 md = dafBase.PropertySet()
1049 if referencePixel is None:
1050 referencePixel = lsst.geom.PointD(0, 0)
1051 for i in range(2):
1052 md.set("CRPIX%d"%(i + 1), referencePixel[i])
1053 md.set("CRVAL%d"%(i + 1), 0.)
1054 md.set("CDELT1", pixelSize[0])
1055 md.set("CDELT2", pixelSize[1])
1056 md.set("CTYPE1", "CAMERA_X")
1057 md.set("CTYPE2", "CAMERA_Y")
1058 md.set("CUNIT1", "mm")
1059 md.set("CUNIT2", "mm")
1060
1061 return afwGeom.makeSkyWcs(md)
1062
1063
Class for storing generic metadata.
Definition PropertySet.h:66
std::shared_ptr< SkyWcs > makeSkyWcs(daf::base::PropertySet &metadata, bool strip=false)
Construct a SkyWcs from FITS keywords.
Definition SkyWcs.cc:521

◆ makeImageFromAmp()

lsst.afw.cameraGeom.utils.makeImageFromAmp ( amp,
imValue = None,
imageFactory = afwImage.ImageU,
markSize = 10,
markValue = 0,
scaleGain = lambda gain: (gain*1000)//10 )
Make an image from an amp object.

Since images are integer images by default, the gain needs to be scaled to
give enough dynamic range to see variation from amp to amp.
The scaling algorithm is assignable.

Parameters
----------
amp : `lsst.afw.table.AmpInfoRecord`
    Amp record to use for constructing the raw amp image.
imValue : `float` or `None`
    Value to assign to the constructed image, or scaleGain(gain) if `None`.
imageFactory : callable like `lsst.afw.image.Image`
    Type of image to construct.
markSize : `float`
    Size of mark at read corner in pixels.
markValue : `float`
    Value of pixels in the read corner mark.
scaleGain : callable
    The function by which to scale the gain (must take a single argument).

Returns
-------
ampImage : `lsst.afw.image`
    An untrimmed amp image, of the type produced by ``imageFactory``.

Definition at line 185 of file utils.py.

186 scaleGain=lambda gain: (gain*1000)//10):
187 """Make an image from an amp object.
188
189 Since images are integer images by default, the gain needs to be scaled to
190 give enough dynamic range to see variation from amp to amp.
191 The scaling algorithm is assignable.
192
193 Parameters
194 ----------
195 amp : `lsst.afw.table.AmpInfoRecord`
196 Amp record to use for constructing the raw amp image.
197 imValue : `float` or `None`
198 Value to assign to the constructed image, or scaleGain(gain) if `None`.
199 imageFactory : callable like `lsst.afw.image.Image`
200 Type of image to construct.
201 markSize : `float`
202 Size of mark at read corner in pixels.
203 markValue : `float`
204 Value of pixels in the read corner mark.
205 scaleGain : callable
206 The function by which to scale the gain (must take a single argument).
207
208 Returns
209 -------
210 ampImage : `lsst.afw.image`
211 An untrimmed amp image, of the type produced by ``imageFactory``.
212 """
213 bbox = amp.getRawBBox()
214 dbbox = amp.getRawDataBBox()
215 img = imageFactory(bbox)
216 if imValue is None:
217 img.set(int(scaleGain(amp.getGain())))
218 else:
219 img.set(imValue)
220 # Set the first pixel read to a different value
221 markbbox = lsst.geom.Box2I()
222 if amp.getReadoutCorner() == afwCameraGeom.ReadoutCorner.LL:
223 markbbox.include(dbbox.getMin())
224 markbbox.include(dbbox.getMin() + lsst.geom.Extent2I(markSize, markSize))
225 elif amp.getReadoutCorner() == afwCameraGeom.ReadoutCorner.LR:
226 cornerPoint = lsst.geom.Point2I(dbbox.getMaxX(), dbbox.getMinY())
227 markbbox.include(cornerPoint)
228 markbbox.include(cornerPoint + lsst.geom.Extent2I(-markSize, markSize))
229 elif amp.getReadoutCorner() == afwCameraGeom.ReadoutCorner.UR:
230 cornerPoint = lsst.geom.Point2I(dbbox.getMax())
231 markbbox.include(cornerPoint)
232 markbbox.include(cornerPoint + lsst.geom.Extent2I(-markSize, -markSize))
233 elif amp.getReadoutCorner() == afwCameraGeom.ReadoutCorner.UL:
234 cornerPoint = lsst.geom.Point2I(dbbox.getMinX(), dbbox.getMaxY())
235 markbbox.include(cornerPoint)
236 markbbox.include(cornerPoint + lsst.geom.Extent2I(markSize, -markSize))
237 else:
238 raise RuntimeError("Could not set readout corner")
239 mimg = imageFactory(img, markbbox)
240 mimg.set(markValue)
241 return img
242
243

◆ makeImageFromCamera()

lsst.afw.cameraGeom.utils.makeImageFromCamera ( camera,
detectorNameList = None,
background = numpy.nan,
bufferSize = 10,
imageSource = FakeImageDataSource(),
imageFactory = afwImage.ImageU,
binSize = 1 )
Make an Image of a Camera.

Put each detector's image in the correct location and orientation on the
focal plane. The input images can be binned to an integer fraction of their
original bboxes.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera object to use to make the image.
detectorNameList : `list` [`str`]
    List of detector names from ``camera`` to use in building the image.
    Use all Detectors if `None`.
background : `float`
    Value to use where there is no Detector.
bufferSize : `int`
    Size of border in binned pixels to make around the camera image.
imageSource : `FakeImageDataSource` or `None`
    Source to get ccd images.  Must have a ``getCcdImage()`` method.
imageFactory : callable like `lsst.afw.image.Image`
    Type of image to build.
binSize : `int`
    Bin the image by this factor in both dimensions.

Returns
-------
image : `lsst.afw.image.Image`
    Image of the entire camera.

Definition at line 855 of file utils.py.

856 imageSource=FakeImageDataSource(), imageFactory=afwImage.ImageU, binSize=1):
857 """Make an Image of a Camera.
858
859 Put each detector's image in the correct location and orientation on the
860 focal plane. The input images can be binned to an integer fraction of their
861 original bboxes.
862
863 Parameters
864 ----------
865 camera : `lsst.afw.cameraGeom.Camera`
866 Camera object to use to make the image.
867 detectorNameList : `list` [`str`]
868 List of detector names from ``camera`` to use in building the image.
869 Use all Detectors if `None`.
870 background : `float`
871 Value to use where there is no Detector.
872 bufferSize : `int`
873 Size of border in binned pixels to make around the camera image.
874 imageSource : `FakeImageDataSource` or `None`
875 Source to get ccd images. Must have a ``getCcdImage()`` method.
876 imageFactory : callable like `lsst.afw.image.Image`
877 Type of image to build.
878 binSize : `int`
879 Bin the image by this factor in both dimensions.
880
881 Returns
882 -------
883 image : `lsst.afw.image.Image`
884 Image of the entire camera.
885 """
886 log = _LOG.getChild("makeImageFromCamera")
887
888 if detectorNameList is None:
889 ccdList = camera
890 else:
891 ccdList = [camera[name] for name in detectorNameList]
892
893 if detectorNameList is None:
894 camBbox = camera.getFpBBox()
895 else:
896 camBbox = lsst.geom.Box2D()
897 for detName in detectorNameList:
898 for corner in camera[detName].getCorners(FOCAL_PLANE):
899 camBbox.include(corner)
900
901 pixelSize_o = camera[next(camera.getNameIter())].getPixelSize()
902 camBbox = getCameraImageBBox(camBbox, pixelSize_o, bufferSize*binSize)
903 origin = camBbox.getMin()
904
905 camIm = imageFactory(int(math.ceil(camBbox.getDimensions().getX()/binSize)),
906 int(math.ceil(camBbox.getDimensions().getY()/binSize)))
907 camIm[:] = imageSource.background
908
909 assert imageSource.isTrimmed, "isTrimmed is False isn't supported by getCcdInCamBBoxList"
910
911 boxList = getCcdInCamBBoxList(ccdList, binSize, pixelSize_o, origin)
912 for det, bbox in zip(ccdList, boxList):
913 im = imageSource.getCcdImage(det, imageFactory, binSize)[0]
914 if im is None:
915 continue
916
917 imView = camIm.Factory(camIm, bbox, afwImage.LOCAL)
918 try:
919 imView[:] = im
921 log.exception("Unable to fit image for detector \"%s\" into image of camera.", det.getName())
922
923 return camIm
924
925
Reports attempts to exceed implementation-defined length limits for some classes.
Definition Runtime.h:76

◆ makeImageFromCcd()

lsst.afw.cameraGeom.utils.makeImageFromCcd ( ccd,
isTrimmed = True,
showAmpGain = True,
imageFactory = afwImage.ImageU,
rcMarkSize = 10,
binSize = 1 )
Make an Image of a CCD.

Parameters
----------
ccd : `lsst.afw.cameraGeom.Detector`
    Detector to use in making the image.
isTrimmed : `bool`
    Assemble a trimmed Detector image.
showAmpGain : `bool`
    Use the per-amp gain to color the pixels in the image?
imageFactory : callable like `lsst.afw.image.Image`
    Image type to generate.
rcMarkSize : `float`
    Size of the mark to make in the amp images at the read corner.
binSize : `int`
    Bin the image by this factor in both dimensions.

Returns
-------
image : `lsst.afw.image.Image`
    Image of the Detector (type returned by ``imageFactory``).

Definition at line 266 of file utils.py.

267 binSize=1):
268 """Make an Image of a CCD.
269
270 Parameters
271 ----------
272 ccd : `lsst.afw.cameraGeom.Detector`
273 Detector to use in making the image.
274 isTrimmed : `bool`
275 Assemble a trimmed Detector image.
276 showAmpGain : `bool`
277 Use the per-amp gain to color the pixels in the image?
278 imageFactory : callable like `lsst.afw.image.Image`
279 Image type to generate.
280 rcMarkSize : `float`
281 Size of the mark to make in the amp images at the read corner.
282 binSize : `int`
283 Bin the image by this factor in both dimensions.
284
285 Returns
286 -------
287 image : `lsst.afw.image.Image`
288 Image of the Detector (type returned by ``imageFactory``).
289 """
290 ampImages = []
291 index = 0
292 if isTrimmed:
293 bbox = ccd.getBBox()
294 else:
295 bbox = calcRawCcdBBox(ccd)
296 for amp in ccd:
297 if showAmpGain:
298 ampImages.append(makeImageFromAmp(
299 amp, imageFactory=imageFactory, markSize=rcMarkSize))
300 else:
301 ampImages.append(makeImageFromAmp(amp, imValue=(index + 1)*1000,
302 imageFactory=imageFactory, markSize=rcMarkSize))
303 index += 1
304
305 if len(ampImages) > 0:
306 ccdImage = imageFactory(bbox)
307 for ampImage, amp in zip(ampImages, ccd):
308 if isTrimmed:
309 assembleAmplifierImage(ccdImage, ampImage, amp)
310 else:
311 assembleAmplifierRawImage(ccdImage, ampImage, amp)
312 else:
313 if not isTrimmed:
314 raise RuntimeError(
315 "Cannot create untrimmed CCD without amps with raw information")
316 ccdImage = imageFactory(ccd.getBBox())
317 ccdImage = afwMath.binImage(ccdImage, binSize)
318 return ccdImage
319
320
std::shared_ptr< ImageT > binImage(ImageT const &inImage, int const binX, int const binY, lsst::afw::math::Property const flags=lsst::afw::math::MEAN)
Definition binImage.cc:44

◆ overlayCcdBoxes()

lsst.afw.cameraGeom.utils.overlayCcdBoxes ( ccd,
untrimmedCcdBbox = None,
nQuarter = 0,
isTrimmed = False,
ccdOrigin = (0, 0),
display = None,
binSize = 1 )
Overlay bounding boxes on an image display.

Parameters
----------
ccd : `lsst.afw.cameraGeom.Detector`
    Detector to iterate for the amp bounding boxes.
untrimmedCcdBbox : `lsst.geom.Box2I` or `None`
    Bounding box of the un-trimmed Detector.
nQuarter : `int`
    number of 90 degree rotations to apply to the bounding boxes (used for rotated chips).
isTrimmed : `bool`
    Is the Detector image over which the boxes are layed trimmed?
ccdOrigin : `tuple` of `float`
    Detector origin relative to the parent origin if in a larger pixel grid.
display : `lsst.afw.display.Display`
    Image display to display on.
binSize : `int`
    Bin the image by this factor in both dimensions.

Notes
-----
The colours are:
- Entire detector        GREEN
- All data for amp       GREEN
- HorizontalPrescan      YELLOW
- HorizontalOverscan     RED
- Data                   BLUE
- VerticalOverscan       MAGENTA
- VerticalOverscan       MAGENTA

Definition at line 585 of file utils.py.

586 isTrimmed=False, ccdOrigin=(0, 0), display=None, binSize=1):
587 """Overlay bounding boxes on an image display.
588
589 Parameters
590 ----------
591 ccd : `lsst.afw.cameraGeom.Detector`
592 Detector to iterate for the amp bounding boxes.
593 untrimmedCcdBbox : `lsst.geom.Box2I` or `None`
594 Bounding box of the un-trimmed Detector.
595 nQuarter : `int`
596 number of 90 degree rotations to apply to the bounding boxes (used for rotated chips).
597 isTrimmed : `bool`
598 Is the Detector image over which the boxes are layed trimmed?
599 ccdOrigin : `tuple` of `float`
600 Detector origin relative to the parent origin if in a larger pixel grid.
601 display : `lsst.afw.display.Display`
602 Image display to display on.
603 binSize : `int`
604 Bin the image by this factor in both dimensions.
605
606 Notes
607 -----
608 The colours are:
609 - Entire detector GREEN
610 - All data for amp GREEN
611 - HorizontalPrescan YELLOW
612 - HorizontalOverscan RED
613 - Data BLUE
614 - VerticalOverscan MAGENTA
615 - VerticalOverscan MAGENTA
616 """
617 if not display: # should be second parameter, and not defaulted!!
618 raise RuntimeError("Please specify a display")
619
620 if untrimmedCcdBbox is None:
621 if isTrimmed:
622 untrimmedCcdBbox = ccd.getBBox()
623 else:
624 untrimmedCcdBbox = lsst.geom.Box2I()
625 for a in ccd.getAmplifiers():
626 bbox = a.getRawBBox()
627 untrimmedCcdBbox.include(bbox)
628
629 with display.Buffering():
630 ccdDim = untrimmedCcdBbox.getDimensions()
631 ccdBbox = rotateBBoxBy90(untrimmedCcdBbox, nQuarter, ccdDim)
632 for amp in ccd:
633 if isTrimmed:
634 ampbbox = amp.getBBox()
635 else:
636 ampbbox = amp.getRawBBox()
637 if nQuarter != 0:
638 ampbbox = rotateBBoxBy90(ampbbox, nQuarter, ccdDim)
639
640 displayUtils.drawBBox(ampbbox, origin=ccdOrigin, borderWidth=0.49,
641 display=display, bin=binSize)
642
643 if not isTrimmed:
644 for bbox, ctype in ((amp.getRawHorizontalOverscanBBox(), afwDisplay.RED),
645 (amp.getRawDataBBox(), afwDisplay.BLUE),
646 (amp.getRawVerticalOverscanBBox(),
647 afwDisplay.MAGENTA),
648 (amp.getRawPrescanBBox(), afwDisplay.YELLOW)):
649 if nQuarter != 0:
650 bbox = rotateBBoxBy90(bbox, nQuarter, ccdDim)
651 displayUtils.drawBBox(bbox, origin=ccdOrigin, borderWidth=0.49, ctype=ctype,
652 display=display, bin=binSize)
653 # Label each Amp
654 xc, yc = ((ampbbox.getMin()[0] + ampbbox.getMax()[0])//2,
655 (ampbbox.getMin()[1] + ampbbox.getMax()[1])//2)
656 #
657 # Rotate the amp labels too
658 #
659 if nQuarter == 0:
660 c, s = 1, 0
661 elif nQuarter == 1:
662 c, s = 0, -1
663 elif nQuarter == 2:
664 c, s = -1, 0
665 elif nQuarter == 3:
666 c, s = 0, 1
667 c, s = 1, 0
668 ccdHeight = ccdBbox.getHeight()
669 ccdWidth = ccdBbox.getWidth()
670 xc -= 0.5*ccdHeight
671 yc -= 0.5*ccdWidth
672
673 xc, yc = 0.5*ccdHeight + c*xc + s*yc, 0.5*ccdWidth + -s*xc + c*yc
674
675 if ccdOrigin:
676 xc += ccdOrigin[0]
677 yc += ccdOrigin[1]
678 display.dot(str(amp.getName()), xc/binSize,
679 yc/binSize, textAngle=nQuarter*90)
680
681 displayUtils.drawBBox(ccdBbox, origin=ccdOrigin,
682 borderWidth=0.49, ctype=afwDisplay.MAGENTA, display=display, bin=binSize)
683
684

◆ plotFocalPlane()

lsst.afw.cameraGeom.utils.plotFocalPlane ( camera,
fieldSizeDeg_x = 0,
fieldSizeDeg_y = None,
dx = 0.1,
dy = 0.1,
figsize = (10., 10.),
useIds = False,
showFig = True,
savePath = None )
Make a plot of the focal plane along with a set points that sample
the field of view.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    A camera object
fieldSizeDeg_x : `float`
    Amount of the field to sample in x in degrees
fieldSizeDeg_y : `float` or `None`
    Amount of the field to sample in y in degrees
dx : `float`
    Spacing of sample points in x in degrees
dy : `float`
    Spacing of sample points in y in degrees
figsize : `tuple` containing two `float`
    Matplotlib style tuple indicating the size of the figure in inches
useIds : `bool`
    Label detectors by name, not id?
showFig : `bool`
    Display the figure on the screen?
savePath : `str` or `None`
    If not `None`, save a copy of the figure to this name.

Definition at line 88 of file utils.py.

89 useIds=False, showFig=True, savePath=None):
90 """Make a plot of the focal plane along with a set points that sample
91 the field of view.
92
93 Parameters
94 ----------
95 camera : `lsst.afw.cameraGeom.Camera`
96 A camera object
97 fieldSizeDeg_x : `float`
98 Amount of the field to sample in x in degrees
99 fieldSizeDeg_y : `float` or `None`
100 Amount of the field to sample in y in degrees
101 dx : `float`
102 Spacing of sample points in x in degrees
103 dy : `float`
104 Spacing of sample points in y in degrees
105 figsize : `tuple` containing two `float`
106 Matplotlib style tuple indicating the size of the figure in inches
107 useIds : `bool`
108 Label detectors by name, not id?
109 showFig : `bool`
110 Display the figure on the screen?
111 savePath : `str` or `None`
112 If not `None`, save a copy of the figure to this name.
113 """
114 try:
115 from matplotlib.patches import Polygon
116 from matplotlib.collections import PatchCollection
117 import matplotlib.pyplot as plt
118 except ImportError:
119 raise ImportError(
120 "Can't run plotFocalPlane: matplotlib has not been set up")
121
122 if fieldSizeDeg_x:
123 if fieldSizeDeg_y is None:
124 fieldSizeDeg_y = fieldSizeDeg_x
125
126 field_gridx, field_gridy = numpy.meshgrid(
127 numpy.arange(0., fieldSizeDeg_x + dx, dx) - fieldSizeDeg_x/2.,
128 numpy.arange(0., fieldSizeDeg_y + dy, dy) - fieldSizeDeg_y/2.)
129 field_gridx, field_gridy = field_gridx.flatten(), field_gridy.flatten()
130 else:
131 field_gridx, field_gridy = [], []
132
133 xs = []
134 ys = []
135 pcolors = []
136
137 # compute focal plane positions corresponding to field angles field_gridx, field_gridy
138 posFieldAngleList = [lsst.geom.Point2D(x*lsst.geom.radians, y*lsst.geom.radians)
139 for x, y in zip(field_gridx, field_gridy)]
140 posFocalPlaneList = camera.transform(posFieldAngleList, FIELD_ANGLE, FOCAL_PLANE)
141 for posFocalPlane in posFocalPlaneList:
142 xs.append(posFocalPlane.getX())
143 ys.append(posFocalPlane.getY())
144 dets = camera.findDetectors(posFocalPlane, FOCAL_PLANE)
145 if len(dets) > 0:
146 pcolors.append('w')
147 else:
148 pcolors.append('k')
149
150 colorMap = {DetectorType.SCIENCE: 'b', DetectorType.FOCUS: 'y',
151 DetectorType.GUIDER: 'g', DetectorType.WAVEFRONT: 'r'}
152
153 patches = []
154 colors = []
155 plt.figure(figsize=figsize)
156 ax = plt.gca()
157 xvals = []
158 yvals = []
159 for det in camera:
160 corners = [(c.getX(), c.getY()) for c in det.getCorners(FOCAL_PLANE)]
161 for corner in corners:
162 xvals.append(corner[0])
163 yvals.append(corner[1])
164 colors.append(colorMap[det.getType()])
165 patches.append(Polygon(corners, True))
166 center = det.getOrientation().getFpPosition()
167 ax.text(center.getX(), center.getY(), det.getId() if useIds else det.getName(),
168 horizontalalignment='center', size=6)
169
170 patchCollection = PatchCollection(patches, alpha=0.6, facecolor=colors)
171 ax.add_collection(patchCollection)
172 ax.scatter(xs, ys, s=10, alpha=.7, linewidths=0., c=pcolors)
173 ax.set_xlim(min(xvals) - abs(0.1*min(xvals)),
174 max(xvals) + abs(0.1*max(xvals)))
175 ax.set_ylim(min(yvals) - abs(0.1*min(yvals)),
176 max(yvals) + abs(0.1*max(yvals)))
177 ax.set_xlabel('Focal Plane X (mm)')
178 ax.set_ylabel('Focal Plane Y (mm)')
179 if savePath is not None:
180 plt.savefig(savePath)
181 if showFig:
182 plt.show()
183
184
int min
int max

◆ prepareWcsData()

lsst.afw.cameraGeom.utils.prepareWcsData ( wcs,
amp,
isTrimmed = True )
Put Wcs from an Amp image into CCD coordinates

Parameters
----------
wcs : `lsst.afw.geom.SkyWcs`
    The WCS object to start from.
amp : `lsst.afw.table.AmpInfoRecord`
    Amp object to use
isTrimmed : `bool`
    Is the image to which the WCS refers trimmed of non-imaging pixels?

Returns
-------
ampWcs : `lsst.afw.geom.SkyWcs`
    The modified WCS.

Definition at line 56 of file utils.py.

56def prepareWcsData(wcs, amp, isTrimmed=True):
57 """Put Wcs from an Amp image into CCD coordinates
58
59 Parameters
60 ----------
61 wcs : `lsst.afw.geom.SkyWcs`
62 The WCS object to start from.
63 amp : `lsst.afw.table.AmpInfoRecord`
64 Amp object to use
65 isTrimmed : `bool`
66 Is the image to which the WCS refers trimmed of non-imaging pixels?
67
68 Returns
69 -------
70 ampWcs : `lsst.afw.geom.SkyWcs`
71 The modified WCS.
72 """
73 if isTrimmed:
74 ampBox = amp.getRawDataBBox()
75 else:
76 ampBox = amp.getRawBBox()
77 ampCenter = lsst.geom.Point2D(ampBox.getDimensions()/2.0)
78 wcs = afwGeom.makeFlippedWcs(wcs, amp.getRawFlipX(), amp.getRawFlipY(), ampCenter)
79 # Shift WCS for trimming
80 if isTrimmed:
81 trim_shift = ampBox.getMin() - amp.getBBox().getMin()
82 wcs = wcs.copyAtShiftedPixelOrigin(lsst.geom.Extent2D(-trim_shift.getX(), -trim_shift.getY()))
83 # Account for shift of amp data in larger ccd matrix
84 offset = amp.getRawXYOffset()
85 return wcs.copyAtShiftedPixelOrigin(lsst.geom.Extent2D(offset))
86
87
std::shared_ptr< SkyWcs > makeFlippedWcs(SkyWcs const &wcs, bool flipLR, bool flipTB, lsst::geom::Point2D const &center)
Return a copy of a FITS-WCS with pixel positions flipped around a specified center.
Definition SkyWcs.cc:467

◆ rawCallback()

lsst.afw.cameraGeom.utils.rawCallback ( im,
ccd = None,
imageSource = None,
correctGain = False,
subtractBias = False,
convertToFloat = False,
obeyNQuarter = True )
A callback function that may or may not subtract bias/correct gain/trim
a raw image.

Parameters
----------
im : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` or `lsst.afw.image.Exposure`
   An image of a chip, ready to be binned and maybe rotated.
ccd : `lsst.afw.cameraGeom.Detector` or `None`
    The Detector; if `None` assume that im is an exposure and extract its Detector.
imageSource : `FakeImageDataSource` or `None`
    Source to get ccd images.  Must have a `getCcdImage()` method.
correctGain : `bool`
    Correct each amplifier for its gain?
subtractBias : `bool`
    Subtract the bias from each amplifier?
convertToFloat : `bool`
    Convert ``im`` to floating point if possible.
obeyNQuarter : `bool`
    Obey nQuarter from the Detector (default: True)

Returns
-------
image : `lsst.afw.image.Image` like
    The constructed image (type returned by ``im.Factory``).

Notes
-----
If imageSource is derived from ButlerImage, imageSource.butler is available.

Definition at line 512 of file utils.py.

513 correctGain=False, subtractBias=False, convertToFloat=False, obeyNQuarter=True):
514 """A callback function that may or may not subtract bias/correct gain/trim
515 a raw image.
516
517 Parameters
518 ----------
519 im : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` or `lsst.afw.image.Exposure`
520 An image of a chip, ready to be binned and maybe rotated.
521 ccd : `lsst.afw.cameraGeom.Detector` or `None`
522 The Detector; if `None` assume that im is an exposure and extract its Detector.
523 imageSource : `FakeImageDataSource` or `None`
524 Source to get ccd images. Must have a `getCcdImage()` method.
525 correctGain : `bool`
526 Correct each amplifier for its gain?
527 subtractBias : `bool`
528 Subtract the bias from each amplifier?
529 convertToFloat : `bool`
530 Convert ``im`` to floating point if possible.
531 obeyNQuarter : `bool`
532 Obey nQuarter from the Detector (default: True)
533
534 Returns
535 -------
536 image : `lsst.afw.image.Image` like
537 The constructed image (type returned by ``im.Factory``).
538
539 Notes
540 -----
541 If imageSource is derived from ButlerImage, imageSource.butler is available.
542 """
543 if ccd is None:
544 ccd = im.getDetector()
545 if hasattr(im, "getMaskedImage"):
546 im = im.getMaskedImage()
547 if convertToFloat and hasattr(im, "convertF"):
548 im = im.convertF()
549
550 isTrimmed = imageSource.isTrimmed
551 if isTrimmed:
552 bbox = ccd.getBBox()
553 else:
554 bbox = calcRawCcdBBox(ccd)
555
556 ampImages = []
557 for a in ccd:
558 if isTrimmed:
559 data = im[a.getRawDataBBox()]
560 else:
561 data = im
562
563 if subtractBias:
564 bias = im[a.getRawHorizontalOverscanBBox()]
565 data -= afwMath.makeStatistics(bias, afwMath.MEANCLIP).getValue()
566 if correctGain:
567 data *= a.getGain()
568
569 ampImages.append(data)
570
571 ccdImage = im.Factory(bbox)
572 for ampImage, amp in zip(ampImages, ccd):
573 if isTrimmed:
574 assembleAmplifierImage(ccdImage, ampImage, amp)
575 else:
576 assembleAmplifierRawImage(ccdImage, ampImage, amp)
577
578 if obeyNQuarter:
579 nQuarter = ccd.getOrientation().getNQuarter()
580 ccdImage = afwMath.rotateImageBy90(ccdImage, nQuarter)
581
582 return ccdImage
583
584
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition Statistics.h:361
std::shared_ptr< ImageT > rotateImageBy90(ImageT const &image, int nQuarter)
Rotate an image by an integral number of quarter turns.

◆ showAmp()

lsst.afw.cameraGeom.utils.showAmp ( amp,
imageSource = FakeImageDataSource(isTrimmed=False),
display = None,
overlay = True,
imageFactory = afwImage.ImageU )
Show an amp in an image display.

Parameters
----------
amp : `lsst.afw.tables.AmpInfoRecord`
    Amp record to use in display.
imageSource : `FakeImageDataSource` or `None`
    Source for getting the amp image.  Must have a ``getAmpImage()`` method.
display : `lsst.afw.display.Display`
    Image display to use.
overlay : `bool`
    Overlay bounding boxes?
imageFactory : callable like `lsst.afw.image.Image`
    Type of image to display (only used if ampImage is `None`).

Definition at line 685 of file utils.py.

686 imageFactory=afwImage.ImageU):
687 """Show an amp in an image display.
688
689 Parameters
690 ----------
691 amp : `lsst.afw.tables.AmpInfoRecord`
692 Amp record to use in display.
693 imageSource : `FakeImageDataSource` or `None`
694 Source for getting the amp image. Must have a ``getAmpImage()`` method.
695 display : `lsst.afw.display.Display`
696 Image display to use.
697 overlay : `bool`
698 Overlay bounding boxes?
699 imageFactory : callable like `lsst.afw.image.Image`
700 Type of image to display (only used if ampImage is `None`).
701 """
702 if not display:
703 display = _getDisplayFromDisplayOrFrame(display)
704
705 ampImage = imageSource.getAmpImage(amp, imageFactory=imageFactory)
706 ampImSize = ampImage.getDimensions()
707 title = amp.getName()
708 display.mtv(ampImage, title=title)
709 if overlay:
710 with display.Buffering():
711 if ampImSize == amp.getRawBBox().getDimensions():
712 bboxes = [(amp.getRawBBox(), 0.49, afwDisplay.GREEN), ]
713 xy0 = bboxes[0][0].getMin()
714 bboxes.append(
715 (amp.getRawHorizontalOverscanBBox(), 0.49, afwDisplay.RED))
716 bboxes.append((amp.getRawDataBBox(), 0.49, afwDisplay.BLUE))
717 bboxes.append((amp.getRawPrescanBBox(),
718 0.49, afwDisplay.YELLOW))
719 bboxes.append((amp.getRawVerticalOverscanBBox(),
720 0.49, afwDisplay.MAGENTA))
721 else:
722 bboxes = [(amp.getBBox(), 0.49, None), ]
723 xy0 = bboxes[0][0].getMin()
724
725 for bbox, borderWidth, ctype in bboxes:
726 if bbox.isEmpty():
727 continue
728 bbox = lsst.geom.Box2I(bbox)
729 bbox.shift(-lsst.geom.ExtentI(xy0))
730 displayUtils.drawBBox(
731 bbox, borderWidth=borderWidth, ctype=ctype, display=display)
732
733

◆ showCamera()

lsst.afw.cameraGeom.utils.showCamera ( camera,
imageSource = FakeImageDataSource(),
imageFactory = afwImage.ImageF,
detectorNameList = None,
binSize = 10,
bufferSize = 10,
overlay = True,
title = "",
showWcs = None,
ctype = afwDisplay.GREEN,
textSize = 1.25,
originAtCenter = True,
display = None,
** kwargs )
Show a Camera on display, with the specified display.

The rotation of the sensors is snapped to the nearest multiple of 90 deg.
Also note that the pixel size is constant over the image array. The lower
left corner (LLC) of each sensor amp is snapped to the LLC of the pixel
containing the LLC of the image.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera object to use to make the image.
imageSource : `FakeImageDataSource` or `None`
    Source to get ccd images.  Must have a ``getCcdImage()`` method.
imageFactory : `lsst.afw.image.Image`
    Type of image to make
detectorNameList : `list` [`str`] or `None`
    List of detector names from `camera` to use in building the image.
    Use all Detectors if `None`.
binSize : `int`
    Bin the image by this factor in both dimensions.
bufferSize : `int`
    Size of border in binned pixels to make around the camera image.
overlay : `bool`
    Overlay Detector IDs and boundaries?
title : `str`
    Title to use in display.
showWcs : `bool`
    Include a WCS in the display?
ctype : `lsst.afw.display.COLOR` or `str`
    Color to use when drawing Detector boundaries.
textSize : `float`
    Size of detector labels
originAtCenter : `bool`
    Put origin of the camera WCS at the center of the image?
    If `False`, the origin will be at the lower left.
display : `lsst.afw.display`
    Image display on which to display.
**kwargs :
    All remaining keyword arguments are passed to makeImageFromCamera

Returns
-------
image : `lsst.afw.image.Image`
    The mosaic image.

Definition at line 926 of file utils.py.

929 **kwargs):
930 """Show a Camera on display, with the specified display.
931
932 The rotation of the sensors is snapped to the nearest multiple of 90 deg.
933 Also note that the pixel size is constant over the image array. The lower
934 left corner (LLC) of each sensor amp is snapped to the LLC of the pixel
935 containing the LLC of the image.
936
937 Parameters
938 ----------
939 camera : `lsst.afw.cameraGeom.Camera`
940 Camera object to use to make the image.
941 imageSource : `FakeImageDataSource` or `None`
942 Source to get ccd images. Must have a ``getCcdImage()`` method.
943 imageFactory : `lsst.afw.image.Image`
944 Type of image to make
945 detectorNameList : `list` [`str`] or `None`
946 List of detector names from `camera` to use in building the image.
947 Use all Detectors if `None`.
948 binSize : `int`
949 Bin the image by this factor in both dimensions.
950 bufferSize : `int`
951 Size of border in binned pixels to make around the camera image.
952 overlay : `bool`
953 Overlay Detector IDs and boundaries?
954 title : `str`
955 Title to use in display.
956 showWcs : `bool`
957 Include a WCS in the display?
958 ctype : `lsst.afw.display.COLOR` or `str`
959 Color to use when drawing Detector boundaries.
960 textSize : `float`
961 Size of detector labels
962 originAtCenter : `bool`
963 Put origin of the camera WCS at the center of the image?
964 If `False`, the origin will be at the lower left.
965 display : `lsst.afw.display`
966 Image display on which to display.
967 **kwargs :
968 All remaining keyword arguments are passed to makeImageFromCamera
969
970 Returns
971 -------
972 image : `lsst.afw.image.Image`
973 The mosaic image.
974 """
975 display = _getDisplayFromDisplayOrFrame(display)
976
977 if binSize < 1:
978 binSize = 1
979 cameraImage = makeImageFromCamera(camera, detectorNameList=detectorNameList, bufferSize=bufferSize,
980 imageSource=imageSource, imageFactory=imageFactory, binSize=binSize,
981 **kwargs)
982
983 if detectorNameList is None:
984 ccdList = [camera[name] for name in camera.getNameIter()]
985 else:
986 ccdList = [camera[name] for name in detectorNameList]
987
988 if detectorNameList is None:
989 camBbox = camera.getFpBBox()
990 else:
991 camBbox = lsst.geom.Box2D()
992 for detName in detectorNameList:
993 for corner in camera[detName].getCorners(FOCAL_PLANE):
994 camBbox.include(corner)
995 pixelSize = ccdList[0].getPixelSize()
996
997 if showWcs:
998 if originAtCenter:
999 wcsReferencePixel = lsst.geom.Box2D(
1000 cameraImage.getBBox()).getCenter()
1001 else:
1002 wcsReferencePixel = lsst.geom.Point2I(0, 0)
1003 wcs = makeFocalPlaneWcs(pixelSize*binSize, wcsReferencePixel)
1004 else:
1005 wcs = None
1006
1007 if display:
1008 if title == "":
1009 title = camera.getName()
1010 display.mtv(cameraImage, title=title, wcs=wcs)
1011
1012 if overlay:
1013 with display.Buffering():
1014 camBbox = getCameraImageBBox(
1015 camBbox, pixelSize, bufferSize*binSize)
1016 bboxList = getCcdInCamBBoxList(
1017 ccdList, binSize, pixelSize, camBbox.getMin())
1018 for bbox, ccd in zip(bboxList, ccdList):
1019 nQuarter = ccd.getOrientation().getNQuarter()
1020 # borderWidth to 0.5 to align with the outside edge of the
1021 # pixel
1022 displayUtils.drawBBox(
1023 bbox, borderWidth=0.5, ctype=ctype, display=display)
1024 dims = bbox.getDimensions()
1025 ccdLabel = "{}\n[{}]".format(ccd.getName(), ccd.getId())
1026 display.dot(ccdLabel, bbox.getMinX() + dims.getX()/2, bbox.getMinY() + dims.getY()/2,
1027 ctype=ctype, size=textSize, textAngle=nQuarter*90)
1028
1029 return cameraImage
1030
1031

◆ showCcd()

lsst.afw.cameraGeom.utils.showCcd ( ccd,
imageSource = FakeImageDataSource(),
display = None,
overlay = True,
imageFactory = afwImage.ImageF,
binSize = 1,
inCameraCoords = False )
Show a CCD on display.

Parameters
----------
ccd : `lsst.afw.cameraGeom.Detector`
    Detector to use in display.
imageSource : `FakeImageDataSource` or `None`
    Source to get ccd images.  Must have a ``getCcdImage()`` method.
display : `lsst.afw.display.Display`
    image display to use.
overlay : `bool`
    Show amp bounding boxes on the displayed image?
imageFactory : callable like `lsst.afw.image.Image`
    The image factory to use in generating the images.
binSize : `int`
    Bin the image by this factor in both dimensions.
inCameraCoords : `bool`
    Show the Detector in camera coordinates?

Definition at line 734 of file utils.py.

735 imageFactory=afwImage.ImageF, binSize=1, inCameraCoords=False):
736 """Show a CCD on display.
737
738 Parameters
739 ----------
740 ccd : `lsst.afw.cameraGeom.Detector`
741 Detector to use in display.
742 imageSource : `FakeImageDataSource` or `None`
743 Source to get ccd images. Must have a ``getCcdImage()`` method.
744 display : `lsst.afw.display.Display`
745 image display to use.
746 overlay : `bool`
747 Show amp bounding boxes on the displayed image?
748 imageFactory : callable like `lsst.afw.image.Image`
749 The image factory to use in generating the images.
750 binSize : `int`
751 Bin the image by this factor in both dimensions.
752 inCameraCoords : `bool`
753 Show the Detector in camera coordinates?
754 """
755 display = _getDisplayFromDisplayOrFrame(display)
756
757 ccdOrigin = lsst.geom.Point2I(0, 0)
758 nQuarter = 0
759 ccdImage, ccd = imageSource.getCcdImage(
760 ccd, imageFactory=imageFactory, binSize=binSize)
761
762 ccdBbox = ccdImage.getBBox()
763 if ccdBbox.getDimensions() == ccd.getBBox().getDimensions():
764 isTrimmed = True
765 else:
766 isTrimmed = False
767
768 if inCameraCoords:
769 nQuarter = ccd.getOrientation().getNQuarter()
770 ccdImage = afwMath.rotateImageBy90(ccdImage, nQuarter)
771 title = "{} [{}]".format(ccd.getName(), ccd.getId())
772 if isTrimmed:
773 title += "(trimmed)"
774
775 if display:
776 display.mtv(ccdImage, title=title)
777
778 if overlay:
779 overlayCcdBoxes(ccd, ccdBbox, nQuarter, isTrimmed,
780 ccdOrigin, display, binSize)
781
782 return ccdImage
783
784

Variable Documentation

◆ _LOG

lsst.afw.cameraGeom.utils._LOG = logging.getLogger(__name__)
protected

Definition at line 53 of file utils.py.