Definition at line 41 of file _exposureSummaryStats.py.
◆ OutputArchiveHandle
◆ __post_init__()
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.__post_init__ |
( |
| self | ) |
|
◆ _getPersistenceName()
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._getPersistenceName |
( |
| self | ) |
|
|
protected |
◆ _getPythonModule()
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._getPythonModule |
( |
| self | ) |
|
|
protected |
◆ _read()
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._read |
( |
| bytes | ) |
|
|
staticprotected |
◆ _write()
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._write |
( |
| self | ) |
|
|
protected |
◆ cloneStorable()
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
-
UnsupportedOperationException | Thrown 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()
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 |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.
Will be ignored if empty.
Reimplemented in lsst::afw::image::FilterLabel, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, 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::TransmissionCurve, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::Function< Kernel::Pixel >, lsst::afw::math::Function< Pixel >, lsst::afw::math::Function< ReturnT >, lsst::afw::math::Kernel, 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 36 of file Persistable.cc.
◆ hash_value()
std::size_t lsst::afw::typehandling::Storable::hash_value |
( |
| ) |
const |
|
virtualinherited |
◆ isPersistable() [1/2]
virtual bool lsst::afw::table::io::Persistable::isPersistable |
( |
| ) |
const |
|
inlinevirtualnoexceptinherited |
Return true if this particular object can be persisted using afw::table::io.
Reimplemented in 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::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::FilterLabel, 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 102 of file Persistable.h.
◆ isPersistable() [2/2]
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.isPersistable |
( |
| self | ) |
|
◆ 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
-
T | The class expected of the two objects to be compared. |
- Parameters
-
lhs,rhs | The 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 |
◆ 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()
|
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] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
◆ writeFits() [2/3]
Write the object to a FITS image in memory.
- Parameters
-
[in] | manager | Name of the file to write to. |
[in] | mode | If "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]
Write the object to a regular FITS file.
- Parameters
-
[in] | fileName | Name of the file to write to. |
[in] | mode | If "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.
◆ operator<<()
Output operator for Storable.
- Parameters
-
os | the desired output stream |
storable | the object to print |
- Returns
- a reference to
os
- Exceptions
-
UnsupportedOperationException | Thrown if storable does not have an implementation of Storable::toString. |
Definition at line 174 of file Storable.h.
◆ _factory
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._factory = StorableHelperFactory(__name__, _persistence_name) |
|
staticprotected |
◆ _persistence_name
str lsst.afw.image._exposureSummaryStats.ExposureSummaryStats._persistence_name = 'ExposureSummaryStats' |
|
staticprotected |
◆ astromOffsetMean
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.astromOffsetMean = float('nan') |
|
static |
◆ astromOffsetStd
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.astromOffsetStd = float('nan') |
|
static |
◆ dec
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.dec = float('nan') |
|
static |
◆ decCorners
list lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.decCorners = dataclasses.field(default_factory=_default_corners) |
|
static |
◆ effTime
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTime = float('nan') |
|
static |
◆ effTimePsfSigmaScale
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimePsfSigmaScale = float('nan') |
|
static |
◆ effTimeSkyBgScale
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimeSkyBgScale = float('nan') |
|
static |
◆ effTimeZeroPointScale
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.effTimeZeroPointScale = float('nan') |
|
static |
◆ maxDistToNearestPsf
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.maxDistToNearestPsf = float('nan') |
|
static |
◆ meanVar
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.meanVar = float('nan') |
|
static |
◆ nPsfStar
int lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.nPsfStar = 0 |
|
static |
◆ psfArea
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfArea = float('nan') |
|
static |
◆ psfIxx
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIxx = float('nan') |
|
static |
◆ psfIxy
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIxy = float('nan') |
|
static |
◆ psfIyy
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfIyy = float('nan') |
|
static |
◆ psfSigma
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfSigma = float('nan') |
|
static |
◆ psfStarDeltaE1Median
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE1Median = float('nan') |
|
static |
◆ psfStarDeltaE1Scatter
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE1Scatter = float('nan') |
|
static |
◆ psfStarDeltaE2Median
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE2Median = float('nan') |
|
static |
◆ psfStarDeltaE2Scatter
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaE2Scatter = float('nan') |
|
static |
◆ psfStarDeltaSizeMedian
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaSizeMedian = float('nan') |
|
static |
◆ psfStarDeltaSizeScatter
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarDeltaSizeScatter = float('nan') |
|
static |
◆ psfStarScaledDeltaSizeScatter
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfStarScaledDeltaSizeScatter = float('nan') |
|
static |
◆ psfTraceRadiusDelta
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.psfTraceRadiusDelta = float('nan') |
|
static |
◆ ra
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.ra = float('nan') |
|
static |
◆ raCorners
list lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.raCorners = dataclasses.field(default_factory=_default_corners) |
|
static |
◆ skyBg
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.skyBg = float('nan') |
|
static |
◆ skyNoise
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.skyNoise = float('nan') |
|
static |
◆ version
int lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.version = 0 |
|
static |
◆ zenithDistance
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.zenithDistance = float('nan') |
|
static |
◆ zeroPoint
float lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.zeroPoint = float('nan') |
|
static |
The documentation for this class was generated from the following file: