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
|
A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers. More...
#include <Amplifier.h>
Public Member Functions | |
Builder ()=default | |
Construct a Builder with default values for all fields. | |
Builder (Builder const &)=default | |
Standard copy constructor. | |
Builder (Builder &&)=default | |
Standard move constructor. | |
Builder (Amplifier const &other) | |
Construct a Builder with values initialized from the given Amplifier. | |
Builder & | operator= (Builder const &)=default |
Standard copy assignment. | |
Builder & | operator= (Builder &&)=default |
Standard move assignment. | |
Builder & | operator= (Amplifier const &other) |
Set the Builder's fields to those of the given Amplifier. | |
~Builder () noexcept override=default | |
std::shared_ptr< Amplifier const > | finish () const |
Construct an immutable Amplifier with the same values as the Builder. | |
void | setName (std::string const &name) |
Name of the amplifier. | |
void | setBBox (lsst::geom::Box2I const &bbox) |
Bounding box of amplifier pixels in the trimmed, assembled image. | |
void | setGain (double gain) |
Amplifier gain in e-/ADU. | |
void | setReadNoise (double readNoise) |
Amplifier read noise, in e-. | |
void | setSaturation (double saturation) |
Level in ADU above which pixels are considered saturated; use nan if no such level applies. | |
void | setSuspectLevel (double suspectLevel) |
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. | |
void | setReadoutCorner (ReadoutCorner readoutCorner) |
Readout corner in the trimmed, assembled image. | |
void | setLinearityCoeffs (ndarray::Array< double const, 1, 1 > const &coeffs) |
Vector of linearity coefficients. | |
void | setLinearityType (std::string const &type) |
Name of linearity parameterization. | |
void | setLinearityThreshold (double threshold) |
Level in ADU above which linearity should be applied. | |
void | setLinearityMaximum (double maximum) |
Level in ADU above which the linearity relation is poorly defined. | |
void | setLinearityUnits (std::string const &units) |
Units for the input to the linearity relation (DN). | |
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 untrimmed. | |
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 untrimmed. | |
void | setRawFlipX (bool rawFlipX) |
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? | |
void | setRawFlipY (bool rawFlipY) |
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? | |
void | setRawXYOffset (lsst::geom::Extent2I const &xy) |
Offset in transformation from this amplifier (and the image to which it is attached) to trimmed, assembled post-ISR image: final xy0 - current xy0. | |
void | setRawHorizontalOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal overscan pixels in the image to which it is attached, which is assumed to be untrimmed. | |
void | setRawVerticalOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of vertical overscan pixels in the image to which it is attached, which is assumed to be untrimmed. | |
void | setRawPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of (horizontal) prescan pixels in the image to which it is attached, which is assumed to be untrimmed. | |
void | setRawSerialOverscanBBox (lsst::geom::Box2I const &bbox) |
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. | |
void | setRawParallelOverscanBBox (lsst::geom::Box2I const &bbox) |
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. | |
void | setRawSerialPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed. | |
void | setRawHorizontalPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal/serial prescan pixels in the image to which it is attached, which is assumed to be untrimmed. | |
void | toRecord (table::BaseRecord &record) const |
Copy the Amplifier's fields into the given record. | |
Builder | rebuild () const |
Return a Builder object initialized with the fields of this. | |
std::string | getName () const |
Name of the amplifier. | |
lsst::geom::Box2I | getBBox () const |
Bounding box of amplifier pixels in the trimmed, assembled image. | |
double | getGain () const |
Amplifier gain in e-/ADU. | |
double | getReadNoise () const |
Amplifier read noise, in e-. | |
double | getSaturation () const |
Level in ADU above which pixels are considered saturated; use nan if no such level applies. | |
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. | |
ReadoutCorner | getReadoutCorner () const |
Readout corner in the trimmed, assembled image. | |
ndarray::Array< double const, 1, 1 > | getLinearityCoeffs () const |
Vector of linearity coefficients. | |
std::string | getLinearityType () const |
Name of linearity parameterization. | |
double | getLinearityThreshold () const |
Level in ADU above which linearity should be applied. | |
double | getLinearityMaximum () const |
Level in ADU above which the linearity relation is poorly defined. | |
std::string | getLinearityUnits () const |
Units for the input to the linearity relation (DN). | |
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. | |
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. | |
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? | |
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? | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
Static Public Member Functions | |
static Builder | fromRecord (table::BaseRecord const &record) |
Construct a new Builder object from the fields in the given record. | |
static table::Schema | getRecordSchema () |
Return the schema used in the afw.table representation of amplifiers. | |
Protected Member Functions | |
Fields const & | getFields () const override |
A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers.
Definition at line 305 of file Amplifier.h.
Construct a Builder with default values for all fields.
|
default |
Standard copy constructor.
|
default |
Standard move constructor.
lsst::afw::cameraGeom::Amplifier::Builder::Builder | ( | Amplifier const & | other | ) |
Construct a Builder with values initialized from the given Amplifier.
Definition at line 273 of file Amplifier.cc.
|
overridedefaultnoexcept |
std::shared_ptr< Amplifier const > lsst::afw::cameraGeom::Amplifier::Builder::finish | ( | ) | const |
Construct an immutable Amplifier with the same values as the Builder.
The derived type of the return instance is unspecified, and should be considered an implementation detail.
Definition at line 282 of file Amplifier.cc.
|
static |
Construct a new Builder object from the fields in the given record.
[in] | record | Record to copy fields from. |
Definition at line 286 of file Amplifier.cc.
|
inlineinherited |
Bounding box of amplifier pixels in the trimmed, assembled image.
Definition at line 115 of file Amplifier.h.
|
inlineoverrideprotectedvirtual |
Implements lsst::afw::cameraGeom::Amplifier.
Definition at line 436 of file Amplifier.h.
|
inlineinherited |
|
inlineinherited |
Vector of linearity coefficients.
Definition at line 142 of file Amplifier.h.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
Name of linearity parameterization.
Definition at line 145 of file Amplifier.h.
|
inlineinherited |
Units for the input to the linearity relation (DN).
Definition at line 159 of file Amplifier.h.
|
inlineinherited |
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
|
inlineinherited |
Readout corner in the trimmed, assembled image.
Definition at line 139 of file Amplifier.h.
|
staticinherited |
Return the schema used in the afw.table representation of amplifiers.
Definition at line 267 of file Amplifier.cc.
|
inlineinherited |
Level in ADU above which pixels are considered saturated; use nan
if no such level applies.
Definition at line 127 of file Amplifier.h.
|
inlineinherited |
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::Builder::operator= | ( | Amplifier const & | other | ) |
Set the Builder's fields to those of the given Amplifier.
Definition at line 275 of file Amplifier.cc.
Standard move assignment.
Standard copy assignment.
|
inherited |
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.
|
inline |
Bounding box of amplifier pixels in the trimmed, assembled image.
Definition at line 351 of file Amplifier.h.
|
inline |
|
inline |
Vector of linearity coefficients.
Definition at line 369 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 380 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 377 of file Amplifier.h.
|
inline |
|
inline |
Units for the input to the linearity relation (DN).
Definition at line 383 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 386 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 389 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 392 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 395 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 401 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 431 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 421 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 411 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 416 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 426 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 406 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 398 of file Amplifier.h.
|
inline |
|
inline |
|
inline |
Level in ADU above which pixels are considered saturated; use nan
if no such level applies.
Definition at line 360 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 363 of file Amplifier.h.
|
inherited |
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.