BrightStarStamp

class lsst.meas.algorithms.BrightStarStamp(stamp_im: MaskedImageF, psf: Psf | None, wcs: SkyWcs | None, visit: int | None, detector: int | None, ref_id: int | None, ref_mag: float | None, position: Point2D | None, focal_plane_radius: float | None, focal_plane_angle: Angle | None, scale: float | None, scale_err: float | None, pedestal: float | None, pedestal_err: float | None, pedestal_scale_cov: float | None, gradient_x: float | None, gradient_y: float | None, global_reduced_chi_squared: float | None, global_degrees_of_freedom: int | None, psf_reduced_chi_squared: float | None, psf_degrees_of_freedom: int | None, psf_masked_flux_fraction: float | None)

Bases: AbstractStamp

A single postage stamp centered on a bright star.

Attributes:

stamp_imMaskedImageF

The pixel data for this stamp.

psfPsf, optional

The point-spread function for this star.

wcsSkyWcs, optional

World coordinate system associated with the stamp.

visitint, optional

Visit number of the observation.

detectorint, optional

Detector ID within the visit.

ref_idint, optional

Reference catalog ID of the star.

ref_magfloat, optional

Reference catalog magnitude of the star.

positionPoint2D, optional

Center position of the star on the detector in pixel coordinates.

focal_plane_radiusfloat, optional

Radial distance from the focal plane center in tangent-plane pixels.

focal_plane_angleAngle, optional

Azimuthal angle on the focal plane (counterclockwise from +X).

scalefloat, optional

Flux scaling factor applied to the PSF model.

scale_errfloat, optional

Error in the flux scale.

pedestalfloat, optional

Background pedestal level.

pedestal_errfloat, optional

Error on the pedestal.

pedestal_scale_covfloat, optional

Covariance between pedestal and scale.

gradient_xfloat, optional

Background gradient in the X direction.

gradient_yfloat, optional

Background gradient in the Y direction.

global_reduced_chi_squaredfloat, optional

Reduced chi-squared for the global model fit.

global_degrees_of_freedomint, optional

Degrees of freedom for the global model fit.

psf_reduced_chi_squaredfloat, optional

Reduced chi-squared for the PSF fit.

psf_degrees_of_freedomint, optional

Degrees of freedom for the PSF fit.

psf_masked_flux_fractionfloat, optional

Fraction of flux masked in the PSF.

Notes

This class is designed to be used with BrightStarStamps, which manages collections of these stamps and handles reading/writing them to FITS files. The factory class method provides a standard interface to construct instances from image data and metadata, while the _getMetadata method extracts metadata for storage in FITS headers.

Attributes Summary

metadata

Return the stamp's metadata as a PropertyList.

Methods Summary

factory(stamp_im, psf, wcs, metadata)

Construct a BrightStarStamp from image data and metadata.

Attributes Documentation

metadata

Return the stamp’s metadata as a PropertyList.

Methods Documentation

classmethod factory(stamp_im: MaskedImageF, psf: Psf | None, wcs: SkyWcs | None, metadata: PropertyList) → BrightStarStamp

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_imMaskedImageF

Masked image for the stamp.

psfPsf, optional

Point-spread function for the stamp.

wcsSkyWcs, optional

World coordinate system for the stamp.

metadataPropertyList

Metadata associated with the stamp, containing keys for all required attributes.

Returns:

brightStarStampBrightStarStamp

The constructed BrightStarStamp instance.