Definition at line 37 of file _exposureSummaryStats.py.
◆ OutputArchiveHandle
◆ __post_init__()
def lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.__post_init__ |
( |
|
self | ) |
|
◆ 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::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::image::CoaddInputs, lsst::afw::image::ApCorrMap, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::detection::Psf.
Definition at line 36 of file Storable.cc.
◆ equals()
bool lsst::afw::typehandling::Storable::equals |
( |
Storable const & |
other | ) |
const |
|
virtualnoexceptinherited |
◆ 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::typehandling::StorableHelper< Base >, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.
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::typehandling::StorableHelper< Base >, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::Kernel, lsst::afw::math::Function< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::TransmissionCurve, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.
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::typehandling::StorableHelper< Base >, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::image::CoaddInputs, lsst::afw::image::ApCorrMap, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SpanSet, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::TransformMap, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Detector, and lsst::afw::cameraGeom::Camera.
Definition at line 102 of file Persistable.h.
◆ isPersistable() [2/2]
def 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 |
◆ 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::typehandling::StorableHelper< Base >, lsst::afw::image::FilterLabel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::math::FixedKernel, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::Camera, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, and lsst::afw::math::GaussianFunction2< ReturnT >.
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]
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] | 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.
◆ default_factory
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.default_factory |
|
static |
◆ float
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.float |
|
static |
◆ int
lsst.afw.image._exposureSummaryStats.ExposureSummaryStats.int |
|
static |
The documentation for this class was generated from the following file: