Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask:

Public Member Functions
	runQuantum (self, butlerQC, inputRefs, outputRefs)

	run (self, ExposureF input_exposure, BackgroundList input_background, SourceCatalog input_source_catalog, ReferenceObjectLoader ref_obj_loader)

Static Public Attributes
	ConfigClass = ExtendedPsfCutoutConfig

Protected Member Functions
Table	_get_extended_psf_candidate_table (self, ReferenceObjectLoader ref_obj_loader, ExposureF input_exposure)

ExtendedPsfCandidates\|None	_get_extended_psf_candidates (self, ExposureF input_exposure, BackgroundList\|None input_background, SourceCatalog\|np.ndarray footprints, Table extended_psf_candidate_table)

Static Protected Attributes
str	_DefaultName = "extendedPsfCutout"

Detailed Description

Extract extended PSF cutouts, and warp to the same pixel grid.

The ExtendedPsfCutoutTask is used to extract, process, and store small
image cutouts around stars.
This task essentially consists of two principal steps.
First, it identifies stars within an exposure using a reference
catalog and extracts a cutout around each.
Second, it shifts and warps each cutout to remove optical distortions and
sample all stars on the same pixel grid.

Definition at line 191 of file extended_psf_cutout.py.

Member Function Documentation

◆ _get_extended_psf_candidate_table()

Table lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask._get_extended_psf_candidate_table	(		self,
		ReferenceObjectLoader	ref_obj_loader,
		ExposureF	input_exposure )

protected

Get a table of extended PSF candidates from the reference catalog.

Trim the reference catalog to only those objects within the exposure
bounding box.
Then, select stars based on the specified magnitude range,
isolation criteria, and optionally focal plane radius criteria.
Finally, add columns with pixel coordinates and focal plane coordinates
for each extended PSF candidate.

Parameters
----------
ref_obj_loader : `~lsst.meas.algorithms.ReferenceObjectLoader`
    Loader to find objects within a reference catalog.
input_exposure : `~lsst.afw.image.ExposureF`
    The exposure for which extended PSF candidates are being selected.

Returns
-------
extended_psf_candidate_table : `~astropy.table.Table`
    Table of extended PSF candidates within the exposure.

Definition at line 259 of file extended_psf_cutout.py.

◆ _get_extended_psf_candidates()

ExtendedPsfCandidates \| None lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask._get_extended_psf_candidates	(		self,
		ExposureF	input_exposure,
		BackgroundList \| None	input_background,
		SourceCatalog \| np.ndarray	footprints,
		Table	extended_psf_candidate_table )

protected

Extract and warp extended PSF candidate cutouts.

For each extended PSF candidate, extract a cutout from the input
exposure centered on the candidate's pixel coordinates.
Then, shift and warp the cutout to recenter on the candidate and align
each to the same orientation.
Finally, check the fraction of the cutout area that is masked
(e.g. due to neighboring sources or bad pixels), and only retain those
with sufficient unmasked area.

Parameters
----------
input_exposure : `~lsst.afw.image.ExposureF`
    The science image to extract extended PSF cutouts.
input_background : `~lsst.afw.math.BackgroundList` | None
    The background model associated with the input exposure.
    If provided, this will be added back on to the input image.
footprints : `~lsst.afw.table.SourceCatalog` | `numpy.ndarray`
    The source catalog containing footprints on the input exposure, or
    a 2D numpy array with the same dimensions as the input exposure
    where each pixel value corresponds to the source footprint ID.
extended_psf_candidate_table : `~astropy.table.Table`
    Table of extended PSF candidates for which to extract cutouts.

Returns
-------
extended_psf_candidates :
        `~lsst.pipe.tasks.extendedPsf.ExtendedPsfCandidates` | None
    A set of cutouts, each centered on an extended PSF candidate.
    If no cutouts are retained post-masking, returns `None`.

Definition at line 368 of file extended_psf_cutout.py.

◆ run()

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask.run	(		self,
		ExposureF	input_exposure,
		BackgroundList	input_background,
		SourceCatalog	input_source_catalog,
		ReferenceObjectLoader	ref_obj_loader )

Identify stars within an exposure using a reference catalog,
extract cutouts around each and warp/shift cutouts onto a common frame.

Parameters
----------
input_exposure : `~lsst.afw.image.ExposureF`
    The background-subtracted image to extract cutouts around stars.
input_background : `~lsst.afw.math.BackgroundList`
    The background model associated with the input exposure.
input_source_catalog : `~lsst.afw.table.SourceCatalog`
    The source catalog containing footprints on the input exposure.
ref_obj_loader : `~lsst.meas.algorithms.ReferenceObjectLoader`
    Loader to find objects within a reference catalog.

Returns
-------
extended_psf_candidates :
        `~lsst.pipe.tasks.extendedPsf.ExtendedPsfCandidates`
    A set of cutouts, each centered on an extended PSF candidate.

Definition at line 221 of file extended_psf_cutout.py.

◆ runQuantum()

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask.runQuantum	(	self,
		butlerQC,
		inputRefs,
		outputRefs )

Definition at line 207 of file extended_psf_cutout.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask._DefaultName = "extendedPsfCutout"

staticprotected

Definition at line 204 of file extended_psf_cutout.py.

◆ ConfigClass

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutTask.ConfigClass = ExtendedPsfCutoutConfig

static

Definition at line 203 of file extended_psf_cutout.py.

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes