lsst::afw::cameraGeom::Amplifier::Builder Class Reference

A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers. More...

#include <Amplifier.h>

Inheritance diagram for lsst::afw::cameraGeom::Amplifier::Builder:

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

Detailed Description

A mutable Amplifier subclass class that can be used to incrementally construct or modify Amplifiers.

Definition at line 305 of file Amplifier.h.

Constructor & Destructor Documentation

Builder() [1/4]

lsst::afw::cameraGeom::Amplifier::Builder::Builder ( )

default

Construct a Builder with default values for all fields.

Builder() [2/4]

lsst::afw::cameraGeom::Amplifier::Builder::Builder ( Builder const & )

default

Standard copy constructor.

Builder() [3/4]

lsst::afw::cameraGeom::Amplifier::Builder::Builder ( Builder && )

default

Standard move constructor.

Builder() [4/4]

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.

: _fields(other.getFields()) {}

~Builder()

lsst::afw::cameraGeom::Amplifier::Builder::~Builder ( )

overridedefaultnoexcept

Member Function Documentation

finish()

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.

                                                              {
    return std::make_shared<FrozenAmplifier>(_fields);
}

fromRecord()

Amplifier::Builder lsst::afw::cameraGeom::Amplifier::Builder::fromRecord ( table::BaseRecord const & record )

static

Construct a new Builder object from the fields in the given record.

Parameters

[in]

record

Record to copy fields from.

Definition at line 286 of file Amplifier.cc.

                                                                            {
    auto const helper = RecordSchemaHelper(record.getSchema());
    Builder result;
    result.setName(record.get(helper.name));
    result.setBBox(record.get(helper.bbox));
    result.setGain(record.get(helper.gain));
    result.setReadNoise(record.get(helper.readNoise));
    result.setSaturation(record.get(helper.saturation));
    result.setSuspectLevel(record.get(helper.suspectLevel));
    result.setReadoutCorner(static_cast<ReadoutCorner>(record.get(helper.readoutCorner)));
    result.setLinearityCoeffs(ndarray::copy(record.get(helper.linearityCoeffs)));
    result.setLinearityType(record.get(helper.linearityType));
    result.setRawBBox(record.get(helper.rawBBox));
    result.setRawDataBBox(record.get(helper.rawDataBBox));
    result.setRawFlipX(record.get(helper.rawFlipX));
    result.setRawFlipY(record.get(helper.rawFlipY));
    result.setRawXYOffset(lsst::geom::Extent2I(record.get(helper.rawXYOffset)));
    result.setRawHorizontalOverscanBBox(record.get(helper.rawHorizontalOverscanBBox));
    result.setRawVerticalOverscanBBox(record.get(helper.rawVerticalOverscanBBox));
    result.setRawHorizontalOverscanBBox(record.get(helper.rawHorizontalOverscanBBox));
    result.setRawPrescanBBox(record.get(helper.rawPrescanBBox));
    // Set not-always-present fields only when present.  While it's usually
    // preferable to use the public setter methods (as above), passing member
    // function pointers through the lambda below is sufficiently unpleasant
    // that we just set the private member directly.
    auto setIfValid = [&record](auto & member, auto & key) {
        if (key.isValid()) {
            member = record.get(key);
        }
    };
    setIfValid(result._fields.linearityThreshold, helper.linearityThreshold);
    setIfValid(result._fields.linearityMaximum, helper.linearityMaximum);
    setIfValid(result._fields.linearityUnits, helper.linearityUnits);
    return result;
}

getBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getBBox ( ) const

inlineinherited

Bounding box of amplifier pixels in the trimmed, assembled image.

Definition at line 115 of file Amplifier.h.

{ return getFields().bbox; }

getFields()

Fields const & lsst::afw::cameraGeom::Amplifier::Builder::getFields ( ) const

inlineoverrideprotectedvirtual

Implements lsst::afw::cameraGeom::Amplifier.

Definition at line 436 of file Amplifier.h.

{ return _fields; }

getGain()

double lsst::afw::cameraGeom::Amplifier::getGain ( ) const

inlineinherited

Amplifier gain in e-/ADU.

Definition at line 118 of file Amplifier.h.

{ return getFields().gain; }

getLinearityCoeffs()

ndarray::Array< double const, 1, 1 > lsst::afw::cameraGeom::Amplifier::getLinearityCoeffs ( ) const

inlineinherited

Vector of linearity coefficients.

Definition at line 142 of file Amplifier.h.

{ return getFields().linearityCoeffs; }

getLinearityMaximum()

double lsst::afw::cameraGeom::Amplifier::getLinearityMaximum ( ) const

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.

{ return getFields().linearityMaximum; }

getLinearityThreshold()

double lsst::afw::cameraGeom::Amplifier::getLinearityThreshold ( ) const

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.

{ return getFields().linearityThreshold; }

getLinearityType()

std::string lsst::afw::cameraGeom::Amplifier::getLinearityType ( ) const

inlineinherited

Name of linearity parameterization.

Definition at line 145 of file Amplifier.h.

{ return getFields().linearityType; }

getLinearityUnits()

std::string lsst::afw::cameraGeom::Amplifier::getLinearityUnits ( ) const

inlineinherited

Units for the input to the linearity relation (DN).

Definition at line 159 of file Amplifier.h.

{ return getFields().linearityUnits; }

getName()

std::string lsst::afw::cameraGeom::Amplifier::getName ( ) const

inlineinherited

Name of the amplifier.

Definition at line 112 of file Amplifier.h.

{ return getFields().name; }

getRawBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawBBox ( ) const

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.

{ return getFields().rawBBox; }

getRawDataBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawDataBBox ( ) const

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.

{ return getFields().rawDataBBox; }

getRawFlipX()

bool lsst::afw::cameraGeom::Amplifier::getRawFlipX ( ) const

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.

{ return getFields().rawFlipX; }

getRawFlipY()

bool lsst::afw::cameraGeom::Amplifier::getRawFlipY ( ) const

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.

{ return getFields().rawFlipY; }

getRawHorizontalOverscanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawHorizontalOverscanBBox ( ) const

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.

{ return getFields().rawHorizontalOverscanBBox; }

getRawHorizontalPrescanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawHorizontalPrescanBBox ( ) const

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.

{ return getFields().rawPrescanBBox; }

getRawParallelOverscanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawParallelOverscanBBox ( ) const

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.

{ return getFields().rawVerticalOverscanBBox; }

getRawPrescanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawPrescanBBox ( ) const

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.

{ return getFields().rawPrescanBBox; }

getRawSerialOverscanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawSerialOverscanBBox ( ) const

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.

{ return getFields().rawHorizontalOverscanBBox; }

getRawSerialPrescanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawSerialPrescanBBox ( ) const

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.

{ return getFields().rawPrescanBBox; }

getRawVerticalOverscanBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::Amplifier::getRawVerticalOverscanBBox ( ) const

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.

{ return getFields().rawVerticalOverscanBBox; }

getRawXYOffset()

lsst::geom::Extent2I lsst::afw::cameraGeom::Amplifier::getRawXYOffset ( ) const

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.

{ return getFields().rawXYOffset; }

getReadNoise()

double lsst::afw::cameraGeom::Amplifier::getReadNoise ( ) const

inlineinherited

Amplifier read noise, in e-.

Definition at line 121 of file Amplifier.h.

{ return getFields().readNoise; }

getReadoutCorner()

ReadoutCorner lsst::afw::cameraGeom::Amplifier::getReadoutCorner ( ) const

inlineinherited

Readout corner in the trimmed, assembled image.

Definition at line 139 of file Amplifier.h.

{ return getFields().readoutCorner; }

getRecordSchema()

table::Schema lsst::afw::cameraGeom::Amplifier::getRecordSchema ( )

staticinherited

Return the schema used in the afw.table representation of amplifiers.

Definition at line 267 of file Amplifier.cc.

                                       {
    return RecordSchemaHelper::getMinimal().schema;
}

getSaturation()

double lsst::afw::cameraGeom::Amplifier::getSaturation ( ) const

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.

{ return getFields().saturation; }

getSuspectLevel()

double lsst::afw::cameraGeom::Amplifier::getSuspectLevel ( ) const

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.

{ return getFields().suspectLevel; }

operator=() [1/3]

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.

                                                                      {
    using std::swap;
    Fields copy(other.getFields());
    swap(_fields, copy);
    return *this;
}

operator=() [2/3]

Builder & lsst::afw::cameraGeom::Amplifier::Builder::operator= ( Builder && )

default

Standard move assignment.

operator=() [3/3]

Builder & lsst::afw::cameraGeom::Amplifier::Builder::operator= ( Builder const & )

default

Standard copy assignment.

rebuild()

Amplifier::Builder lsst::afw::cameraGeom::Amplifier::rebuild ( ) const

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.

{ return Builder(*this); }

setBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setBBox ( lsst::geom::Box2I const & bbox )

inline

Bounding box of amplifier pixels in the trimmed, assembled image.

Definition at line 351 of file Amplifier.h.

{ _fields.bbox = bbox; }

setGain()

void lsst::afw::cameraGeom::Amplifier::Builder::setGain ( double gain )

inline

Amplifier gain in e-/ADU.

Definition at line 354 of file Amplifier.h.

{ _fields.gain = gain; }

setLinearityCoeffs()

void lsst::afw::cameraGeom::Amplifier::Builder::setLinearityCoeffs ( ndarray::Array< double const, 1, 1 > const & coeffs )

inline

Vector of linearity coefficients.

Definition at line 369 of file Amplifier.h.

                                                                             {
        _fields.linearityCoeffs = coeffs;
    }

setLinearityMaximum()

void lsst::afw::cameraGeom::Amplifier::Builder::setLinearityMaximum ( double maximum )

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.

{ _fields.linearityMaximum = maximum; }

setLinearityThreshold()

void lsst::afw::cameraGeom::Amplifier::Builder::setLinearityThreshold ( double threshold )

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.

{ _fields.linearityThreshold = threshold; }

setLinearityType()

void lsst::afw::cameraGeom::Amplifier::Builder::setLinearityType ( std::string const & type )

inline

Name of linearity parameterization.

Definition at line 374 of file Amplifier.h.

{ _fields.linearityType = type; }

setLinearityUnits()

void lsst::afw::cameraGeom::Amplifier::Builder::setLinearityUnits ( std::string const & units )

inline

Units for the input to the linearity relation (DN).

Definition at line 383 of file Amplifier.h.

{ _fields.linearityUnits = units; }

setName()

void lsst::afw::cameraGeom::Amplifier::Builder::setName ( std::string const & name )

inline

Name of the amplifier.

Definition at line 348 of file Amplifier.h.

{ _fields.name = name; }

setRawBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawBBox ( lsst::geom::Box2I const & bbox )

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.

{ _fields.rawBBox = bbox; }

setRawDataBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawDataBBox ( lsst::geom::Box2I const & bbox )

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.

{ _fields.rawDataBBox = bbox; }

setRawFlipX()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawFlipX ( bool rawFlipX )

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.

{ _fields.rawFlipX = rawFlipX; }

setRawFlipY()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawFlipY ( bool rawFlipY )

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.

{ _fields.rawFlipY = rawFlipY; }

setRawHorizontalOverscanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawHorizontalOverscanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                                 {
        _fields.rawHorizontalOverscanBBox = bbox;
    }

setRawHorizontalPrescanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawHorizontalPrescanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                                {
        _fields.rawPrescanBBox = bbox;
    }

setRawParallelOverscanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawParallelOverscanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                               {
        _fields.rawVerticalOverscanBBox = bbox;
    }

setRawPrescanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawPrescanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                      {
        _fields.rawPrescanBBox = bbox;
    }

setRawSerialOverscanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawSerialOverscanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                             {
        _fields.rawHorizontalOverscanBBox = bbox;
    }

setRawSerialPrescanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawSerialPrescanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                            {
        _fields.rawPrescanBBox = bbox;
    }

setRawVerticalOverscanBBox()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawVerticalOverscanBBox ( lsst::geom::Box2I const & bbox )

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.

                                                               {
        _fields.rawVerticalOverscanBBox = bbox;
    }

setRawXYOffset()

void lsst::afw::cameraGeom::Amplifier::Builder::setRawXYOffset ( lsst::geom::Extent2I const & xy )

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.

{ _fields.rawXYOffset = xy; }

setReadNoise()

void lsst::afw::cameraGeom::Amplifier::Builder::setReadNoise ( double readNoise )

inline

Amplifier read noise, in e-.

Definition at line 357 of file Amplifier.h.

{ _fields.readNoise = readNoise; }

setReadoutCorner()

void lsst::afw::cameraGeom::Amplifier::Builder::setReadoutCorner ( ReadoutCorner readoutCorner )

inline

Readout corner in the trimmed, assembled image.

Definition at line 366 of file Amplifier.h.

{ _fields.readoutCorner = readoutCorner; }

setSaturation()

void lsst::afw::cameraGeom::Amplifier::Builder::setSaturation ( double saturation )

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.

{ _fields.saturation = saturation; }

setSuspectLevel()

void lsst::afw::cameraGeom::Amplifier::Builder::setSuspectLevel ( double suspectLevel )

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.

{ _fields.suspectLevel = suspectLevel; }

toRecord()

void lsst::afw::cameraGeom::Amplifier::toRecord ( table::BaseRecord & record ) const

inherited

Copy the Amplifier's fields into the given record.

Parameters

[out]

record

Record to modify. record.getSchema().contains(this->getRecordSchema()) must be true.

Definition at line 322 of file Amplifier.cc.

                                                       {
    auto const helper = RecordSchemaHelper(record.getSchema());
    auto const & fields = getFields();
    record.set(helper.name, fields.name);
    record.set(helper.bbox, fields.bbox);
    record.set(helper.gain, fields.gain);
    record.set(helper.readNoise, fields.readNoise);
    record.set(helper.saturation, fields.saturation);
    record.set(helper.suspectLevel, fields.suspectLevel);
    record.set(helper.readoutCorner, static_cast<int>(fields.readoutCorner));
    ndarray::Array<double, 1, 1> coeffs = ndarray::copy(fields.linearityCoeffs);
    record.set(helper.linearityCoeffs, coeffs);
    record.set(helper.linearityType, fields.linearityType);
    record.set(helper.rawBBox, fields.rawBBox);
    record.set(helper.rawDataBBox, fields.rawDataBBox);
    record.set(helper.rawFlipX, fields.rawFlipX);
    record.set(helper.rawFlipY, fields.rawFlipY);
    record.set(helper.rawXYOffset, lsst::geom::Point2I(fields.rawXYOffset));
    record.set(helper.rawHorizontalOverscanBBox, fields.rawHorizontalOverscanBBox);
    record.set(helper.rawVerticalOverscanBBox, fields.rawVerticalOverscanBBox);
    record.set(helper.rawPrescanBBox, fields.rawPrescanBBox);
    // Set not-always-present fields only when present.
    auto setIfValid = [&record](auto value, auto & key) {
        if (key.isValid()) {
            record.set(key, value);
        }
    };
    setIfValid(fields.linearityThreshold, helper.linearityThreshold);
    setIfValid(fields.linearityMaximum, helper.linearityMaximum);
    setIfValid(fields.linearityUnits, helper.linearityUnits);
}

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+66d966b544/include/lsst/afw/cameraGeom/Amplifier.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+66d966b544/src/cameraGeom/Amplifier.cc