lsst.afw
20.0.0-7-geef20c811+1caa149b74
|
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. More... | |
Builder (Builder const &)=default | |
Standard copy constructor. More... | |
Builder (Builder &&)=default | |
Standard move constructor. More... | |
Builder (Amplifier const &other) | |
Construct a Builder with values initialized from the given Amplifier. More... | |
Builder & | operator= (Builder const &)=default |
Standard copy assignment. More... | |
Builder & | operator= (Builder &&)=default |
Standard move assignment. More... | |
Builder & | operator= (Amplifier const &other) |
Set the Builder's fields to those of the given Amplifier. More... | |
~Builder () noexcept override=default | |
std::shared_ptr< Amplifier const > | finish () const |
Construct an immutable Amplifier with the same values as the Builder. More... | |
void | setName (std::string const &name) |
Name of the amplifier. More... | |
void | setBBox (lsst::geom::Box2I const &bbox) |
Bounding box of amplifier pixels in the trimmed, assembled image. More... | |
void | setGain (double gain) |
Amplifier gain in e-/ADU. More... | |
void | setReadNoise (double readNoise) |
Amplifier read noise, in e-. More... | |
void | setSaturation (double saturation) |
Level in ADU above which pixels are considered saturated; use nan if no such level applies. More... | |
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. More... | |
void | setReadoutCorner (ReadoutCorner readoutCorner) |
Readout corner in the trimmed, assembled image. More... | |
void | setLinearityCoeffs (ndarray::Array< double const, 1, 1 > const &coeffs) |
Vector of linearity coefficients. More... | |
void | setLinearityType (std::string const &type) |
Name of linearity parameterization. More... | |
void | setLinearityThreshold (double threshold) |
Level in ADU above which linearity should be applied. More... | |
void | setLinearityMaximum (double maximum) |
Level in ADU above which the linearity relation is poorly defined. More... | |
void | setLinearityUnits (std::string const &units) |
Units for the input to the linearity relation (DN). More... | |
void | setRawBBox (lsst::geom::Box2I const &bbox) |
Bounding box of all amplifier pixels on untrimmed, assembled raw image. More... | |
void | setRawDataBBox (lsst::geom::Box2I const &bbox) |
Bounding box of amplifier image pixels on untrimmed, assembled raw image. More... | |
void | setRawFlipX (bool rawFlipX) |
Flip row order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image? More... | |
void | setRawFlipY (bool rawFlipY) |
Flip column order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image? More... | |
void | setRawXYOffset (lsst::geom::Extent2I const &xy) |
Offset in transformation from pre-raw, unassembled image to trimmed, assembled post-ISR image: final xy0 - pre-raw xy0. More... | |
void | setRawHorizontalOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal overscan pixels in the assembled, untrimmed raw image. More... | |
void | setRawVerticalOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of vertical overscan pixels in the assembled, untrimmed raw image. More... | |
void | setRawPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of (horizontal) prescan pixels in the assembled, untrimmed raw image. More... | |
void | setRawSerialOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of serial overscan pixels (equivalent to horizontal overscan pixels) in the assembled, untrimmed raw image. More... | |
void | setRawParallelOverscanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of parallel overscan pixels (equivalent to vertical overscan pixels) in the assembled, untrimmed raw image. More... | |
void | setRawSerialPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image. More... | |
void | setRawHorizontalPrescanBBox (lsst::geom::Box2I const &bbox) |
The bounding box of horizontal/serial prescan pixels in the assembled, untrimmed raw image. More... | |
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 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 Builder | fromRecord (table::BaseRecord const &record) |
Construct a new Builder object from the fields in the given record. More... | |
static table::Schema | getRecordSchema () |
Return the schema used in the afw.table representation of amplifiers. More... | |
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 276 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 407 of file Amplifier.h.
|
inlineinherited |
Amplifier gain in e-/ADU.
Definition at line 118 of file Amplifier.h.
|
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 |
Name of the amplifier.
Definition at line 112 of file Amplifier.h.
|
inlineinherited |
Bounding box of all amplifier pixels on untrimmed, assembled raw image.
Definition at line 165 of file Amplifier.h.
|
inlineinherited |
Bounding box of amplifier image pixels on untrimmed, assembled raw image.
Definition at line 171 of file Amplifier.h.
|
inlineinherited |
Flip row order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 177 of file Amplifier.h.
|
inlineinherited |
Flip column order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 183 of file Amplifier.h.
|
inlineinherited |
The bounding box of horizontal overscan pixels in the assembled, untrimmed raw image.
Definition at line 195 of file Amplifier.h.
|
inlineinherited |
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 231 of file Amplifier.h.
|
inlineinherited |
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 221 of file Amplifier.h.
|
inlineinherited |
The bounding box of (horizontal) prescan pixels in the assembled, untrimmed raw image.
Definition at line 207 of file Amplifier.h.
|
inlineinherited |
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 214 of file Amplifier.h.
|
inlineinherited |
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 228 of file Amplifier.h.
|
inlineinherited |
The bounding box of vertical overscan pixels in the assembled, untrimmed raw image.
Definition at line 201 of file Amplifier.h.
|
inlineinherited |
Offset in transformation from pre-raw, unassembled image to trimmed, assembled post-ISR image: final xy0 - pre-raw xy0.
Definition at line 189 of file Amplifier.h.
|
inlineinherited |
Amplifier read noise, in e-.
Definition at line 121 of file Amplifier.h.
|
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 322 of file Amplifier.h.
|
inline |
Amplifier gain in e-/ADU.
Definition at line 325 of file Amplifier.h.
|
inline |
Vector of linearity coefficients.
Definition at line 340 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 351 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 348 of file Amplifier.h.
|
inline |
Name of linearity parameterization.
Definition at line 345 of file Amplifier.h.
|
inline |
Units for the input to the linearity relation (DN).
Definition at line 354 of file Amplifier.h.
|
inline |
Name of the amplifier.
Definition at line 319 of file Amplifier.h.
|
inline |
Bounding box of all amplifier pixels on untrimmed, assembled raw image.
Definition at line 357 of file Amplifier.h.
|
inline |
Bounding box of amplifier image pixels on untrimmed, assembled raw image.
Definition at line 360 of file Amplifier.h.
|
inline |
Flip row order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 363 of file Amplifier.h.
|
inline |
Flip column order in transformation from untrimmed, assembled raw image to trimmed, assembled post-ISR image?
Definition at line 366 of file Amplifier.h.
|
inline |
The bounding box of horizontal overscan pixels in the assembled, untrimmed raw image.
Definition at line 372 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 402 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 392 of file Amplifier.h.
|
inline |
The bounding box of (horizontal) prescan pixels in the assembled, untrimmed raw image.
Definition at line 382 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 387 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 397 of file Amplifier.h.
|
inline |
The bounding box of vertical overscan pixels in the assembled, untrimmed raw image.
Definition at line 377 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 369 of file Amplifier.h.
|
inline |
Amplifier read noise, in e-.
Definition at line 328 of file Amplifier.h.
|
inline |
Readout corner in the trimmed, assembled image.
Definition at line 337 of file Amplifier.h.
|
inline |
Level in ADU above which pixels are considered saturated; use nan
if no such level applies.
Definition at line 331 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 334 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.