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

Inheritance diagram of lsst.afw.cameraGeom.Amplifier, lsst.afw.cameraGeom._amplifier.AmplifierGeometryComparison, lsst.afw.cameraGeom._assembleImage.AmplifierIsolator, lsst.afw.cameraGeom.AssemblyState, lsst.afw.cameraGeom.Camera, lsst.afw.cameraGeom.cameraConfig.CameraConfig, lsst.afw.cameraGeom.CameraSys, lsst.afw.cameraGeom.CameraSysPrefix, lsst.afw.cameraGeom.Detector, lsst.afw.cameraGeom.DetectorBase, lsst.afw.cameraGeom.DetectorCollection, lsst.afw.cameraGeom._detectorCollection.DetectorCollectionBase, lsst.afw.cameraGeom.DetectorCollectionBuilderBase, lsst.afw.cameraGeom.DetectorCollectionDetectorBase, lsst.afw.cameraGeom.cameraConfig.DetectorConfig, lsst.afw.cameraGeom.DetectorType, lsst.afw.cameraGeom.Orientation, lsst.afw.cameraGeom.pupil.Pupil, lsst.afw.cameraGeom.pupil.PupilFactory, lsst.afw.cameraGeom.ReadoutCorner, lsst.afw.cameraGeom.TransformMap, lsst.afw.cameraGeom._transformConfig.TransformMapConfig

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

Inheritance diagram of lsst.afw.cameraGeom.utils.FakeImageDataSource, lsst.afw.cameraGeom.utils.ButlerImage

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

Inheritance diagram of lsst.afw.cameraGeom.testUtils.DetectorWrapper, lsst.afw.cameraGeom.testUtils.CameraWrapper