lsst.afw g5a732f18d5+66d966b544
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | Related Symbols | List of all members
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats Class Reference
Inheritance diagram for lsst.afw.image._exposureSummaryStats.ExposureSummaryStats:
lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable

Public Member Functions

 __post_init__ (self)
 
 isPersistable (self)
 
None update_schema (cls, Schema schema)
 
None update_record (self, BaseRecord record)
 
ExposureSummaryStats from_record (cls, BaseRecord record)
 
virtual std::shared_ptr< StorablecloneStorable () const
 Create a new object that is a copy of this one (optional operation).
 
virtual std::string toString () const
 Create a string representation of this object (optional operation).
 
virtual std::size_t hash_value () const
 Return a hash of this object (optional operation).
 
virtual bool equals (Storable const &other) const noexcept
 Compare this object to another Storable.
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file.
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory.
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object.
 
virtual bool isPersistable () const noexcept
 Return true if this particular object can be persisted using afw::table::io.
 

Static Public Attributes

int version = 0
 
float psfSigma = float('nan')
 
float psfArea = float('nan')
 
float psfIxx = float('nan')
 
float psfIyy = float('nan')
 
float psfIxy = float('nan')
 
float ra = float('nan')
 
float dec = float('nan')
 
float zenithDistance = float('nan')
 
float zeroPoint = float('nan')
 
float skyBg = float('nan')
 
float skyNoise = float('nan')
 
float meanVar = float('nan')
 
list raCorners = dataclasses.field(default_factory=_default_corners)
 
list decCorners = dataclasses.field(default_factory=_default_corners)
 
float astromOffsetMean = float('nan')
 
float astromOffsetStd = float('nan')
 
int nPsfStar = 0
 
float psfStarDeltaE1Median = float('nan')
 
float psfStarDeltaE2Median = float('nan')
 
float psfStarDeltaE1Scatter = float('nan')
 
float psfStarDeltaE2Scatter = float('nan')
 
float psfStarDeltaSizeMedian = float('nan')
 
float psfStarDeltaSizeScatter = float('nan')
 
float psfStarScaledDeltaSizeScatter = float('nan')
 
float psfTraceRadiusDelta = float('nan')
 
float maxDistToNearestPsf = float('nan')
 
float effTime = float('nan')
 
float effTimePsfSigmaScale = float('nan')
 
float effTimeSkyBgScale = float('nan')
 
float effTimeZeroPointScale = float('nan')
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

 _getPersistenceName (self)
 
 _getPythonModule (self)
 
 _write (self)
 
virtual std::string getPersistenceName () const
 Return the unique name used to persist this object and look up its factory.
 
virtual std::string getPythonModule () const
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
 
virtual void write (OutputArchiveHandle &handle) const
 Write the object to one or more catalogs.
 

Static Protected Member Functions

 _read (bytes)
 
template<class T >
static bool singleClassEquals (T const &lhs, Storable const &rhs)
 Test if a Storable is of a particular class and equal to another object.
 

Static Protected Attributes

str _persistence_name = 'ExposureSummaryStats'
 
 _factory = StorableHelperFactory(__name__, _persistence_name)
 

Related Symbols

(Note that these are not member symbols.)

std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 Output operator for Storable.
 

Detailed Description

Definition at line 41 of file _exposureSummaryStats.py.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

Member Function Documentation

◆ __post_init__()

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.__post_init__ ( self)

Definition at line 144 of file _exposureSummaryStats.py.

◆ _getPersistenceName()

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._getPersistenceName ( self)
protected

Definition at line 150 of file _exposureSummaryStats.py.

◆ _getPythonModule()

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._getPythonModule ( self)
protected

Definition at line 153 of file _exposureSummaryStats.py.

◆ _read()

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._read ( bytes)
staticprotected

Definition at line 160 of file _exposureSummaryStats.py.

◆ _write()

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._write ( self)
protected

Definition at line 156 of file _exposureSummaryStats.py.

◆ cloneStorable()

std::shared_ptr< Storable > lsst::afw::typehandling::Storable::cloneStorable ( ) const
virtualinherited

Create a new object that is a copy of this one (optional operation).

This operation is required for Storables that are stored in GenericMap by value, but not for those stored by shared pointer.

Exceptions
UnsupportedOperationExceptionThrown if this object is not cloneable.
Note
If this class supports a clone operation, the two should behave identically except for the formal return type.
When called on Python classes, this method delegates to __deepcopy__ if it exists.

Reimplemented in lsst::afw::detection::Psf, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 36 of file Storable.cc.

◆ equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const & other) const
virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns
This implementation returns whether the two objects are the same.
Warning
This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.
See also
singleClassEquals
Note
When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::PhotoCalib, and lsst::afw::image::VisitInfo.

Definition at line 48 of file Storable.cc.

◆ from_record()

ExposureSummaryStats lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.from_record ( cls,
BaseRecord record )
Read summary-statistic columns from a record into ``self``.

Parameters
----------
record : `lsst.afw.table.BaseRecord`
    Record to read from.  This is expected to frequently be an
    `ExposureRecord` instance (with higher-level code adding other
    columns and objects), but this method can work with any record
    type, ignoring any attributes or columns it doesn't recognize.

Returns
-------
summary : `ExposureSummaryStats`
    Summary statistics object created from the given record.

Definition at line 390 of file _exposureSummaryStats.py.

◆ getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const
protectedvirtualinherited

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::afw::image::FilterLabel, lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 34 of file Persistable.cc.

◆ getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const
protectedvirtualinherited

◆ hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const
virtualinherited

Return a hash of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown if this object is not hashable.
Note
C++ subclass authors are responsible for any associated specializations of std::hash.
When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::image::FilterLabel, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 44 of file Storable.cc.

◆ isPersistable() [1/2]

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const
inlinevirtualnoexceptinherited

◆ isPersistable() [2/2]

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.isPersistable ( self)

Definition at line 147 of file _exposureSummaryStats.py.

◆ singleClassEquals()

template<class T >
static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const & lhs,
Storable const & rhs )
inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters
TThe class expected of the two objects to be compared.
Parameters
lhs,rhsThe objects to compare. Note that rhs need not be a T, while lhs must be.
Returns
true if rhs is a T and lhs == rhs; false otherwise.
Exception Safety
Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.
Note
This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

◆ toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const
virtualinherited

Create a string representation of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown if this object does not have a string representation.
Note
When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 40 of file Storable.cc.

◆ update_record()

None lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.update_record ( self,
BaseRecord record )
Write summary-statistic columns into a record.

Parameters
----------
record : `lsst.afw.table.BaseRecord`
    Record to update.  This is expected to frequently be an
    `ExposureRecord` instance (with higher-level code adding other
    columns and objects), but this method can work with any record
    type.

Definition at line 369 of file _exposureSummaryStats.py.

◆ update_schema()

None lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.update_schema ( cls,
Schema schema )
Update an schema to includes for all summary statistic fields.

Parameters
-------
schema : `lsst.afw.table.Schema`
    Schema to add which fields will be added.

Definition at line 189 of file _exposureSummaryStats.py.

◆ write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle & handle) const
protectedvirtualinherited

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented in lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::FixedKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, lsst::afw::image::FilterLabel, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 38 of file Persistable.cc.

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager & manager,
std::string const & mode = "w" ) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const & fileName,
std::string const & mode = "w" ) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

Friends And Related Symbol Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream & os,
Storable const & storable )
related

Output operator for Storable.

Parameters
osthe desired output stream
storablethe object to print
Returns
a reference to os
Exceptions
UnsupportedOperationExceptionThrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

Member Data Documentation

◆ _factory

lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._factory = StorableHelperFactory(__name__, _persistence_name)
staticprotected

Definition at line 44 of file _exposureSummaryStats.py.

◆ _persistence_name

str lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._persistence_name = 'ExposureSummaryStats'
staticprotected

Definition at line 42 of file _exposureSummaryStats.py.

◆ astromOffsetMean

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.astromOffsetMean = float('nan')
static

Definition at line 90 of file _exposureSummaryStats.py.

◆ astromOffsetStd

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.astromOffsetStd = float('nan')
static

Definition at line 93 of file _exposureSummaryStats.py.

◆ dec

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.dec = float('nan')
static

Definition at line 66 of file _exposureSummaryStats.py.

◆ decCorners

list lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.decCorners = dataclasses.field(default_factory=_default_corners)
static

Definition at line 87 of file _exposureSummaryStats.py.

◆ effTime

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTime = float('nan')
static

Definition at line 130 of file _exposureSummaryStats.py.

◆ effTimePsfSigmaScale

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimePsfSigmaScale = float('nan')
static

Definition at line 135 of file _exposureSummaryStats.py.

◆ effTimeSkyBgScale

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimeSkyBgScale = float('nan')
static

Definition at line 138 of file _exposureSummaryStats.py.

◆ effTimeZeroPointScale

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimeZeroPointScale = float('nan')
static

Definition at line 141 of file _exposureSummaryStats.py.

◆ maxDistToNearestPsf

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.maxDistToNearestPsf = float('nan')
static

Definition at line 125 of file _exposureSummaryStats.py.

◆ meanVar

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.meanVar = float('nan')
static

Definition at line 81 of file _exposureSummaryStats.py.

◆ nPsfStar

int lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.nPsfStar = 0
static

Definition at line 96 of file _exposureSummaryStats.py.

◆ psfArea

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfArea = float('nan')
static

Definition at line 51 of file _exposureSummaryStats.py.

◆ psfIxx

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIxx = float('nan')
static

Definition at line 54 of file _exposureSummaryStats.py.

◆ psfIxy

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIxy = float('nan')
static

Definition at line 60 of file _exposureSummaryStats.py.

◆ psfIyy

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIyy = float('nan')
static

Definition at line 57 of file _exposureSummaryStats.py.

◆ psfSigma

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfSigma = float('nan')
static

Definition at line 48 of file _exposureSummaryStats.py.

◆ psfStarDeltaE1Median

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE1Median = float('nan')
static

Definition at line 99 of file _exposureSummaryStats.py.

◆ psfStarDeltaE1Scatter

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE1Scatter = float('nan')
static

Definition at line 105 of file _exposureSummaryStats.py.

◆ psfStarDeltaE2Median

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE2Median = float('nan')
static

Definition at line 102 of file _exposureSummaryStats.py.

◆ psfStarDeltaE2Scatter

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE2Scatter = float('nan')
static

Definition at line 108 of file _exposureSummaryStats.py.

◆ psfStarDeltaSizeMedian

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaSizeMedian = float('nan')
static

Definition at line 111 of file _exposureSummaryStats.py.

◆ psfStarDeltaSizeScatter

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaSizeScatter = float('nan')
static

Definition at line 114 of file _exposureSummaryStats.py.

◆ psfStarScaledDeltaSizeScatter

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarScaledDeltaSizeScatter = float('nan')
static

Definition at line 117 of file _exposureSummaryStats.py.

◆ psfTraceRadiusDelta

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfTraceRadiusDelta = float('nan')
static

Definition at line 120 of file _exposureSummaryStats.py.

◆ ra

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.ra = float('nan')
static

Definition at line 63 of file _exposureSummaryStats.py.

◆ raCorners

list lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.raCorners = dataclasses.field(default_factory=_default_corners)
static

Definition at line 84 of file _exposureSummaryStats.py.

◆ skyBg

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.skyBg = float('nan')
static

Definition at line 75 of file _exposureSummaryStats.py.

◆ skyNoise

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.skyNoise = float('nan')
static

Definition at line 78 of file _exposureSummaryStats.py.

◆ version

int lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.version = 0
static

Definition at line 46 of file _exposureSummaryStats.py.

◆ zenithDistance

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.zenithDistance = float('nan')
static

Definition at line 69 of file _exposureSummaryStats.py.

◆ zeroPoint

float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.zeroPoint = float('nan')
static

Definition at line 72 of file _exposureSummaryStats.py.


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