LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
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... | |
bool | getHasRawInfo () const |
Does this table have raw amplifier information? More... | |
lsst::geom::Box2I | getRawBBox () const |
Bounding box of all amplifier pixels on untrimmed, assembled raw image. More... | |
lsst::geom::Box2I | getRawDataBBox () const |
Bounding box of amplifier image pixels on untrimmed, assembled raw image. More... | |
bool | getRawFlipX () const |
Flip row order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image? More... | |
bool | getRawFlipY () const |
Flip column order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image? More... | |
lsst::geom::Extent2I | getRawXYOffset () const |
Offset in transformation from pre-raw, unassembled image to trimmed, assembled post-ISR image: final xy0 - pre-raw xy0. More... | |
lsst::geom::Box2I | getRawHorizontalOverscanBBox () const |
The bounding box of horizontal overscan pixels in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawVerticalOverscanBBox () const |
The bounding box of vertical overscan pixels in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawPrescanBBox () const |
The bounding box of (horizontal) prescan pixels in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawSerialOverscanBBox () const |
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawParallelOverscanBBox () const |
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawSerialPrescanBBox () const |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image. More... | |
lsst::geom::Box2I | getRawHorizontalPrescanBBox () const |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image. 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 |
Amplifier gain in e-/ADU.
Definition at line 118 of file Amplifier.h.
|
inline |
Does this table have raw amplifier information?
Definition at line 163 of file Amplifier.h.
|
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 |
Name of the amplifier.
Definition at line 112 of file Amplifier.h.
|
inline |
Bounding box of all amplifier pixels on untrimmed, assembled raw image.
Definition at line 169 of file Amplifier.h.
|
inline |
Bounding box of amplifier image pixels on untrimmed, assembled raw image.
Definition at line 175 of file Amplifier.h.
|
inline |
Flip row order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 181 of file Amplifier.h.
|
inline |
Flip column order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 187 of file Amplifier.h.
|
inline |
The bounding box of horizontal overscan pixels in the assembled, untrimmed raw image.
Definition at line 199 of file Amplifier.h.
|
inline |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image.
This duplicates the getRawPrescanBBox method for legacy reasons.
Definition at line 235 of file Amplifier.h.
|
inline |
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the assembled, untrimmed raw image.
This duplicates the getRawVerticalOverscanBBox method for legacy reasons.
Definition at line 225 of file Amplifier.h.
|
inline |
The bounding box of (horizontal) prescan pixels in the assembled, untrimmed raw image.
Definition at line 211 of file Amplifier.h.
|
inline |
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the assembled, untrimmed raw image.
This duplicates the getRawHorizontalOverscanBBox method for legacy reasons.
Definition at line 218 of file Amplifier.h.
|
inline |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image.
This duplicates the getRawPrescanBBox method for legacy reasons.
Definition at line 232 of file Amplifier.h.
|
inline |
The bounding box of vertical overscan pixels in the assembled, untrimmed raw image.
Definition at line 205 of file Amplifier.h.
|
inline |
Offset in transformation from pre-raw, unassembled image to trimmed, assembled post-ISR image: final xy0 - pre-raw xy0.
Definition at line 193 of file Amplifier.h.
|
inline |
Amplifier read noise, in e-.
Definition at line 121 of file Amplifier.h.
|
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.