lsst.afw  20.0.0-4-gde602ef96
Functions | Variables
lsst.afw.cameraGeom.cameraFactory Namespace Reference

Functions

def addDetectorBuilderFromConfig (cameraBuilder, detectorConfig, amplifiers, focalPlaneToField)
 
def makeTransformDict (transformConfigDict)
 
def makeCameraFromPath (cameraConfig, ampInfoPath, shortNameFunc, pupilFactoryClass=PupilFactory)
 
def makeCameraFromAmpLists (cameraConfig, ampListDict, pupilFactoryClass=PupilFactory)
 

Variables

list cameraSysList = [FIELD_ANGLE, FOCAL_PLANE, PIXELS, TAN_PIXELS, ACTUAL_PIXELS]
 
 cameraSysMap = dict((sys.getSysName(), sys) for sys in cameraSysList)
 

Function Documentation

◆ addDetectorBuilderFromConfig()

def lsst.afw.cameraGeom.cameraFactory.addDetectorBuilderFromConfig (   cameraBuilder,
  detectorConfig,
  amplifiers,
  focalPlaneToField 
)
Build a dictionary of Detector constructor keyword arguments.

The returned dictionary can be passed as keyword arguments to the Detector
constructor, providing all required arguments.  However, using these
arguments directly constructs a Detector with knowledge of only the
coordinate systems that are *directly* mapped to its own PIXELS coordinate
system.  To construct Detectors with a shared TransformMap for the full
Camera, use makeCameraFromCatalogs or makeCameraFromPath instead of
calling this function or makeDetector directly.

Parameters
----------
cameraBuilder : `lsst.afw.cameraGeonm.Camera.Builder`
    Camera builder object to which the new Detector Builder
    should be added.
detectorConfig : `lsst.pex.config.Config`
    Configuration for this detector.
amplifiers : `list` [`~lsst.afw.cameraGeom.Amplifier`]
    amplifier information for this detector
focalPlaneToField : `lsst.afw.geom.TransformPoint2ToPoint2`
    FOCAL_PLANE to FIELD_ANGLE Transform

Returns
-------
detectorBuilder : `lsst.afw.cameraGeom.Detector.InCameraBuilder`
    A builder object for a detector corresponding to the given config,
    associated with the given camera builder object.

Definition at line 37 of file cameraFactory.py.

◆ makeCameraFromAmpLists()

def lsst.afw.cameraGeom.cameraFactory.makeCameraFromAmpLists (   cameraConfig,
  ampListDict,
  pupilFactoryClass = PupilFactory 
)
Construct a Camera instance from a dictionary of detector name: list of
Amplifier.Builder

Parameters
----------
cameraConfig : `CameraConfig`
    Config describing camera and its detectors.
ampListDict : `dict` [`str`, `list` [`Amplifier.Builder`]]
    A dictionary of detector name: list of Amplifier.Builder
pupilFactoryClass : `type`, optional
    Class to attach to camera; `lsst.default afw.cameraGeom.PupilFactory`.

Returns
-------
camera : `lsst.afw.cameraGeom.Camera`
    New Camera instance.

Definition at line 156 of file cameraFactory.py.

◆ makeCameraFromPath()

def lsst.afw.cameraGeom.cameraFactory.makeCameraFromPath (   cameraConfig,
  ampInfoPath,
  shortNameFunc,
  pupilFactoryClass = PupilFactory 
)
Make a Camera instance from a directory of ampInfo files

The directory must contain one ampInfo fits file for each detector in cameraConfig.detectorList.
The name of each ampInfo file must be shortNameFunc(fullDetectorName) + ".fits".

Parameters
----------
cameraConfig : `CameraConfig`
    Config describing camera and its detectors.
ampInfoPath : `str`
    Path to ampInfo data files.
shortNameFunc : callable
    A function that converts a long detector name to a short one.
pupilFactoryClass : `type`, optional
    Class to attach to camera; default is `lsst.afw.cameraGeom.PupilFactory`.

Returns
-------
camera : `lsst.afw.cameraGeom.Camera`
    New Camera instance.

Definition at line 122 of file cameraFactory.py.

◆ makeTransformDict()

def lsst.afw.cameraGeom.cameraFactory.makeTransformDict (   transformConfigDict)
Make a dictionary of CameraSys: lsst.afw.geom.Transform from a config dict.

Parameters
----------
transformConfigDict : value obtained from a `lsst.pex.config.ConfigDictField`
    registry; keys are camera system names.

Returns
-------
transforms : `dict` [`CameraSys` or `CameraSysPrefix`, `lsst.afw.geom.Transform`]
    A dict of CameraSys or CameraSysPrefix: lsst.afw.geom.Transform

Definition at line 101 of file cameraFactory.py.

Variable Documentation

◆ cameraSysList

list lsst.afw.cameraGeom.cameraFactory.cameraSysList = [FIELD_ANGLE, FOCAL_PLANE, PIXELS, TAN_PIXELS, ACTUAL_PIXELS]

Definition at line 33 of file cameraFactory.py.

◆ cameraSysMap

lsst.afw.cameraGeom.cameraFactory.cameraSysMap = dict((sys.getSysName(), sys) for sys in cameraSysList)

Definition at line 34 of file cameraFactory.py.