lsst.afw.cameraGeom.cameraConfig.DetectorConfig Class Reference

Inheritance diagram for lsst.afw.cameraGeom.cameraConfig.DetectorConfig:

Public Member Functions
	getCrosstalk (self, numAmps)
	bbox (self)
	offset (self)
	refPos (self)
	orientation (self)
	pixelSize (self)

Public Attributes
	offset
	refPos

Static Public Attributes
	transformDict
	name = pexConfig.Field("Name of detector slot", str)
	id = pexConfig.Field("ID of detector slot", int)
	bbox_x0 = pexConfig.Field("x0 of pixel bounding box", int)
	bbox_y0 = pexConfig.Field("y0 of pixel bounding box", int)
	bbox_x1 = pexConfig.Field("x1 of pixel bounding box", int)
	bbox_y1 = pexConfig.Field("y1 of pixel bounding box", int)
	detectorType
	physicalType
	serial
	offset_x
	offset_y
	offset_z
	refpos_x
	refpos_y
	yawDeg
	pitchDeg
	rollDeg
	pixelSize_x = pexConfig.Field("Pixel size in the x dimension in mm", float)
	pixelSize_y = pexConfig.Field("Pixel size in the y dimension in mm", float)
	transposeDetector
	crosstalk

Detailed Description

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

Definition at line 31 of file cameraConfig.py.

Member Function Documentation

bbox()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.bbox

(

self

)

Return the detector bounding box from the separate box endpoint
values.

Definition at line 96 of file cameraConfig.py.

    def bbox(self):
        """Return the detector bounding box from the separate box endpoint
        values.
        """
        return geom.BoxI(geom.PointI(self.bbox_x0, self.bbox_y0),
                         geom.PointI(self.bbox_x1, self.bbox_y1))
 

getCrosstalk()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.getCrosstalk	(		self,
			numAmps )

Return a 2-D numpy array of crosstalk coefficients of the proper shape

Definition at line 83 of file cameraConfig.py.

    def getCrosstalk(self, numAmps):
        """Return a 2-D numpy array of crosstalk coefficients of the proper shape"""
        if not self.crosstalk:
            return None
 
        if numAmps != int(np.sqrt(len(self.crosstalk))):
            numAmps = int(np.sqrt(len(self.crosstalk)))
        try:
            return np.array(self.crosstalk, dtype=np.float32).reshape((numAmps, numAmps))
        except Exception as e:
            raise RuntimeError(f"Cannot reshape 'crosstalk' coefficients to square matrix: {e}")
 

offset()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.offset

(

self

)

Return the detector offset as a Point3D from the separate config
values.

Definition at line 104 of file cameraConfig.py.

    def offset(self):
        """Return the detector offset as a Point3D from the separate config
        values.
        """
        return geom.Point3D(self.offset_x, self.offset_y, self.offset_z)
 

orientation()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.orientation

(

self

)

Return the cameraGeom.Orientation() object defined by the
configuration values.

Definition at line 118 of file cameraConfig.py.

    def orientation(self):
        """Return the cameraGeom.Orientation() object defined by the
        configuration values.
        """
        return Orientation(self.offset, self.refPos,
                           geom.Angle(self.yawDeg, geom.degrees),
                           geom.Angle(self.pitchDeg, geom.degrees),
                           geom.Angle(self.rollDeg, geom.degrees))
 

pixelSize()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.pixelSize

(

self

)

Return the pixel size as an Extent2D from the separate values.

Definition at line 128 of file cameraConfig.py.

    def pixelSize(self):
        """Return the pixel size as an Extent2D from the separate values.
        """
        return geom.Extent2D(self.pixelSize_x, self.pixelSize_y)
 
 

refPos()

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.refPos

(

self

)

Return the detector reference position as a Point2D from the
separate config values.

Definition at line 111 of file cameraConfig.py.

    def refPos(self):
        """Return the detector reference position as a Point2D from the
        separate config values.
        """
        return geom.Point2D(self.refpos_x, self.refpos_y)
 

Member Data Documentation

bbox_x0

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.bbox_x0 = pexConfig.Field("x0 of pixel bounding box", int)

static

Definition at line 39 of file cameraConfig.py.

bbox_x1

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.bbox_x1 = pexConfig.Field("x1 of pixel bounding box", int)

static

Definition at line 41 of file cameraConfig.py.

bbox_y0

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.bbox_y0 = pexConfig.Field("y0 of pixel bounding box", int)

static

Definition at line 40 of file cameraConfig.py.

bbox_y1

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.bbox_y1 = pexConfig.Field("y1 of pixel bounding box", int)

static

Definition at line 42 of file cameraConfig.py.

crosstalk

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.crosstalk

static

Initial value:

=  pexConfig.ListField(
        dtype=float,
        doc=("Flattened crosstalk coefficient matrix; should have nAmps x nAmps entries. "
             "Once 'reshape'-ed, ``coeffs[i][j]`` is the fraction of the j-th amp present on the i-th amp."),
        optional=True
    )

Definition at line 75 of file cameraConfig.py.

detectorType

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.detectorType

static

Initial value:

=  pexConfig.Field(
        "Detector type: SCIENCE=0, FOCUS=1, GUIDER=2, WAVEFRONT=3", int)

Definition at line 43 of file cameraConfig.py.

id

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.id = pexConfig.Field("ID of detector slot", int)

static

Definition at line 38 of file cameraConfig.py.

name

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.name = pexConfig.Field("Name of detector slot", str)

static

Definition at line 37 of file cameraConfig.py.

offset

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.offset

Definition at line 122 of file cameraConfig.py.

offset_x

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.offset_x

static

Initial value:

=  pexConfig.Field(
        "x offset from the origin of the camera in mm in the transposed system.", float)

Definition at line 49 of file cameraConfig.py.

offset_y

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.offset_y

static

Initial value:

=  pexConfig.Field(
        "y offset from the origin of the camera in mm in the transposed system.", float)

Definition at line 51 of file cameraConfig.py.

offset_z

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.offset_z

static

Initial value:

=  pexConfig.Field(
        "z offset from the origin of the camera in mm in the transposed system.", float, default=0.0)

Definition at line 53 of file cameraConfig.py.

physicalType

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.physicalType

static

Initial value:

=  pexConfig.Field(
        "How this specific detector is constructed; e.g. CCD, E2V, HgCdTe ", str, default="CCD")

Definition at line 45 of file cameraConfig.py.

pitchDeg

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.pitchDeg

static

Initial value:

=  pexConfig.Field(
        "pitch (rotation about y) of the detector in degrees", float)

Definition at line 63 of file cameraConfig.py.

pixelSize_x

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.pixelSize_x = pexConfig.Field("Pixel size in the x dimension in mm", float)

static

Definition at line 67 of file cameraConfig.py.

pixelSize_y

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.pixelSize_y = pexConfig.Field("Pixel size in the y dimension in mm", float)

static

Definition at line 68 of file cameraConfig.py.

refPos

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.refPos

Definition at line 122 of file cameraConfig.py.

refpos_x

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.refpos_x

static

Initial value:

=  pexConfig.Field("x position of the reference point in the detector in pixels "
                               "in transposed coordinates.", float)

Definition at line 55 of file cameraConfig.py.

refpos_y

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.refpos_y

static

Initial value:

=  pexConfig.Field("y position of the reference point in the detector in pixels "
                               "in transposed coordinates.", float)

Definition at line 57 of file cameraConfig.py.

rollDeg

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.rollDeg

static

Initial value:

=  pexConfig.Field(
        "roll (rotation about x) of the detector in degrees", float)

Definition at line 65 of file cameraConfig.py.

serial

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.serial

static

Initial value:

=  pexConfig.Field(
        "Serial string associated with this specific detector", str)

Definition at line 47 of file cameraConfig.py.

transformDict

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.transformDict

static

Initial value:

=  pexConfig.ConfigField(
        "Dictionary of camera transforms keyed on the transform type.", TransformMapConfig)

Definition at line 35 of file cameraConfig.py.

transposeDetector

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.transposeDetector

static

Initial value:

=  pexConfig.Field(
        "Transpose the pixel grid before orienting in focal plane?", bool)

Definition at line 72 of file cameraConfig.py.

yawDeg

lsst.afw.cameraGeom.cameraConfig.DetectorConfig.yawDeg

static

Initial value:

=  pexConfig.Field("yaw (rotation about z) of the detector in degrees. "
                             "This includes any necessary rotation to go from "
                             "detector coordinates to camera coordinates "
                             "after optional transposition.", float)

Definition at line 59 of file cameraConfig.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/cameraGeom/cameraConfig.py