Inheritance diagram for lsst.meas.algorithms.brightStarStamps.BrightStarStamps:

Public Member Functions
	__init__ (self, Sequence[BrightStarStamp] brightStarStamps, PropertyList\|None metadata=None)

	__len__ (self)

	__getitem__ (self, index)

	__iter__ (self)

	metadata (self)

BrightStarStamps	readFits (cls, str filename)

BrightStarStamps	readFitsWithOptions (cls, str filename, PropertyList\|None options)

	writeFits (self, str filename)

BrightStarStamp	factory (cls, MaskedImageF stamp_im, Psf\|None psf, SkyWcs\|None wcs, PropertyList metadata)

Public Attributes
dict	by_ref_id = {stamp.ref_id: stamp for stamp in self}

Static Public Attributes
Psf	psf \| None

SkyWcs	wcs \| None

int	visit \| None

int	detector \| None

int	ref_id \| None

float	ref_mag \| None

Point2D	position \| None

float	focal_plane_radius \| None

Angle	focal_plane_angle \| None

float	scale \| None

float	scale_err \| None

float	pedestal \| None

float	pedestal_err \| None

float	pedestal_scale_cov \| None

float	gradient_x \| None

float	gradient_y \| None

float	global_reduced_chi_squared \| None

int	global_degrees_of_freedom \| None

float	psf_reduced_chi_squared \| None

int	psf_degrees_of_freedom \| None

float	psf_masked_flux_fraction \| None

Protected Member Functions
PropertyList	_getMetadata (self)

Protected Attributes
	_stamps = list(brightStarStamps)

	_metadata = PropertyList() if metadata is None else metadata.deepCopy()

Static Protected Attributes
dict	_metadata_attribute_map

Detailed Description

A collection of bright star stamps.

Parameters
----------
brightStarStamps : `Iterable` [`BrightStarStamp`]
    Collection of `BrightStarStamp` instances.
metadata : `~lsst.daf.base.PropertyList`, optional
    Global metadata associated with the collection.

Definition at line 230 of file brightStarStamps.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__init__	(		self,
		Sequence[BrightStarStamp]	brightStarStamps,
		PropertyList \| None	metadata = None )

Definition at line 241 of file brightStarStamps.py.

Member Function Documentation

◆ getitem()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__getitem__	(		self,
			index )

Definition at line 253 of file brightStarStamps.py.

◆ iter()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__iter__ ( self )

Definition at line 258 of file brightStarStamps.py.

◆ len()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__len__ ( self )

Definition at line 250 of file brightStarStamps.py.

◆ _getMetadata()

PropertyList lsst.meas.algorithms.brightStarStamps.BrightStarStamp._getMetadata ( self )

protectedinherited

Extract metadata from the stamp's attributes.

This method constructs a `PropertyList` containing metadata
extracted from the stamp's attributes. It is used when writing the
stamp to a FITS file to store relevant metadata in the FITS headers.

Returns
-------
metadata : `PropertyList`
    A `PropertyList` containing the metadata, or `None` if no
    metadata attributes are defined.

Definition at line 151 of file brightStarStamps.py.

◆ factory()

BrightStarStamp lsst.meas.algorithms.brightStarStamps.BrightStarStamp.factory	(		cls,
		MaskedImageF	stamp_im,
		Psf \| None	psf,
		SkyWcs \| None	wcs,
		PropertyList	metadata )

inherited

Construct a `BrightStarStamp` from image data and metadata.

This method provides a standard interface to create a `BrightStarStamp`
from its image data, PSF, WCS, and associated metadata.
It is used by the `BrightStarStamps.readFits` method to construct
individual bright star stamps from FITS files.

Parameters
----------
stamp_im : `~lsst.afw.image.MaskedImageF`
    Masked image for the stamp.
psf : `~lsst.afw.detection.Psf`, optional
    Point-spread function for the stamp.
wcs : `~lsst.afw.geom.SkyWcs`, optional
    World coordinate system for the stamp.
metadata : `PropertyList`
    Metadata associated with the stamp, containing keys for all
    required attributes.

Returns
-------
brightStarStamp : `BrightStarStamp`
    The constructed `BrightStarStamp` instance.

Reimplemented from lsst.meas.algorithms.stamps.AbstractStamp.

Definition at line 182 of file brightStarStamps.py.

◆ metadata()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.metadata ( self )

Return the collection's global metadata as a PropertyList.

Reimplemented from lsst.meas.algorithms.brightStarStamps.BrightStarStamp.

Definition at line 262 of file brightStarStamps.py.

◆ readFits()

BrightStarStamps lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFits	(		cls,
		str	filename )

Make a `BrightStarStamps` object from a FITS file.

Parameters
----------
filename : `str`
    Name of the FITS file to read.

Returns
-------
brightStarStamps : `BrightStarStamps`
    The constructed `BrightStarStamps` instance.

Definition at line 267 of file brightStarStamps.py.

◆ readFitsWithOptions()

BrightStarStamps lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFitsWithOptions	(		cls,
		str	filename,
		PropertyList \| None	options )

Make a `BrightStarStamps` object from a FITS file, with options.

Parameters
----------
filename : `str`
    Name of the FITS file to read.
options : `~lsst.daf.base.PropertyList`, optional
    Options for reading the FITS file. Not currently used.

Returns
-------
brightStarStamps : `BrightStarStamps`
    The constructed `BrightStarStamps` instance.

Definition at line 283 of file brightStarStamps.py.

◆ writeFits()

lsst.meas.algorithms.brightStarStamps.BrightStarStamps.writeFits	(		self,
		str	filename )

Write this `BrightStarStamps` object to a FITS file.

Parameters
----------
filename : `str`
    Name of the FITS file to write.

Definition at line 362 of file brightStarStamps.py.

Member Data Documentation

◆ _metadata

lsst.meas.algorithms.brightStarStamps.BrightStarStamps._metadata = PropertyList() if metadata is None else metadata.deepCopy()

protected

Definition at line 247 of file brightStarStamps.py.

◆ _metadata_attribute_map

dict lsst.meas.algorithms.brightStarStamps.BrightStarStamp._metadata_attribute_map

staticprotectedinherited

Initial value:

=  {
        "VISIT": "visit",
        "DETECTOR": "detector",
        "REF_ID": "ref_id",
        "REF_MAG": "ref_mag",
        "POSITION_X": "position.x",
        "POSITION_Y": "position.y",
        "FOCAL_PLANE_RADIUS": "focal_plane_radius",
        "FOCAL_PLANE_ANGLE_DEGREES": "focal_plane_angle",
        "SCALE": "scale",
        "SCALE_ERR": "scale_err",
        "PEDESTAL": "pedestal",
        "PEDESTAL_ERR": "pedestal_err",
        "PEDESTAL_SCALE_COV": "pedestal_scale_cov",
        "GRADIENT_X": "gradient_x",
        "GRADIENT_Y": "gradient_y",
        "GLOBAL_REDUCED_CHI_SQUARED": "global_reduced_chi_squared",
        "GLOBAL_DEGREES_OF_FREEDOM": "global_degrees_of_freedom",
        "PSF_REDUCED_CHI_SQUARED": "psf_reduced_chi_squared",
        "PSF_DEGREES_OF_FREEDOM": "psf_degrees_of_freedom",
        "PSF_MASKED_FLUX_FRACTION": "psf_masked_flux_fraction",
    }

Definition at line 128 of file brightStarStamps.py.

◆ _stamps

lsst.meas.algorithms.brightStarStamps.BrightStarStamps._stamps = list(brightStarStamps)

protected

Definition at line 246 of file brightStarStamps.py.

◆ by_ref_id

dict lsst.meas.algorithms.brightStarStamps.BrightStarStamps.by_ref_id = {stamp.ref_id: stamp for stamp in self}

Definition at line 248 of file brightStarStamps.py.

◆ detector

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.detector | None

staticinherited

Definition at line 108 of file brightStarStamps.py.

◆ focal_plane_angle

Angle lsst.meas.algorithms.brightStarStamps.BrightStarStamp.focal_plane_angle | None

staticinherited

Definition at line 113 of file brightStarStamps.py.

◆ focal_plane_radius

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.focal_plane_radius | None

staticinherited

Definition at line 112 of file brightStarStamps.py.

◆ global_degrees_of_freedom

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.global_degrees_of_freedom | None

staticinherited

Definition at line 122 of file brightStarStamps.py.

◆ global_reduced_chi_squared

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.global_reduced_chi_squared | None

staticinherited

Definition at line 121 of file brightStarStamps.py.

◆ gradient_x

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.gradient_x | None

staticinherited

Definition at line 119 of file brightStarStamps.py.

◆ gradient_y

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.gradient_y | None

staticinherited

Definition at line 120 of file brightStarStamps.py.

◆ pedestal

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.pedestal | None

staticinherited

Definition at line 116 of file brightStarStamps.py.

◆ pedestal_err

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.pedestal_err | None

staticinherited

Definition at line 117 of file brightStarStamps.py.

◆ pedestal_scale_cov

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.pedestal_scale_cov | None

staticinherited

Definition at line 118 of file brightStarStamps.py.

◆ position

Point2D lsst.meas.algorithms.brightStarStamps.BrightStarStamp.position | None

staticinherited

Definition at line 111 of file brightStarStamps.py.

◆ psf

Psf lsst.meas.algorithms.brightStarStamps.BrightStarStamp.psf | None

staticinherited

Definition at line 105 of file brightStarStamps.py.

◆ psf_degrees_of_freedom

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.psf_degrees_of_freedom | None

staticinherited

Definition at line 124 of file brightStarStamps.py.

◆ psf_masked_flux_fraction

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.psf_masked_flux_fraction | None

staticinherited

Definition at line 125 of file brightStarStamps.py.

◆ psf_reduced_chi_squared

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.psf_reduced_chi_squared | None

staticinherited

Definition at line 123 of file brightStarStamps.py.

◆ ref_id

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.ref_id | None

staticinherited

Definition at line 109 of file brightStarStamps.py.

◆ ref_mag

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.ref_mag | None

staticinherited

Definition at line 110 of file brightStarStamps.py.

◆ scale

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.scale | None

staticinherited

Definition at line 114 of file brightStarStamps.py.

◆ scale_err

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.scale_err | None

staticinherited

Definition at line 115 of file brightStarStamps.py.

◆ visit

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.visit | None

staticinherited

Definition at line 107 of file brightStarStamps.py.

◆ wcs

SkyWcs lsst.meas.algorithms.brightStarStamps.BrightStarStamp.wcs | None

staticinherited

Definition at line 106 of file brightStarStamps.py.

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

python/lsst/meas/algorithms/brightStarStamps.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getitem__()

◆ __iter__()

◆ __len__()

◆ _getMetadata()

◆ factory()

◆ metadata()

◆ readFits()

◆ readFitsWithOptions()

◆ writeFits()

Member Data Documentation

◆ _metadata

◆ _metadata_attribute_map

◆ _stamps

◆ by_ref_id

◆ detector

◆ focal_plane_angle

◆ focal_plane_radius

◆ global_degrees_of_freedom

◆ global_reduced_chi_squared

◆ gradient_x

◆ gradient_y

◆ pedestal

◆ pedestal_err

◆ pedestal_scale_cov

◆ position

◆ psf

◆ psf_degrees_of_freedom

◆ psf_masked_flux_fraction

◆ psf_reduced_chi_squared

◆ ref_id

◆ ref_mag

◆ scale

◆ scale_err

◆ visit

◆ wcs

◆ init()

◆ getitem()

◆ iter()

◆ len()