LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Amplifier.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
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#ifndef LSST_AFW_CAMERAGEOM_AMPLIFIER_H_INCLUDED
23#define LSST_AFW_CAMERAGEOM_AMPLIFIER_H_INCLUDED
24
25#include <string>
26
27#include "lsst/afw/table/fwd.h"
28#include "lsst/geom/Box.h"
29#include "lsst/geom/Extent.h"
30
31namespace lsst {
32namespace afw {
33namespace cameraGeom {
34
38enum class ReadoutCorner {
39 LL,
40 LR,
41 UR,
42 UL,
43};
44
48enum class AssemblyState {
49 RAW,
50 SCIENCE,
51};
52
86class Amplifier {
87public:
88
89 class Builder;
90
93
94 virtual ~Amplifier() noexcept = default;
95
102 void toRecord(table::BaseRecord & record) const;
103
109 Builder rebuild() const;
110
112 std::string getName() const { return getFields().name; }
113
116
118 double getGain() const { return getFields().gain; }
119
121 double getReadNoise() const { return getFields().readNoise; }
122
127 double getSaturation() const { return getFields().saturation; }
128
136 double getSuspectLevel() const { return getFields().suspectLevel; }
137
140
142 ndarray::Array<double const, 1, 1> getLinearityCoeffs() const { return getFields().linearityCoeffs; }
143
146
151
156 double getLinearityMaximum() const { return getFields().linearityMaximum; }
157
160
169
178
184 bool getRawFlipX() const { return getFields().rawFlipX; }
185
191 bool getRawFlipY() const { return getFields().rawFlipY; }
192
199
208
217
226
237
248
258
261
262protected:
263
286
287 // Amplifier construction and assignment is protected to avoid type-slicing
288 // but permit derived classes to implement safe versions of these.
289
290 Amplifier() = default;
291
292 Amplifier(Amplifier const &) = default;
293 Amplifier(Amplifier &&) = default;
294 Amplifier & operator=(Amplifier const &) = default;
296
297 virtual Fields const & getFields() const = 0;
298
299};
300
305class Amplifier::Builder final : public Amplifier {
306public:
307
314 static Builder fromRecord(table::BaseRecord const & record);
315
317 Builder() = default;
318
320 Builder(Builder const &) = default;
321
323 Builder(Builder &&) = default;
324
326 Builder(Amplifier const & other);
327
329 Builder & operator=(Builder const &) = default;
330
332 Builder & operator=(Builder &&) = default;
333
335 Builder & operator=(Amplifier const & other);
336
337 ~Builder() noexcept override = default;
338
345 std::shared_ptr<Amplifier const> finish() const;
346
348 void setName(std::string const &name) { _fields.name = name; }
349
351 void setBBox(lsst::geom::Box2I const &bbox) { _fields.bbox = bbox; }
352
354 void setGain(double gain) { _fields.gain = gain; }
355
357 void setReadNoise(double readNoise) { _fields.readNoise = readNoise; }
358
360 void setSaturation(double saturation) { _fields.saturation = saturation; }
361
364
367
369 void setLinearityCoeffs(ndarray::Array<double const, 1, 1> const & coeffs) {
370 _fields.linearityCoeffs = coeffs;
371 }
372
374 void setLinearityType(std::string const & type) { _fields.linearityType = type; }
375
377 void setLinearityThreshold(double threshold) { _fields.linearityThreshold = threshold; }
378
380 void setLinearityMaximum(double maximum) { _fields.linearityMaximum = maximum; }
381
383 void setLinearityUnits(std::string const & units) { _fields.linearityUnits = units; }
384
386 void setRawBBox(lsst::geom::Box2I const &bbox) { _fields.rawBBox = bbox; }
387
390
392 void setRawFlipX(bool rawFlipX) { _fields.rawFlipX = rawFlipX; }
393
395 void setRawFlipY(bool rawFlipY) { _fields.rawFlipY = rawFlipY; }
396
398 void setRawXYOffset(lsst::geom::Extent2I const &xy) { _fields.rawXYOffset = xy; }
399
404
409
412 _fields.rawPrescanBBox = bbox;
413 }
414
419
424
429
434
435protected:
436 Fields const & getFields() const override { return _fields; }
437private:
438 Fields _fields;
439};
440
441
442
443} // namespace cameraGeom
444} // namespace afw
445} // namespace lsst
446
447#endif // !LSST_AFW_CAMERAGEOM_AMPLIFIER_H_INCLUDED
table::Key< std::string > name
Definition Amplifier.cc:116
AmpInfoBoxKey bbox
Definition Amplifier.cc:117
table::Key< double > gain
Definition Amplifier.cc:118
table::Key< double > saturation
Definition Amplifier.cc:119
table::Key< double > readNoise
Definition Amplifier.cc:121
table::Key< table::Flag > rawFlipX
Definition Amplifier.cc:128
table::Key< int > readoutCorner
Definition Amplifier.cc:122
table::Key< table::Flag > rawFlipY
Definition Amplifier.cc:129
table::Key< double > suspectLevel
Definition Amplifier.cc:120
table::Key< int > type
Definition Detector.cc:163
A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers.
Definition Amplifier.h:305
void setSaturation(double saturation)
Level in ADU above which pixels are considered saturated; use nan if no such level applies.
Definition Amplifier.h:360
void setRawParallelOverscanBBox(lsst::geom::Box2I const &bbox)
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the image to...
Definition Amplifier.h:421
void setBBox(lsst::geom::Box2I const &bbox)
Bounding box of amplifier pixels in the trimmed, assembled image.
Definition Amplifier.h:351
Builder & operator=(Builder const &)=default
Standard copy assignment.
void setRawFlipY(bool rawFlipY)
Is this amplifier (and the image to which it is attached) flipped in the Y direction,...
Definition Amplifier.h:395
Builder()=default
Construct a Builder with default values for all fields.
void setReadNoise(double readNoise)
Amplifier read noise, in e-.
Definition Amplifier.h:357
void setLinearityThreshold(double threshold)
Level in ADU above which linearity should be applied.
Definition Amplifier.h:377
void setLinearityCoeffs(ndarray::Array< double const, 1, 1 > const &coeffs)
Vector of linearity coefficients.
Definition Amplifier.h:369
Builder(Builder &&)=default
Standard move constructor.
Builder(Builder const &)=default
Standard copy constructor.
void setRawSerialOverscanBBox(lsst::geom::Box2I const &bbox)
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the image to...
Definition Amplifier.h:416
~Builder() noexcept override=default
void setRawHorizontalPrescanBBox(lsst::geom::Box2I const &bbox)
The bounding box of horizontal/serial prescan pixels in the image to which it is attached,...
Definition Amplifier.h:431
static Builder fromRecord(table::BaseRecord const &record)
Construct a new Builder object from the fields in the given record.
Definition Amplifier.cc:286
void setRawHorizontalOverscanBBox(lsst::geom::Box2I const &bbox)
The bounding box of horizontal overscan pixels in the image to which it is attached,...
Definition Amplifier.h:401
void setRawFlipX(bool rawFlipX)
Is this amplifier (and the image to which it is attached) flipped in the X direction,...
Definition Amplifier.h:392
Fields const & getFields() const override
Definition Amplifier.h:436
void setGain(double gain)
Amplifier gain in e-/ADU.
Definition Amplifier.h:354
void setReadoutCorner(ReadoutCorner readoutCorner)
Readout corner in the trimmed, assembled image.
Definition Amplifier.h:366
void setRawDataBBox(lsst::geom::Box2I const &bbox)
Bounding box of amplifier data pixels in the image to which it is attached, which is assumed to be un...
Definition Amplifier.h:389
Builder & operator=(Builder &&)=default
Standard move assignment.
std::shared_ptr< Amplifier const > finish() const
Construct an immutable Amplifier with the same values as the Builder.
Definition Amplifier.cc:282
void setLinearityMaximum(double maximum)
Level in ADU above which the linearity relation is poorly defined.
Definition Amplifier.h:380
void setSuspectLevel(double suspectLevel)
Level in ADU above which pixels are considered suspicious, meaning they may be affected by unknown sy...
Definition Amplifier.h:363
void setLinearityType(std::string const &type)
Name of linearity parameterization.
Definition Amplifier.h:374
void setRawVerticalOverscanBBox(lsst::geom::Box2I const &bbox)
The bounding box of vertical overscan pixels in the image to which it is attached,...
Definition Amplifier.h:406
void setRawXYOffset(lsst::geom::Extent2I const &xy)
Offset in transformation from this amplifier (and the image to which it is attached) to trimmed,...
Definition Amplifier.h:398
void setRawPrescanBBox(lsst::geom::Box2I const &bbox)
The bounding box of (horizontal) prescan pixels in the image to which it is attached,...
Definition Amplifier.h:411
void setRawSerialPrescanBBox(lsst::geom::Box2I const &bbox)
The bounding box of horizontal/serial prescan pixels in the image to which it is attached,...
Definition Amplifier.h:426
void setName(std::string const &name)
Name of the amplifier.
Definition Amplifier.h:348
void setLinearityUnits(std::string const &units)
Units for the input to the linearity relation (DN).
Definition Amplifier.h:383
void setRawBBox(lsst::geom::Box2I const &bbox)
Bounding box of the untrimmed amplifier in the image to which it is attached, which is assumed to be ...
Definition Amplifier.h:386
Geometry and electronic information about raw amplifier images.
Definition Amplifier.h:86
Amplifier(Amplifier &&)=default
Builder rebuild() const
Return a Builder object initialized with the fields of this.
Definition Amplifier.cc:271
lsst::geom::Box2I getRawVerticalOverscanBBox() const
The bounding box of vertical overscan pixels in the image to which it is attached,...
Definition Amplifier.h:216
lsst::geom::Box2I getRawSerialPrescanBBox() const
The bounding box of horizontal/serial prescan pixels in the image to which it is attached,...
Definition Amplifier.h:257
lsst::geom::Box2I getRawDataBBox() const
Bounding box of amplifier data pixels in the image to which it is attached, which is assumed to be un...
Definition Amplifier.h:177
lsst::geom::Box2I getRawHorizontalOverscanBBox() const
The bounding box of horizontal overscan pixels in the image to which it is attached,...
Definition Amplifier.h:207
Amplifier & operator=(Amplifier &&)=default
ndarray::Array< double const, 1, 1 > getLinearityCoeffs() const
Vector of linearity coefficients.
Definition Amplifier.h:142
bool getRawFlipX() const
Is this amplifier (and the image to which it is attached) flipped in the X direction,...
Definition Amplifier.h:184
ReadoutCorner getReadoutCorner() const
Readout corner in the trimmed, assembled image.
Definition Amplifier.h:139
lsst::geom::Box2I getRawSerialOverscanBBox() const
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the image to...
Definition Amplifier.h:236
virtual Fields const & getFields() const =0
void toRecord(table::BaseRecord &record) const
Copy the Amplifier's fields into the given record.
Definition Amplifier.cc:322
lsst::geom::Box2I getRawBBox() const
Bounding box of the untrimmed amplifier in the image to which it is attached, which is assumed to be ...
Definition Amplifier.h:168
Amplifier(Amplifier const &)=default
lsst::geom::Box2I getRawHorizontalPrescanBBox() const
The bounding box of horizontal/serial prescan pixels in the image to which it is attached,...
Definition Amplifier.h:260
lsst::geom::Box2I getRawParallelOverscanBBox() const
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the image to...
Definition Amplifier.h:247
lsst::geom::Extent2I getRawXYOffset() const
Offset in transformation from this amplifier (and the image to which it is attached) to trimmed,...
Definition Amplifier.h:198
std::string getName() const
Name of the amplifier.
Definition Amplifier.h:112
double getLinearityMaximum() const
Level in ADU above which the linearity relation is poorly defined.
Definition Amplifier.h:156
static table::Schema getRecordSchema()
Return the schema used in the afw.table representation of amplifiers.
Definition Amplifier.cc:267
double getSaturation() const
Level in ADU above which pixels are considered saturated; use nan if no such level applies.
Definition Amplifier.h:127
std::string getLinearityUnits() const
Units for the input to the linearity relation (DN).
Definition Amplifier.h:159
virtual ~Amplifier() noexcept=default
double getSuspectLevel() const
Level in ADU above which pixels are considered suspicious, meaning they may be affected by unknown sy...
Definition Amplifier.h:136
bool getRawFlipY() const
Is this amplifier (and the image to which it is attached) flipped in the Y direction,...
Definition Amplifier.h:191
Amplifier & operator=(Amplifier const &)=default
std::string getLinearityType() const
Name of linearity parameterization.
Definition Amplifier.h:145
lsst::geom::Box2I getRawPrescanBBox() const
The bounding box of (horizontal) prescan pixels in the image to which it is attached,...
Definition Amplifier.h:225
double getReadNoise() const
Amplifier read noise, in e-.
Definition Amplifier.h:121
double getGain() const
Amplifier gain in e-/ADU.
Definition Amplifier.h:118
double getLinearityThreshold() const
Level in ADU above which linearity should be applied.
Definition Amplifier.h:150
lsst::geom::Box2I getBBox() const
Bounding box of amplifier pixels in the trimmed, assembled image.
Definition Amplifier.h:115
Base class for all records.
Definition BaseRecord.h:31
Defines the fields and offsets for a table.
Definition Schema.h:51
An integer coordinate rectangle.
Definition Box.h:55
ReadoutCorner
Readout corner, in the frame of reference of the assembled image.
Definition Amplifier.h:38
AssemblyState
Assembly state of the amplifier, used to identify bounding boxes and component existence.
Definition Amplifier.h:48
STL namespace.
ndarray::Array< double const, 1, 1 > linearityCoeffs
Definition Amplifier.h:272