LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Geometry and electronic information about raw amplifier images. More...
#include <Amplifier.h>
Classes | |
class | Builder |
A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers. More... | |
struct | Fields |
Public Member Functions | |
virtual | ~Amplifier () noexcept=default |
void | toRecord (table::BaseRecord &record) const |
Copy the Amplifier's fields into the given record. More... | |
Builder | rebuild () const |
Return a Builder object initialized with the fields of this. More... | |
std::string | getName () const |
Name of the amplifier. More... | |
lsst::geom::Box2I | getBBox () const |
Bounding box of amplifier pixels in the trimmed, assembled image. More... | |
double | getGain () const |
Amplifier gain in e-/ADU. More... | |
double | getReadNoise () const |
Amplifier read noise, in e-. More... | |
double | getSaturation () const |
Level in ADU above which pixels are considered saturated; use nan if no such level applies. More... | |
double | getSuspectLevel () const |
Level in ADU above which pixels are considered suspicious, meaning they may be affected by unknown systematics; for example if non-linearity corrections above a certain level are unstable then that would be a useful value for suspectLevel. More... | |
ReadoutCorner | getReadoutCorner () const |
Readout corner in the trimmed, assembled image. More... | |
ndarray::Array< double const, 1, 1 > | getLinearityCoeffs () const |
Vector of linearity coefficients. More... | |
std::string | getLinearityType () const |
Name of linearity parameterization. More... | |
double | getLinearityThreshold () const |
Level in ADU above which linearity should be applied. More... | |
double | getLinearityMaximum () const |
Level in ADU above which the linearity relation is poorly defined. More... | |
std::string | getLinearityUnits () const |
Units for the input to the linearity relation (DN). More... | |
lsst::geom::Box2I | getRawBBox () const |
Bounding box of the untrimmed amplifier in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawDataBBox () const |
Bounding box of amplifier data pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
bool | getRawFlipX () const |
Is this amplifier (and the image to which it is attached) flipped in the X direction, relative to the physical orientation used for assembled (but still untrimmed) raws? More... | |
bool | getRawFlipY () const |
Is this amplifier (and the image to which it is attached) flipped in the Y direction, relative to the physical orientation used for assembled (but still untrimmed) raws? More... | |
lsst::geom::Extent2I | getRawXYOffset () const |
Offset in transformation from this amplifier (and the image to which it is attached) to trimmed, assembled post-ISR image: final xy0 - current xy0. More... | |
lsst::geom::Box2I | getRawHorizontalOverscanBBox () const |
The bounding box of horizontal overscan pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawVerticalOverscanBBox () const |
The bounding box of vertical overscan pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawPrescanBBox () const |
The bounding box of (horizontal) prescan pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawSerialOverscanBBox () const |
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawParallelOverscanBBox () const |
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawSerialPrescanBBox () const |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
lsst::geom::Box2I | getRawHorizontalPrescanBBox () const |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed. More... | |
Static Public Member Functions | |
static table::Schema | getRecordSchema () |
Return the schema used in the afw.table representation of amplifiers. More... | |
Protected Member Functions | |
Amplifier ()=default | |
Amplifier (Amplifier const &)=default | |
Amplifier (Amplifier &&)=default | |
Amplifier & | operator= (Amplifier const &)=default |
Amplifier & | operator= (Amplifier &&)=default |
virtual Fields const & | getFields () const =0 |
Geometry and electronic information about raw amplifier images.
The Amplifier class itself is an abstract base class that provides no mutation or copy interfaces. Typically Amplifiers are constructed via the Builder subclass, which can produce a shared_ptr to an immutable Amplifier instance.
Here is a pictorial example showing the meaning of flipX and flipY:
CCD with 4 amps Desired assembled output Use these parameters --x x-- y | amp1 amp2 | | flipX flipY y y | amp1 False True | CCD image amp2 True True y y | amp3 False False | amp3 amp4 | | amp4 True False --x x-- ----------- x
Definition at line 86 of file Amplifier.h.
|
virtualdefaultnoexcept |
|
protecteddefault |
|
protecteddefault |
|
protecteddefault |
|
inline |
Bounding box of amplifier pixels in the trimmed, assembled image.
Definition at line 115 of file Amplifier.h.
|
protectedpure virtual |
Implemented in lsst::afw::cameraGeom::Amplifier::Builder.
|
inline |
|
inline |
Vector of linearity coefficients.
Definition at line 142 of file Amplifier.h.
|
inline |
Level in ADU above which the linearity relation is poorly defined.
Should be set to the saturation level if no other value is known.
Definition at line 156 of file Amplifier.h.
|
inline |
Level in ADU above which linearity should be applied.
This should be set to 0.0 if no other value is known.
Definition at line 150 of file Amplifier.h.
|
inline |
Name of linearity parameterization.
Definition at line 145 of file Amplifier.h.
|
inline |
Units for the input to the linearity relation (DN).
Definition at line 159 of file Amplifier.h.
|
inline |
|
inline |
Bounding box of the untrimmed amplifier in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image.
Definition at line 168 of file Amplifier.h.
|
inline |
Bounding box of amplifier data pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image.
Definition at line 177 of file Amplifier.h.
|
inline |
Is this amplifier (and the image to which it is attached) flipped in the X direction, relative to the physical orientation used for assembled (but still untrimmed) raws?
Definition at line 184 of file Amplifier.h.
|
inline |
Is this amplifier (and the image to which it is attached) flipped in the Y direction, relative to the physical orientation used for assembled (but still untrimmed) raws?
Definition at line 191 of file Amplifier.h.
|
inline |
The bounding box of horizontal overscan pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image.
Definition at line 207 of file Amplifier.h.
|
inline |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image. This duplicates the getRawPrescanBBox method for legacy reasons.
Definition at line 260 of file Amplifier.h.
|
inline |
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image. This duplicates the getRawVerticalOverscanBBox method for legacy reasons.
Definition at line 247 of file Amplifier.h.
|
inline |
The bounding box of (horizontal) prescan pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image.
Definition at line 225 of file Amplifier.h.
|
inline |
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image. This duplicates the getRawHorizontalOverscanBBox method for legacy reasons.
Definition at line 236 of file Amplifier.h.
|
inline |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image. This duplicates the getRawPrescanBBox method for legacy reasons.
Definition at line 257 of file Amplifier.h.
|
inline |
The bounding box of vertical overscan pixels in the image to which it is attached, which is assumed to be untrimmed.
This attribute should never be accessed on an amplifier attached to a trimmed image.
Definition at line 216 of file Amplifier.h.
|
inline |
Offset in transformation from this amplifier (and the image to which it is attached) to trimmed, assembled post-ISR image: final xy0 - current xy0.
Definition at line 198 of file Amplifier.h.
|
inline |
|
inline |
Readout corner in the trimmed, assembled image.
Definition at line 139 of file Amplifier.h.
|
static |
Return the schema used in the afw.table representation of amplifiers.
Definition at line 267 of file Amplifier.cc.
|
inline |
Level in ADU above which pixels are considered saturated; use nan
if no such level applies.
Definition at line 127 of file Amplifier.h.
|
inline |
Level in ADU above which pixels are considered suspicious, meaning they may be affected by unknown systematics; for example if non-linearity corrections above a certain level are unstable then that would be a useful value for suspectLevel.
Use nan
if no such level applies.
Definition at line 136 of file Amplifier.h.
Amplifier::Builder lsst::afw::cameraGeom::Amplifier::rebuild | ( | ) | const |
Return a Builder object initialized with the fields of this.
This is simply a shortcut for Amplifier::Builder(*this)
.
Definition at line 271 of file Amplifier.cc.
void lsst::afw::cameraGeom::Amplifier::toRecord | ( | table::BaseRecord & | record | ) | const |
Copy the Amplifier's fields into the given record.
[out] | record | Record to modify. record.getSchema().contains(this->getRecordSchema()) must be true. |
Definition at line 322 of file Amplifier.cc.