Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage:

Public Member Functions
	__init__ (self, Image image, *, Image\|None variance=None, ExtendedPsfImageInfo\|None info=None, ExtendedPsfFit\|None fit=None, dict[str, MetadataValue]\|None metadata=None)

Image	image (self)

Image	variance (self)

Box	bbox (self)

UnitBase\|None	unit (self)

None	projection (self)

ExtendedPsfImageInfo	info (self)

ExtendedPsfFit	fit (self)

ExtendedPsfImage	__getitem__ (self, Box\|EllipsisType bbox)

None	__setitem__ (self, Box\|EllipsisType bbox, ExtendedPsfImage value)

str	__str__ (self)

ExtendedPsfImage	copy (self)

ExtendedPsfImageSerializationModel	serialize (self, OutputArchive[Any] archive)

Static Public Member Functions
ExtendedPsfImage	deserialize (ExtendedPsfImageSerializationModel[Any] model, InputArchive[Any] archive, *, Box\|None bbox=None)

Static Protected Member Functions
	P

Protected Attributes
Image	_image = image

Image	_variance = variance

ExtendedPsfImageInfo	_info = info

ExtendedPsfFit	_fit = fit

Detailed Description

A multi-plane image with data (image) and variance planes, and the
results of a profile fit to the image.

Parameters
----------
image : `~lsst.images.Image`
    The main image plane.
variance : `~lsst.images.Image`, optional
    The per-pixel uncertainty of the main image as an image of variance
    values. Must have the same bounding box as ``image`` if provided, and
    its units must be the square of ``image.unit`` or `None`.
    Values default to ``1.0``. Any attached projection is replaced
    (possibly by `None`).
info : `ExtendedPsfImageInfo`, optional
    Additional information about how the extended PSF image was
    constructed.
fit : `ExtendedPsfFit`, optional
    The results of a profile fit to the image.
metadata : `dict` [`str`, `MetadataValue`], optional
    Arbitrary flexible metadata to associate with the image.

Attributes
----------
image : `~lsst.images.Image`
    The main image plane.
variance : `~lsst.images.Image`
    The per-pixel uncertainty of the main image as an image of variance
    values.
bbox : `~lsst.images.Box`
    The bounding box shared by both image planes.
unit : `astropy.units.Unit` or `None`
    The units of the image plane, or `None` if the image is dimensionless.
projection : `None`
    The projection that maps the pixel grid to the sky. Always `None` for
    `ExtendedPsfImage`.
info : `ExtendedPsfImageInfo`
    Additional information about how the extended PSF image was
    constructed.
fit : `ExtendedPsfFit`
    The results of a profile fit to the image.

Definition at line 103 of file extended_psf_image.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.__init__	(		self,
		Image	image,
		*	,
		Image \| None	variance = None,
		ExtendedPsfImageInfo \| None	info = None,
		ExtendedPsfFit \| None	fit = None,
		dict[str, MetadataValue] \| None	metadata = None )

Definition at line 146 of file extended_psf_image.py.

Member Function Documentation

◆ getitem()

ExtendedPsfImage lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.__getitem__	(		self,
		Box \| EllipsisType	bbox )

Definition at line 223 of file extended_psf_image.py.

◆ setitem()

None lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.__setitem__	(		self,
		Box \| EllipsisType	bbox,
		ExtendedPsfImage	value )

Definition at line 237 of file extended_psf_image.py.

◆ str()

str lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.__str__ ( self )

Definition at line 241 of file extended_psf_image.py.

◆ bbox()

Box lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.bbox ( self )

The bounding box shared by both image planes (`Box`).

Definition at line 195 of file extended_psf_image.py.

◆ copy()

ExtendedPsfImage lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.copy ( self )

Deep-copy the profile image and metadata.

Definition at line 246 of file extended_psf_image.py.

◆ deserialize()

ExtendedPsfImage lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.deserialize	(	ExtendedPsfImageSerializationModel[Any]	model,
		InputArchive[Any]	archive,
		*	,
		Box \| None	bbox = None )

static

Deserialize an image from an input archive.

Parameters
----------
model
    A Pydantic model representation of the image, holding references
    to data stored in the archive.
archive
    Archive to read from.
bbox
    Bounding box of a subimage to read instead.

Definition at line 283 of file extended_psf_image.py.

◆ fit()

ExtendedPsfFit lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.fit ( self )

The results of a profile fit to the image.

Definition at line 219 of file extended_psf_image.py.

◆ image()

Image lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.image ( self )

The main image plane (`Image`).

Definition at line 185 of file extended_psf_image.py.

◆ info()

ExtendedPsfImageInfo lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.info ( self )

Additional information about the image (`ExtendedPsfImageInfo`).

Definition at line 214 of file extended_psf_image.py.

◆ P()

lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.P

staticprotected

Definition at line 301 of file extended_psf_image.py.

◆ projection()

None lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.projection ( self )

The projection that maps the pixel grid to the sky.

ExtendedPsfImage does not support attached projections,
so this always returns `None`.

Definition at line 205 of file extended_psf_image.py.

◆ serialize()

ExtendedPsfImageSerializationModel lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.serialize	(		self,
		OutputArchive[Any]	archive )

Serialize the Extended PSF image to an output archive.

Parameters
----------
archive
    Archive to write to.

Definition at line 258 of file extended_psf_image.py.

◆ unit()

UnitBase | None lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.unit ( self )

The units of the image plane (`astropy.units.Unit` | `None`).

Definition at line 200 of file extended_psf_image.py.

◆ variance()

Image lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage.variance ( self )

The variance plane (`Image`).

Definition at line 190 of file extended_psf_image.py.

Member Data Documentation

◆ _fit

ExtendedPsfFit lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage._fit = fit

protected

Definition at line 182 of file extended_psf_image.py.

◆ _image

Image lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage._image = image

protected

Definition at line 179 of file extended_psf_image.py.

◆ _info

ExtendedPsfImageInfo lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage._info = info

protected

Definition at line 181 of file extended_psf_image.py.

◆ _variance

Image lsst.pipe.tasks.extended_psf.extended_psf_image.ExtendedPsfImage._variance = variance

protected

Definition at line 180 of file extended_psf_image.py.

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

python/lsst/pipe/tasks/extended_psf/extended_psf_image.py

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getitem__()

◆ __setitem__()

◆ __str__()

◆ bbox()

◆ copy()

◆ deserialize()

◆ fit()

◆ image()

◆ info()

◆ P()

◆ projection()

◆ serialize()

◆ unit()

◆ variance()

Member Data Documentation

◆ _fit

◆ _image

◆ _info

◆ _variance

◆ init()

◆ getitem()

◆ setitem()

◆ str()