LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
cameraConfig.py
Go to the documentation of this file.
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22__all__ = ["CameraConfig", "DetectorConfig"]
23
24import numpy as np
25import lsst.pex.config as pexConfig
26import lsst.geom as geom
27from ._cameraGeom import Orientation
28from ._transformConfig import TransformMapConfig
29
30
31class DetectorConfig(pexConfig.Config):
32 """A configuration that represents (and can be used to construct) a
33 Detector.
34 """
35 transformDict = pexConfig.ConfigField(
36 "Dictionary of camera transforms keyed on the transform type.", TransformMapConfig)
37 name = pexConfig.Field("Name of detector slot", str)
38 id = pexConfig.Field("ID of detector slot", int)
39 bbox_x0 = pexConfig.Field("x0 of pixel bounding box", int)
40 bbox_y0 = pexConfig.Field("y0 of pixel bounding box", int)
41 bbox_x1 = pexConfig.Field("x1 of pixel bounding box", int)
42 bbox_y1 = pexConfig.Field("y1 of pixel bounding box", int)
43 detectorType = pexConfig.Field(
44 "Detector type: SCIENCE=0, FOCUS=1, GUIDER=2, WAVEFRONT=3", int)
45 physicalType = pexConfig.Field(
46 "How this specific detector is constructed; e.g. CCD, E2V, HgCdTe ", str, default="CCD")
47 serial = pexConfig.Field(
48 "Serial string associated with this specific detector", str)
49 offset_x = pexConfig.Field(
50 "x offset from the origin of the camera in mm in the transposed system.", float)
51 offset_y = pexConfig.Field(
52 "y offset from the origin of the camera in mm in the transposed system.", float)
53 offset_z = pexConfig.Field(
54 "z offset from the origin of the camera in mm in the transposed system.", float, default=0.0)
55 refpos_x = pexConfig.Field("x position of the reference point in the detector in pixels "
56 "in transposed coordinates.", float)
57 refpos_y = pexConfig.Field("y position of the reference point in the detector in pixels "
58 "in transposed coordinates.", float)
59 yawDeg = pexConfig.Field("yaw (rotation about z) of the detector in degrees. "
60 "This includes any necessary rotation to go from "
61 "detector coordinates to camera coordinates "
62 "after optional transposition.", float)
63 pitchDeg = pexConfig.Field(
64 "pitch (rotation about y) of the detector in degrees", float)
65 rollDeg = pexConfig.Field(
66 "roll (rotation about x) of the detector in degrees", float)
67 pixelSize_x = pexConfig.Field("Pixel size in the x dimension in mm", float)
68 pixelSize_y = pexConfig.Field("Pixel size in the y dimension in mm", float)
69
70 # Depending on the choice of detector coordinates, the pixel grid may need
71 # to be transposed before rotation to put it in camera coordinates.
72 transposeDetector = pexConfig.Field(
73 "Transpose the pixel grid before orienting in focal plane?", bool)
74
75 crosstalk = pexConfig.ListField(
76 dtype=float,
77 doc=("Flattened crosstalk coefficient matrix; should have nAmps x nAmps entries. "
78 "Once 'reshape'-ed, ``coeffs[i][j]`` is the fraction of the j-th amp present on the i-th amp."),
79 optional=True
80 )
81
82 # Accessors to get "compiled" versions of parameters.
83 def getCrosstalk(self, numAmps):
84 """Return a 2-D numpy array of crosstalk coefficients of the proper shape"""
85 if not self.crosstalk:
86 return None
87
88 if numAmps != int(np.sqrt(len(self.crosstalk))):
89 numAmps = int(np.sqrt(len(self.crosstalk)))
90 try:
91 return np.array(self.crosstalk, dtype=np.float32).reshape((numAmps, numAmps))
92 except Exception as e:
93 raise RuntimeError(f"Cannot reshape 'crosstalk' coefficients to square matrix: {e}")
94
95 @property
96 def bbox(self):
97 """Return the detector bounding box from the separate box endpoint
98 values.
99 """
100 return geom.BoxI(geom.PointI(self.bbox_x0, self.bbox_y0),
101 geom.PointI(self.bbox_x1, self.bbox_y1))
102
103 @property
104 def offset(self):
105 """Return the detector offset as a Point3D from the separate config
106 values.
107 """
108 return geom.Point3D(self.offset_x, self.offset_y, self.offset_z)
109
110 @property
111 def refPos(self):
112 """Return the detector reference position as a Point2D from the
113 separate config values.
114 """
115 return geom.Point2D(self.refpos_x, self.refpos_y)
116
117 @property
118 def orientation(self):
119 """Return the cameraGeom.Orientation() object defined by the
120 configuration values.
121 """
122 return Orientation(self.offsetoffset, self.refPosrefPos,
123 geom.Angle(self.yawDeg, geom.degrees),
124 geom.Angle(self.pitchDeg, geom.degrees),
125 geom.Angle(self.rollDeg, geom.degrees))
126
127 @property
128 def pixelSize(self):
129 """Return the pixel size as an Extent2D from the separate values.
130 """
131 return geom.Extent2D(self.pixelSize_x, self.pixelSize_y)
132
133
134class CameraConfig(pexConfig.Config):
135 """A configuration that represents (and can be used to construct) a Camera.
136 """
137 detectorList = pexConfig.ConfigDictField(
138 "List of detector configs", keytype=int, itemtype=DetectorConfig)
139 transformDict = pexConfig.ConfigField(
140 "Dictionary of camera transforms keyed on the transform type.", TransformMapConfig)
141 name = pexConfig.Field("Name of this camera", str)
142
143 plateScale = pexConfig.Field(
144 "Plate scale of the camera in arcsec/mm", float)
145 # Note that the radial transform will also apply a scaling, so all coefficients should be
146 # scaled by the plate scale in appropriate units
147 radialCoeffs = pexConfig.ListField(
148 "Coefficients for radial distortion", float)
AmpInfoBoxKey bbox
Definition Amplifier.cc:117
table::Point2DKey pixelSize
Definition Detector.cc:166
A class representing an angle.
Definition Angle.h:128
An integer coordinate rectangle.
Definition Box.h:55