lsst.afw.cameraGeom

The lsst.afw.cameraGeom module describes the geometry of an imaging camera.

Using lsst.afw.cameraGeom

Contributing

lsst.afw.cameraGeom is developed at https://github.com/lsst/afw. You can find Jira issues for this module under the afw component.

Python API reference

lsst.afw.cameraGeom Package

Functions

addDetectorBuilderFromConfig(cameraBuilder, ...)

Build a dictionary of Detector constructor keyword arguments.

assembleAmplifierImage(destImage, rawImage, ...)

Assemble the amplifier region of an image from a raw image.

assembleAmplifierRawImage(destImage, ...)

Assemble the amplifier region of a raw CCD image.

makeCameraFromAmpLists(cameraConfig, ampListDict)

Construct a Camera instance from a dictionary of detector name: list of Amplifier.Builder

makeCameraFromPath(cameraConfig, ...[, ...])

Make a Camera instance from a directory of ampInfo files

makePixelToTanPixel(bbox, orientation, ...)

Make a Transform whose forward direction converts PIXELS to TAN_PIXELS for one detector.

makeUpdatedDetector(ccd)

Return a Detector that has had the definitions of amplifier geometry updated post assembly.

rotateBBoxBy90(bbox, n90, dimensions)

Rotate a bounding box by an integer multiple of 90 degrees.

Classes

Amplifier

AmplifierGeometryComparison(value)

Flags used to report geometric differences between amplifier

AmplifierIsolator(amplifier, parent_bbox, ...)

A class that can extracts single-amplifier subimages from trimmed or untrimmed assembled images and transforms them to a particular orientation and offset.

AssemblyState

Members:

Camera

CameraConfig(*args, **kw)

A configuration that represents (and can be used to construct) a Camera.

CameraSys

CameraSysPrefix

Detector

DetectorBase

DetectorCollection

DetectorCollectionBase(*args, **kwds)

An immutable collection of Detectors that can be accessed by name or ID.

DetectorCollectionBuilderBase

DetectorCollectionDetectorBase

DetectorConfig(*args, **kw)

A configuration that represents (and can be used to construct) a Detector.

DetectorType

Members:

Orientation

Pupil(illuminated, size, scale)

Pupil obscuration function.

PupilFactory(visitInfo, pupilSize, npix)

Pupil obscuration function factory for use with Fourier optics.

ReadoutCorner

Members:

TransformMap

TransformMapConfig(*args, **kw)

Class Inheritance Diagram

digraph inheritance0f43546293 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Amplifier" [URL="../../../py-api/lsst.afw.cameraGeom.Amplifier.html#lsst.afw.cameraGeom.Amplifier",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "Amplifier" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AmplifierGeometryComparison" [URL="../../../py-api/lsst.afw.cameraGeom.AmplifierGeometryComparison.html#lsst.afw.cameraGeom.AmplifierGeometryComparison",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Flags used to report geometric differences between amplifier"]; "Flag" -> "AmplifierGeometryComparison" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AmplifierIsolator" [URL="../../../py-api/lsst.afw.cameraGeom.AmplifierIsolator.html#lsst.afw.cameraGeom.AmplifierIsolator",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class that can extracts single-amplifier subimages from trimmed or"]; "AssemblyState" [URL="../../../py-api/lsst.afw.cameraGeom.AssemblyState.html#lsst.afw.cameraGeom.AssemblyState",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Members:"]; "pybind11_object" -> "AssemblyState" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Camera" [URL="../../../py-api/lsst.afw.cameraGeom.Camera.html#lsst.afw.cameraGeom.Camera",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "DetectorCollection" -> "Camera" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CameraConfig" [URL="../../../py-api/lsst.afw.cameraGeom.CameraConfig.html#lsst.afw.cameraGeom.CameraConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A configuration that represents (and can be used to construct) a Camera."]; "Config" -> "CameraConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CameraSys" [URL="../../../py-api/lsst.afw.cameraGeom.CameraSys.html#lsst.afw.cameraGeom.CameraSys",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "CameraSys" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CameraSysPrefix" [URL="../../../py-api/lsst.afw.cameraGeom.CameraSysPrefix.html#lsst.afw.cameraGeom.CameraSysPrefix",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "CameraSysPrefix" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "Detector" [URL="../../../py-api/lsst.afw.cameraGeom.Detector.html#lsst.afw.cameraGeom.Detector",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "DetectorBase" -> "Detector" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Storable" -> "Detector" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorBase" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorBase.html#lsst.afw.cameraGeom.DetectorBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "DetectorBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorCollection" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorCollection.html#lsst.afw.cameraGeom.DetectorCollection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "DetectorCollectionDetectorBase" -> "DetectorCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorCollectionBase" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorCollectionBase.html#lsst.afw.cameraGeom.DetectorCollectionBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An immutable collection of Detectors that can be accessed by name or ID."]; "DetectorCollectionBuilderBase" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorCollectionBuilderBase.html#lsst.afw.cameraGeom.DetectorCollectionBuilderBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "DetectorCollectionBuilderBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorCollectionDetectorBase" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorCollectionDetectorBase.html#lsst.afw.cameraGeom.DetectorCollectionDetectorBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "DetectorCollectionDetectorBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorConfig" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorConfig.html#lsst.afw.cameraGeom.DetectorConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A configuration that represents (and can be used to construct) a"]; "Config" -> "DetectorConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DetectorType" [URL="../../../py-api/lsst.afw.cameraGeom.DetectorType.html#lsst.afw.cameraGeom.DetectorType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Members:"]; "pybind11_object" -> "DetectorType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Generic enumeration."]; "Flag" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Support for flags"]; "Enum" -> "Flag" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Orientation" [URL="../../../py-api/lsst.afw.cameraGeom.Orientation.html#lsst.afw.cameraGeom.Orientation",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "Orientation" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Persistable" [URL="../../../py-api/lsst.afw.table.io.Persistable.html#lsst.afw.table.io.Persistable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "Persistable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Pupil" [URL="../../../py-api/lsst.afw.cameraGeom.Pupil.html#lsst.afw.cameraGeom.Pupil",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Pupil obscuration function."]; "PupilFactory" [URL="../../../py-api/lsst.afw.cameraGeom.PupilFactory.html#lsst.afw.cameraGeom.PupilFactory",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Pupil obscuration function factory for use with Fourier optics."]; "ReadoutCorner" [URL="../../../py-api/lsst.afw.cameraGeom.ReadoutCorner.html#lsst.afw.cameraGeom.ReadoutCorner",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Members:"]; "pybind11_object" -> "ReadoutCorner" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Storable" [URL="../../../py-api/lsst.afw.typehandling.Storable.html#lsst.afw.typehandling.Storable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Persistable" -> "Storable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TransformMap" [URL="../../../py-api/lsst.afw.cameraGeom.TransformMap.html#lsst.afw.cameraGeom.TransformMap",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "pybind11_object" -> "TransformMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TransformMapConfig" [URL="../../../py-api/lsst.afw.cameraGeom.TransformMapConfig.html#lsst.afw.cameraGeom.TransformMapConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Config" -> "TransformMapConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "pybind11_object" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }

lsst.afw.cameraGeom.utils Module

Functions

prepareWcsData(wcs, amp[, isTrimmed])

Put Wcs from an Amp image into CCD coordinates

plotFocalPlane(camera[, fieldSizeDeg_x, ...])

Make a plot of the focal plane along with a set points that sample the field of view.

makeImageFromAmp(amp[, imValue, ...])

Make an image from an amp object.

calcRawCcdBBox(ccd)

Calculate the raw ccd bounding box.

makeImageFromCcd(ccd[, isTrimmed, ...])

Make an Image of a CCD.

rawCallback(im[, ccd, imageSource, ...])

A callback function that may or may not subtract bias/correct gain/trim a raw image.

overlayCcdBoxes(ccd[, untrimmedCcdBbox, ...])

Overlay bounding boxes on an image display.

showAmp(amp[, imageSource, display, ...])

Show an amp in an image display.

showCcd(ccd[, imageSource, display, ...])

Show a CCD on display.

getCcdInCamBBoxList(ccdList, binSize, ...)

Get the bounding boxes of a list of Detectors within a camera sized pixel grid

getCameraImageBBox(camBbox, pixelSize, ...)

Get the bounding box of a camera sized image in pixels

makeImageFromCamera(camera[, ...])

Make an Image of a Camera.

showCamera(camera[, imageSource, ...])

Show a Camera on display, with the specified display.

makeFocalPlaneWcs(pixelSize, referencePixel)

Make a WCS for the focal plane geometry (i.e.

findAmp(ccd, pixelPosition)

Find the Amp with the specified pixel position within the composite

Classes

FakeImageDataSource([isTrimmed, verbose, ...])

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

ButlerImage([butler, type, isTrimmed, ...])

A class to return an Image of a given Ccd using the butler.

Class Inheritance Diagram

digraph inheritance246083c4af { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ButlerImage" [URL="../../../py-api/lsst.afw.cameraGeom.utils.ButlerImage.html#lsst.afw.cameraGeom.utils.ButlerImage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to return an Image of a given Ccd using the butler."]; "FakeImageDataSource" -> "ButlerImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FakeImageDataSource" [URL="../../../py-api/lsst.afw.cameraGeom.utils.FakeImageDataSource.html#lsst.afw.cameraGeom.utils.FakeImageDataSource",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to retrieve synthetic images for display by the show* methods"]; }

lsst.afw.cameraGeom.testUtils Module

Classes

DetectorWrapper([name, id, detType, serial, ...])

A Detector and the data used to construct it

CameraWrapper([plateScale, ...])

A simple Camera and the data used to construct it

Class Inheritance Diagram

digraph inheritancecf1a891f40 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "CameraWrapper" [URL="../../../py-api/lsst.afw.cameraGeom.testUtils.CameraWrapper.html#lsst.afw.cameraGeom.testUtils.CameraWrapper",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple Camera and the data used to construct it"]; "DetectorWrapper" [URL="../../../py-api/lsst.afw.cameraGeom.testUtils.DetectorWrapper.html#lsst.afw.cameraGeom.testUtils.DetectorWrapper",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Detector and the data used to construct it"]; }