lsst::afw::table::AmpInfoRecord Class Reference

Geometry and electronic information about raw amplifier images. More...

#include <AmpInfo.h>

Inheritance diagram for lsst::afw::table::AmpInfoRecord:

Public Types
typedef AmpInfoTable	Table
typedef ColumnViewT< AmpInfoRecord >	ColumnView
typedef CatalogT< AmpInfoRecord >	Catalog
typedef CatalogT< AmpInfoRecord const >	ConstCatalog

Public Member Functions
	AmpInfoRecord (AmpInfoRecord const &)=delete
	AmpInfoRecord (AmpInfoRecord &&)=delete
AmpInfoRecord &	operator= (AmpInfoRecord const &)=delete
AmpInfoRecord &	operator= (AmpInfoRecord &&)=delete
	~AmpInfoRecord () override
	AmpInfoRecord (ConstructionToken const &token, detail::RecordData &&data)
	Constructor used by AmpInfoTable. More...
std::shared_ptr< AmpInfoTable const >	getTable () const
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys. More...
template<typename T >
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const). More...
template<typename T >
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const). More...
template<typename T >
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value. More...
template<typename T >
Field< T >::ConstReference	operator[] (Key< T > const &key) const
	Return a const reference (or const-reference-like type) to the field's value. More...
template<typename Ref >
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef >
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
template<typename T >
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key. More...
template<typename T >
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field. More...
template<typename T , typename U >
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key. More...
template<typename T , typename U >
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field. More...
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas. More...
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper. More...
ndarray::Manager::Ptr	getManager () const
std::string	getName () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setName (std::string const &name)
	name of amplifier location in camera More...
lsst::geom::Box2I	getBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setBBox (lsst::geom::Box2I const &bbox)
	bounding box of amplifier pixels in assembled image More...
double	getGain () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setGain (double gain)
	amplifier gain in e-/ADU More...
double	getReadNoise () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setReadNoise (double readNoise)
	amplifier read noise, in e- More...
double	getSaturation () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setSaturation (double saturation)
	level in ADU above which pixels are considered saturated; More...
double	getSuspectLevel () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setSuspectLevel (double suspectLevel)
	level in ADU above which pixels are considered suspicious, More...
ReadoutCorner	getReadoutCorner () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setReadoutCorner (ReadoutCorner val)
	set readout corner More...
std::vector< double >	getLinearityCoeffs () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setLinearityCoeffs (std::vector< double > const &coeffs)
	vector of linearity coefficients More...
std::string	getLinearityType () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setLinearityType (std::string const &type)
	name of linearity parameterization More...
bool	getHasRawInfo () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setHasRawInfo (bool hasRawInfo)
	does this table have raw amplifier information? More...
lsst::geom::Box2I	getRawBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawBBox (lsst::geom::Box2I const &bbox)
	bounding box of all amplifier pixels on raw image More...
lsst::geom::Box2I	getRawDataBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawDataBBox (lsst::geom::Box2I const &bbox)
	bounding box of amplifier image pixels on raw image More...
bool	getRawFlipX () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawFlipX (bool rawFlipX)
	flip row order to make assembled image? More...
bool	getRawFlipY () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawFlipY (bool rawFlipY)
	flip column order to make an assembled image? More...
lsst::geom::Extent2I	getRawXYOffset () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawXYOffset (lsst::geom::Extent2I const &xy)
	offset for assembling a raw CCD image: desired xy0 - raw xy0 More...
lsst::geom::Box2I	getRawHorizontalOverscanBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawHorizontalOverscanBBox (lsst::geom::Box2I const &bbox)
	bounding box of usable horizontal overscan pixels More...
lsst::geom::Box2I	getRawVerticalOverscanBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawVerticalOverscanBBox (lsst::geom::Box2I const &bbox)
	bounding box of usable vertical overscan pixels More...
lsst::geom::Box2I	getRawPrescanBBox () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRawPrescanBBox (lsst::geom::Box2I const &bbox)
	bounding box of usable (horizontal) prescan pixels on raw image More...

Protected Member Functions
virtual void	_assign (BaseRecord const &other)
	Called by assign() after transferring fields to allow subclass data members to be copied. More...
virtual void	_stream (std::ostream &os) const
	Called by operator<<. More...

Friends
class	AmpInfoTable

Detailed Description

Geometry and electronic information about raw amplifier images.

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

Note

• All bounding boxes are parent boxes with respect to the raw image.
• The overscan and underscan bounding boxes are regions containing USABLE data, NOT the entire underscan and overscan region. These bounding boxes should exclude areas with weird electronic artifacts. Each bounding box can be empty (0 extent) if the corresponding region is not used for data processing.
• xyOffset is not used for instrument signature removal (ISR); it is intended for use by display utilities. It supports construction of a raw CCD image in the case that raw data is provided as individual amplifier images (which is uncommon):
  • Use 0,0 for cameras that supply raw data as a raw CCD image (most cameras)
  • Use nonzero for cameras that supply raw data as separate amplifier images with xy0=0,0 (LSST)
• This design assumes assembled X is always +/- raw X, which we require for CCDs (so that bleed trails are always along the Y axis). If you must swap X/Y then add a doTranspose flag.

Definition at line 79 of file AmpInfo.h.

Member Typedef Documentation

Catalog

typedef CatalogT<AmpInfoRecord> lsst::afw::table::AmpInfoRecord::Catalog

Definition at line 83 of file AmpInfo.h.

ColumnView

typedef ColumnViewT<AmpInfoRecord> lsst::afw::table::AmpInfoRecord::ColumnView

Definition at line 82 of file AmpInfo.h.

ConstCatalog

typedef CatalogT<AmpInfoRecord const> lsst::afw::table::AmpInfoRecord::ConstCatalog

Definition at line 84 of file AmpInfo.h.

Table

typedef AmpInfoTable lsst::afw::table::AmpInfoRecord::Table

Definition at line 81 of file AmpInfo.h.

Constructor & Destructor Documentation

AmpInfoRecord() [1/3]

lsst::afw::table::AmpInfoRecord::AmpInfoRecord ( AmpInfoRecord const &  )

delete

AmpInfoRecord() [2/3]

lsst::afw::table::AmpInfoRecord::AmpInfoRecord ( AmpInfoRecord &&  )

delete

~AmpInfoRecord()

lsst::afw::table::AmpInfoRecord::~AmpInfoRecord ( )

overridedefault

AmpInfoRecord() [3/3]

lsst::afw::table::AmpInfoRecord::AmpInfoRecord ( ConstructionToken const &  token, detail::RecordData &&  data  )

inline

Constructor used by AmpInfoTable.

While formally public, this constructor is conceptually and effectively protected, due to the (protected) ConstructionToken argument.

This is to allow make_shared to be used, as that cannot be used on a truly protected or private constructor.

Definition at line 101 of file AmpInfo.h.

                                                                             :
        BaseRecord(token, std::move(data))
    {}

Member Function Documentation

_assign()

virtual void lsst::afw::table::BaseRecord::_assign ( BaseRecord const &  other )

inlineprotectedvirtualinherited

Called by assign() after transferring fields to allow subclass data members to be copied.

Reimplemented in lsst::afw::table::SourceRecord, and lsst::afw::table::ExposureRecord.

Definition at line 209 of file BaseRecord.h.

{}

_stream()

void lsst::afw::table::BaseRecord::_stream ( std::ostream &  os ) const

protectedvirtualinherited

Called by operator<<.

Overrides should call the base class implementation and append additional fields on new lines, with the syntax "%(name)s: %(value)s".

Definition at line 153 of file BaseRecord.cc.

                                             {
    getSchema().forEach([&os, this](auto const& item) {
        os << item.field.getName() << ": " << this->get(item.key) << std::endl;
    });
}

assign() [1/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const &  other )

inherited

Copy all field values from other to this, requiring that they have equal schemas.

Definition at line 123 of file BaseRecord.cc.

                                               {
    if (this->getSchema() != other.getSchema()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError, "Unequal schemas in record assignment.");
    }
    this->getSchema().forEach(CopyValue(&other, this));
    this->_assign(other);  // let derived classes assign their own stuff
}

assign() [2/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const &  other, SchemaMapper const &  mapper  )

inherited

Copy field values from other to this, using a mapper.

Definition at line 131 of file BaseRecord.cc.

                                                                           {
    if (!other.getSchema().contains(mapper.getInputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between input record and mapper.");
    }
    if (!this->getSchema().contains(mapper.getOutputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between output record and mapper.");
    }
    mapper.forEach(CopyValue(&other, this));  // use the functor we defined above
    this->_assign(other);                     // let derived classes assign their own stuff
}

get() [1/2]

template<typename T >

Field<T>::Value lsst::afw::table::BaseRecord::get ( Key< T > const &  key ) const

inlineinherited

Return the value of a field for the given key.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 151 of file BaseRecord.h.

                                                        {
        return key.getValue(getElement(key), _manager);
    }

get() [2/2]

template<typename T >

T lsst::afw::table::BaseRecord::get ( OutputFunctorKey< T > const &  key ) const

inlineinherited

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

                                                {
        return key.get(*this);
    }

getBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 176 of file AmpInfo.cc.

                                           {
    return lsst::geom::Box2I(get(AmpInfoTable::getBBoxMinKey()),
                             lsst::geom::Extent2I(get(AmpInfoTable::getBBoxExtentKey())));
}

getElement() [1/2]

template<typename T >

Field<T>::Element* lsst::afw::table::BaseRecord::getElement ( Key< T > const &  key )

inlineinherited

Return a pointer to the underlying elements of a field (non-const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 93 of file BaseRecord.h.

                                                            {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element*>(reinterpret_cast<char*>(_data) +
                                                             key.getOffset());
    }

getElement() [2/2]

template<typename T >

Field<T>::Element const* lsst::afw::table::BaseRecord::getElement ( Key< T > const &  key ) const

inlineinherited

Return a pointer to the underlying elements of a field (const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 111 of file BaseRecord.h.

                                                                        {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element const*>(reinterpret_cast<char const*>(_data) +
                                                                   key.getOffset());
    }

getGain()

double lsst::afw::table::AmpInfoRecord::getGain

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 185 of file AmpInfo.cc.

{ return get(AmpInfoTable::getGainKey()); }

getHasRawInfo()

bool lsst::afw::table::AmpInfoRecord::getHasRawInfo

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 220 of file AmpInfo.cc.

{ return get(AmpInfoTable::getHasRawInfoKey()); }

getLinearityCoeffs()

std::vector< double > lsst::afw::table::AmpInfoRecord::getLinearityCoeffs

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 206 of file AmpInfo.cc.

                                                          {
    Key<Array<double> > coeffKey = AmpInfoTable::getLinearityCoeffsKey();
    return coeffKey.extractVector(*this);
}

getLinearityType()

std::string lsst::afw::table::AmpInfoRecord::getLinearityType

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 215 of file AmpInfo.cc.

{ return get(AmpInfoTable::getLinearityTypeKey()); }

getManager()

ndarray::Manager::Ptr lsst::afw::table::BaseRecord::getManager ( ) const

inlineinherited

Definition at line 200 of file BaseRecord.h.

{ return _manager; }

getName()

std::string lsst::afw::table::AmpInfoRecord::getName

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 173 of file AmpInfo.cc.

{ return get(AmpInfoTable::getNameKey()); }

getRawBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getRawBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 225 of file AmpInfo.cc.

                                              {
    return lsst::geom::Box2I(get(AmpInfoTable::getRawBBoxMinKey()),
                             lsst::geom::Extent2I(get(AmpInfoTable::getRawBBoxExtentKey())));
}

getRawDataBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getRawDataBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 234 of file AmpInfo.cc.

                                                  {
    return lsst::geom::Box2I(get(AmpInfoTable::getRawDataBBoxMinKey()),
                             lsst::geom::Extent2I(get(AmpInfoTable::getRawDataBBoxExtentKey())));
}

getRawFlipX()

bool lsst::afw::table::AmpInfoRecord::getRawFlipX

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 243 of file AmpInfo.cc.

{ return get(AmpInfoTable::getRawFlipXKey()); }

getRawFlipY()

bool lsst::afw::table::AmpInfoRecord::getRawFlipY

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 246 of file AmpInfo.cc.

{ return get(AmpInfoTable::getRawFlipYKey()); }

getRawHorizontalOverscanBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getRawHorizontalOverscanBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 256 of file AmpInfo.cc.

                                                                {
    return lsst::geom::Box2I(
            get(AmpInfoTable::getRawHorizontalOverscanBBoxMinKey()),
            lsst::geom::Extent2I(get(AmpInfoTable::getRawHorizontalOverscanBBoxExtentKey())));
}

getRawPrescanBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getRawPrescanBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 275 of file AmpInfo.cc.

                                                     {
    return lsst::geom::Box2I(get(AmpInfoTable::getRawPrescanBBoxMinKey()),
                             lsst::geom::Extent2I(get(AmpInfoTable::getRawPrescanBBoxExtentKey())));
}

getRawVerticalOverscanBBox()

lsst::geom::Box2I lsst::afw::table::AmpInfoRecord::getRawVerticalOverscanBBox

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 266 of file AmpInfo.cc.

                                                              {
    return lsst::geom::Box2I(get(AmpInfoTable::getRawVerticalOverscanBBoxMinKey()),
                             lsst::geom::Extent2I(get(AmpInfoTable::getRawVerticalOverscanBBoxExtentKey())));
}

getRawXYOffset()

lsst::geom::Extent2I lsst::afw::table::AmpInfoRecord::getRawXYOffset

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 249 of file AmpInfo.cc.

                                                     {
    return lsst::geom::Extent2I(get(AmpInfoTable::getRawXYOffsetKey()));
}

getReadNoise()

double lsst::afw::table::AmpInfoRecord::getReadNoise

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 196 of file AmpInfo.cc.

{ return get(AmpInfoTable::getReadNoiseKey()); }

getReadoutCorner()

ReadoutCorner lsst::afw::table::AmpInfoRecord::getReadoutCorner

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 199 of file AmpInfo.cc.

                                                    {
    return static_cast<ReadoutCorner>(get(AmpInfoTable::getReadoutCornerKey()));
}

getSaturation()

double lsst::afw::table::AmpInfoRecord::getSaturation

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 188 of file AmpInfo.cc.

{ return get(AmpInfoTable::getSaturationKey()); }

getSchema()

Schema lsst::afw::table::BaseRecord::getSchema ( ) const

inlineinherited

Return the Schema that holds this record's fields and keys.

Definition at line 80 of file BaseRecord.h.

{ return _table->getSchema(); }

getSuspectLevel()

double lsst::afw::table::AmpInfoRecord::getSuspectLevel

(

)

const

Convenience accessors for the keys in the minimal reference schema.

Definition at line 191 of file AmpInfo.cc.

{ return get(AmpInfoTable::getSuspectLevelKey()); }

getTable()

std::shared_ptr<AmpInfoTable const> lsst::afw::table::AmpInfoRecord::getTable ( ) const

inline

Definition at line 105 of file AmpInfo.h.

                                                       {
        return std::static_pointer_cast<AmpInfoTable const>(BaseRecord::getTable());
    }

operator=() [1/2]

AmpInfoRecord& lsst::afw::table::AmpInfoRecord::operator= ( AmpInfoRecord const &  )

delete

operator=() [2/2]

AmpInfoRecord& lsst::afw::table::AmpInfoRecord::operator= ( AmpInfoRecord &&  )

delete

operator[]() [1/4]

template<typename T >

Field<T>::Reference lsst::afw::table::BaseRecord::operator[] ( Key< T > const &  key )

inlineinherited

Return a reference (or reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 129 of file BaseRecord.h.

                                                             {
        return key.getReference(getElement(key), _manager);
    }

operator[]() [2/4]

template<typename T >

Field<T>::ConstReference lsst::afw::table::BaseRecord::operator[] ( Key< T > const &  key ) const

inlineinherited

Return a const reference (or const-reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 141 of file BaseRecord.h.

                                                                        {
        return key.getConstReference(getElement(key), _manager);
    }

operator[]() [3/4]

template<typename Ref >

Ref lsst::afw::table::BaseRecord::operator[] ( ReferenceFunctorKey< Ref > const &  key )

inlineinherited

Definition at line 185 of file BaseRecord.h.

                                                        {
        return key.getReference(*this);
    }

operator[]() [4/4]

template<typename ConstRef >

ConstRef lsst::afw::table::BaseRecord::operator[] ( ConstReferenceFunctorKey< ConstRef > const &  key ) const

inlineinherited

Definition at line 190 of file BaseRecord.h.

                                                                             {
        return key.getConstReference(*this);
    }

set() [1/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( Key< T > const &  key, U const &  value  )

inlineinherited

Set value of a field for the given key.

This method has an additional template parameter because some fields accept and convert different types to the stored field type.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 164 of file BaseRecord.h.

                                                {
        key.setValue(getElement(key), _manager, value);
    }

set() [2/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( InputFunctorKey< T > const &  key, U const &  value  )

inlineinherited

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

                                                            {
        return key.set(*this, value);
    }

setBBox()

void lsst::afw::table::AmpInfoRecord::setBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of amplifier pixels in assembled image

Definition at line 180 of file AmpInfo.cc.

                                                     {
    set(AmpInfoTable::getBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setGain()

void lsst::afw::table::AmpInfoRecord::setGain

(

double

gain

)

amplifier gain in e-/ADU

Definition at line 186 of file AmpInfo.cc.

{ set(AmpInfoTable::getGainKey(), gain); }

setHasRawInfo()

void lsst::afw::table::AmpInfoRecord::setHasRawInfo

(

bool

hasRawInfo

)

does this table have raw amplifier information?

Definition at line 221 of file AmpInfo.cc.

                                                      {
    set(AmpInfoTable::getHasRawInfoKey(), hasrawamplifier);
}

setLinearityCoeffs()

void lsst::afw::table::AmpInfoRecord::setLinearityCoeffs

(

std::vector< double > const &

coeffs

)

vector of linearity coefficients

Definition at line 210 of file AmpInfo.cc.

                                                                               {
    Key<Array<double> > coeffKey = AmpInfoTable::getLinearityCoeffsKey();
    coeffKey.assignVector(*this, linearityCoeffs);
}

setLinearityType()

void lsst::afw::table::AmpInfoRecord::setLinearityType

(

std::string const &

type

)

name of linearity parameterization

Definition at line 216 of file AmpInfo.cc.

                                                                   {
    set(AmpInfoTable::getLinearityTypeKey(), linearityType);
}

setName()

void lsst::afw::table::AmpInfoRecord::setName

(

std::string const &

name

)

name of amplifier location in camera

Definition at line 174 of file AmpInfo.cc.

{ set(AmpInfoTable::getNameKey(), name); }

setRawBBox()

void lsst::afw::table::AmpInfoRecord::setRawBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of all amplifier pixels on raw image

Definition at line 229 of file AmpInfo.cc.

                                                        {
    set(AmpInfoTable::getRawBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getRawBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setRawDataBBox()

void lsst::afw::table::AmpInfoRecord::setRawDataBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of amplifier image pixels on raw image

Definition at line 238 of file AmpInfo.cc.

                                                            {
    set(AmpInfoTable::getRawDataBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getRawDataBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setRawFlipX()

void lsst::afw::table::AmpInfoRecord::setRawFlipX

(

bool

rawFlipX

)

flip row order to make assembled image?

Definition at line 244 of file AmpInfo.cc.

{ set(AmpInfoTable::getRawFlipXKey(), rawFlipX); }

setRawFlipY()

void lsst::afw::table::AmpInfoRecord::setRawFlipY

(

bool

rawFlipY

)

flip column order to make an assembled image?

Definition at line 247 of file AmpInfo.cc.

{ set(AmpInfoTable::getRawFlipYKey(), rawFlipY); }

setRawHorizontalOverscanBBox()

void lsst::afw::table::AmpInfoRecord::setRawHorizontalOverscanBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of usable horizontal overscan pixels

Definition at line 261 of file AmpInfo.cc.

                                                                          {
    set(AmpInfoTable::getRawHorizontalOverscanBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getRawHorizontalOverscanBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setRawPrescanBBox()

void lsst::afw::table::AmpInfoRecord::setRawPrescanBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of usable (horizontal) prescan pixels on raw image

Definition at line 279 of file AmpInfo.cc.

                                                               {
    set(AmpInfoTable::getRawPrescanBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getRawPrescanBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setRawVerticalOverscanBBox()

void lsst::afw::table::AmpInfoRecord::setRawVerticalOverscanBBox

(

lsst::geom::Box2I const &

bbox

)

bounding box of usable vertical overscan pixels

Definition at line 270 of file AmpInfo.cc.

                                                                        {
    set(AmpInfoTable::getRawVerticalOverscanBBoxMinKey(), bbox.getMin());
    set(AmpInfoTable::getRawVerticalOverscanBBoxExtentKey(), lsst::geom::Point2I(bbox.getDimensions()));
}

setRawXYOffset()

void lsst::afw::table::AmpInfoRecord::setRawXYOffset

(

lsst::geom::Extent2I const &

xy

)

offset for assembling a raw CCD image: desired xy0 - raw xy0

Definition at line 252 of file AmpInfo.cc.

                                                                      {
    set(AmpInfoTable::getRawXYOffsetKey(), lsst::geom::Point2I(rawxyoffset.asPair()));
}

setReadNoise()

void lsst::afw::table::AmpInfoRecord::setReadNoise

(

double

readNoise

)

amplifier read noise, in e-

Definition at line 197 of file AmpInfo.cc.

{ set(AmpInfoTable::getReadNoiseKey(), readNoise); }

setReadoutCorner()

void lsst::afw::table::AmpInfoRecord::setReadoutCorner

(

ReadoutCorner

val

)

set readout corner

Definition at line 202 of file AmpInfo.cc.

                                                                {
    set(AmpInfoTable::getReadoutCornerKey(), readoutCorner);
}

setSaturation()

void lsst::afw::table::AmpInfoRecord::setSaturation

(

double

saturation

)

level in ADU above which pixels are considered saturated;

use nan if no such level applies",

Definition at line 189 of file AmpInfo.cc.

{ set(AmpInfoTable::getSaturationKey(), saturation); }

setSuspectLevel()

void lsst::afw::table::AmpInfoRecord::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; use nan if no such level applies",

Definition at line 192 of file AmpInfo.cc.

                                                       {
    set(AmpInfoTable::getSuspectLevelKey(), suspectLevel);
}

Friends And Related Function Documentation

AmpInfoTable

friend class AmpInfoTable

friend

Definition at line 178 of file AmpInfo.h.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0-22-g936f6a9b4/include/lsst/afw/table/AmpInfo.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0-22-g936f6a9b4/src/table/AmpInfo.cc