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.

 def 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.
     """
     detectorBuilder = cameraBuilder.add(detectorConfig.name, detectorConfig.id)
     detectorBuilder.fromConfig(detectorConfig)
  
     for ampBuilder in amplifiers:
         detectorBuilder.append(ampBuilder)
  
     transforms = makeTransformDict(detectorConfig.transformDict.transforms)
  
     # It seems the C++ code has always assumed that the "nativeSys" for
     # detectors is PIXELS, despite the configs here giving the illusion of
     # choice.  We'll use PIXELS if the config value is None, and assert that
     # the value is PIXELS otherwise.  Note that we can't actually get rid of
     # the nativeSys config option without breaking lots of on-disk camera
     # configs.
     detectorNativeSysPrefix = cameraSysMap.get(detectorConfig.transformDict.nativeSys, PIXELS)
     assert detectorNativeSysPrefix == PIXELS, "Detectors with nativeSys != PIXELS are not supported."
  
     for toSys, transform in transforms.items():
         detectorBuilder.setTransformFromPixelsTo(toSys, transform)
     tanPixSys = CameraSys(TAN_PIXELS, detectorConfig.name)
     transforms[tanPixSys] = makePixelToTanPixel(
         bbox=detectorBuilder.getBBox(),
         orientation=detectorBuilder.getOrientation(),
         focalPlaneToField=focalPlaneToField,
         pixelSizeMm=detectorBuilder.getPixelSize(),
     )
  
     for toSys, transform in transforms.items():
         detectorBuilder.setTransformFromPixelsTo(toSys, transform)
  
     detectorBuilder.setCrosstalk(detectorConfig.getCrosstalk(len(amplifiers)))
  
     return detectorBuilder
  
  

◆ 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.

                            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.
     """
     nativeSys = cameraSysMap[cameraConfig.transformDict.nativeSys]
  
     # nativeSys=FOCAL_PLANE seems is baked into the camera class definition,
     # despite CameraConfig providing the illusion that it's configurable. Note
     # that we can't actually get rid of the nativeSys config option without
     # breaking lots of on-disk camera configs.
     assert nativeSys == FOCAL_PLANE, "Cameras with nativeSys != FOCAL_PLANE are not supported."
  
     cameraBuilder = Camera.Builder(cameraConfig.name)
     cameraBuilder.setPupilFactoryClass(pupilFactoryClass)
  
     transformDict = makeTransformDict(cameraConfig.transformDict.transforms)
     focalPlaneToField = transformDict[FIELD_ANGLE]
  
     for toSys, transform in transformDict.items():
         cameraBuilder.setTransformFromFocalPlaneTo(toSys, transform)
  
     for detectorConfig in cameraConfig.detectorList.values():
         addDetectorBuilderFromConfig(
             cameraBuilder,
             detectorConfig=detectorConfig,
             amplifiers=ampListDict[detectorConfig.name],
             focalPlaneToField=focalPlaneToField,
         )
  
     return cameraBuilder.finish()

◆ 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.

                        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.
     """
     ampListDict = dict()
     for detectorConfig in cameraConfig.detectorList.values():
         shortName = shortNameFunc(detectorConfig.name)
         ampCatPath = os.path.join(ampInfoPath, shortName + ".fits")
         catalog = BaseCatalog.readFits(ampCatPath)
         ampListDict[detectorConfig.name] = [Amplifier.Builder.fromRecord(record)
                                             for record in catalog]
  
     return makeCameraFromAmpLists(cameraConfig, ampListDict, pupilFactoryClass)
  
  

◆ 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.

 def 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
     """
     resMap = dict()
     if transformConfigDict is not None:
         for key in transformConfigDict:
             transform = transformConfigDict[key].transform.apply()
             resMap[CameraSys(key)] = transform
     return resMap
  
  

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.

Functions

Variables