Inheritance diagram for lsst.afw.image._exposureSummaryStats.ExposureSummaryStats:

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< Storable >	cloneStorable () 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::ostream &	operator<< (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.

    def __post_init__(self):
        Storable.__init__(self)
 

◆ _getPersistenceName()

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

protected

Definition at line 150 of file _exposureSummaryStats.py.

    def _getPersistenceName(self):
        return self._persistence_name
 

◆ _getPythonModule()

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

protected

Definition at line 153 of file _exposureSummaryStats.py.

    def _getPythonModule(self):
        return __name__
 

◆ _read()

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

staticprotected

Definition at line 160 of file _exposureSummaryStats.py.

    def _read(bytes):
        yamlDict = yaml.load(bytes, Loader=yaml.SafeLoader)
 
        # Special list of fields to forward to new names.
        forwardFieldDict = {"decl": "dec"}
 
        # For forwards compatibility, filter out any fields that are
        # not defined in the dataclass.
        droppedFields = []
        for _field in list(yamlDict.keys()):
            if _field not in ExposureSummaryStats.__dataclass_fields__:
                if _field in forwardFieldDict and forwardFieldDict[_field] not in yamlDict:
                    yamlDict[forwardFieldDict[_field]] = yamlDict[_field]
                else:
                    droppedFields.append(_field)
                yamlDict.pop(_field)
        if len(droppedFields) > 0:
            droppedFieldString = ", ".join([str(f) for f in droppedFields])
            plural = "s" if len(droppedFields) != 1 else ""
            them = "them" if len(droppedFields) > 1 else "it"
            warnings.warn(
                f"Summary field{plural} [{droppedFieldString}] not recognized by this software version;"
                f" ignoring {them}.",
                FutureWarning,
                stacklevel=2,
            )
        return ExposureSummaryStats(**yamlDict)
 

◆ _write()

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

protected

Definition at line 156 of file _exposureSummaryStats.py.

    def _write(self):
        return yaml.dump(dataclasses.asdict(self), encoding='utf-8')
 

◆ 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

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.

                                                      {
    throw LSST_EXCEPT(UnsupportedOperationException, "Cloning is not supported.");
}

◆ 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.

48{ return this == &other; }

◆ 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.

    def from_record(cls, record: BaseRecord) -> ExposureSummaryStats:
        """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.
        """
        return cls(
            **{
                field.name: (
                    record[field.name] if not field.type.startswith("list")
                    else [float(v) for v in record[field.name]]
                )
                for field in dataclasses.fields(cls)
                if field.name != "version"
            }
        )

◆ 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, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::PcaPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 34 of file Persistable.cc.

34{ return std::string(); }

std::string

◆ 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< double >, 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, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 36 of file Persistable.cc.

36{ return std::string(); }

◆ hash_value()

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

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException Thrown 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.

                                     {
    throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
}

◆ 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, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 102 of file Persistable.h.

102{ return false; }

◆ isPersistable() [2/2]

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

Definition at line 147 of file _exposureSummaryStats.py.

    def isPersistable(self):
        return True
 

◆ 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.

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

◆ toString()

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

virtualinherited

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

Exceptions

UnsupportedOperationException Thrown 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.

                                   {
    throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
}

◆ 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.

    def update_record(self, record: BaseRecord) -> None:
        """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.
        """
        for field in dataclasses.fields(self):
            value = getattr(self, field.name)
            if field.name == "version":
                continue
            elif field.type.startswith("list"):
                record[field.name][:] = value
            else:
                record[field.name] = value
 

◆ 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.

    def update_schema(cls, schema: Schema) -> None:
        """Update an schema to includes for all summary statistic fields.
 
        Parameters
        -------
        schema : `lsst.afw.table.Schema`
            Schema to add which fields will be added.
        """
        schema.addField(
            "psfSigma",
            type="F",
            doc="PSF model second-moments determinant radius (center of chip) (pixel)",
            units="pixel",
        )
        schema.addField(
            "psfArea",
            type="F",
            doc="PSF model effective area (center of chip) (pixel**2)",
            units='pixel**2',
        )
        schema.addField(
            "psfIxx",
            type="F",
            doc="PSF model Ixx (center of chip) (pixel**2)",
            units='pixel**2',
        )
        schema.addField(
            "psfIyy",
            type="F",
            doc="PSF model Iyy (center of chip) (pixel**2)",
            units='pixel**2',
        )
        schema.addField(
            "psfIxy",
            type="F",
            doc="PSF model Ixy (center of chip) (pixel**2)",
            units='pixel**2',
        )
        schema.addField(
            "raCorners",
            type="ArrayD",
            size=4,
            doc="Right Ascension of bounding box corners (degrees)",
            units="degree",
        )
        schema.addField(
            "decCorners",
            type="ArrayD",
            size=4,
            doc="Declination of bounding box corners (degrees)",
            units="degree",
        )
        schema.addField(
            "ra",
            type="D",
            doc="Right Ascension of bounding box center (degrees)",
            units="degree",
        )
        schema.addField(
            "dec",
            type="D",
            doc="Declination of bounding box center (degrees)",
            units="degree",
        )
        schema.addField(
            "zenithDistance",
            type="F",
            doc="Zenith distance of bounding box center (degrees)",
            units="degree",
        )
        schema.addField(
            "zeroPoint",
            type="F",
            doc="Mean zeropoint in detector (mag)",
            units="mag",
        )
        schema.addField(
            "skyBg",
            type="F",
            doc="Average sky background (ADU)",
            units="adu",
        )
        schema.addField(
            "skyNoise",
            type="F",
            doc="Average sky noise (ADU)",
            units="adu",
        )
        schema.addField(
            "meanVar",
            type="F",
            doc="Mean variance of the weight plane (ADU**2)",
            units="adu**2"
        )
        schema.addField(
            "astromOffsetMean",
            type="F",
            doc="Mean offset of astrometric calibration matches (arcsec)",
            units="arcsec",
        )
        schema.addField(
            "astromOffsetStd",
            type="F",
            doc="Standard deviation of offsets of astrometric calibration matches (arcsec)",
            units="arcsec",
        )
        schema.addField("nPsfStar", type="I", doc="Number of stars used for PSF model")
        schema.addField(
            "psfStarDeltaE1Median",
            type="F",
            doc="Median E1 residual (starE1 - psfE1) for psf stars",
        )
        schema.addField(
            "psfStarDeltaE2Median",
            type="F",
            doc="Median E2 residual (starE2 - psfE2) for psf stars",
        )
        schema.addField(
            "psfStarDeltaE1Scatter",
            type="F",
            doc="Scatter (via MAD) of E1 residual (starE1 - psfE1) for psf stars",
        )
        schema.addField(
            "psfStarDeltaE2Scatter",
            type="F",
            doc="Scatter (via MAD) of E2 residual (starE2 - psfE2) for psf stars",
        )
        schema.addField(
            "psfStarDeltaSizeMedian",
            type="F",
            doc="Median size residual (starSize - psfSize) for psf stars (pixel)",
            units="pixel",
        )
        schema.addField(
            "psfStarDeltaSizeScatter",
            type="F",
            doc="Scatter (via MAD) of size residual (starSize - psfSize) for psf stars (pixel)",
            units="pixel",
        )
        schema.addField(
            "psfStarScaledDeltaSizeScatter",
            type="F",
            doc="Scatter (via MAD) of size residual scaled by median size squared",
        )
        schema.addField(
            "psfTraceRadiusDelta",
            type="F",
            doc="Delta (max - min) of the model psf trace radius values evaluated on a grid of "
            "unmasked pixels (pixel).",
            units="pixel",
        )
        schema.addField(
            "maxDistToNearestPsf",
            type="F",
            doc="Maximum distance of an unmasked pixel to its nearest model psf star (pixel).",
            units="pixel",
        )
        schema.addField(
            "effTime",
            type="F",
            doc="Effective exposure time calculated from psfSigma, skyBg, and "
            "zeroPoint (seconds).",
            units="second",
        )
        schema.addField(
            "effTimePsfSigmaScale",
            type="F",
            doc="PSF scaling of the effective exposure time."
        )
        schema.addField(
            "effTimeSkyBgScale",
            type="F",
            doc="Sky background scaling of the effective exposure time."
        )
        schema.addField(
            "effTimeZeroPointScale",
            type="F",
            doc="Zeropoint scaling of the effective exposure time."
        )
 

◆ 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::meas::extensions::psfex::PsfexPsf, 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::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::modelfit::Mixture, lsst::afw::image::FilterLabel, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 38 of file Persistable.cc.

                                                   {
    assert(!isPersistable());
    throw LSST_EXCEPT(pex::exceptions::LogicError,
                      "afw::table-based persistence is not supported for this object.");
}

◆ 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.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

◆ 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]	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.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

◆ 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.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

Friends And Related Symbol Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		Storable const &	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.

                                                                        {
    return os << storable.toString();
}

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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/image/_exposureSummaryStats.py

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Related Symbols

Detailed Description

Member Typedef Documentation

◆ OutputArchiveHandle

Member Function Documentation

◆ __post_init__()

◆ _getPersistenceName()

◆ _getPythonModule()

◆ _read()

◆ _write()

◆ cloneStorable()

◆ equals()

◆ from_record()

◆ getPersistenceName()

◆ getPythonModule()

◆ hash_value()

◆ isPersistable() [1/2]

◆ isPersistable() [2/2]

◆ singleClassEquals()

◆ toString()

◆ update_record()

◆ update_schema()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Friends And Related Symbol Documentation

◆ operator<<()

Member Data Documentation

◆ _factory

◆ _persistence_name

◆ astromOffsetMean

◆ astromOffsetStd

◆ dec

◆ decCorners

◆ effTime

◆ effTimePsfSigmaScale

◆ effTimeSkyBgScale

◆ effTimeZeroPointScale

◆ maxDistToNearestPsf

◆ meanVar

◆ nPsfStar

◆ psfArea

◆ psfIxx

◆ psfIxy

◆ psfIyy

◆ psfSigma

◆ psfStarDeltaE1Median

◆ psfStarDeltaE1Scatter

◆ psfStarDeltaE2Median

◆ psfStarDeltaE2Scatter

◆ psfStarDeltaSizeMedian

◆ psfStarDeltaSizeScatter

◆ psfStarScaledDeltaSizeScatter

◆ psfTraceRadiusDelta

◆ ra

◆ raCorners

◆ skyBg

◆ skyNoise

◆ version

◆ zenithDistance

◆ zeroPoint