CoaddApCorrMapStacker

class lsst.cell_coadds.CoaddApCorrMapStacker(evaluation_point: Point2D, do_coadd_inverse_ap_corr: bool = True)

Bases: object

Online aperture correction map for a cell-based coadd.

This class is responsible for implementing the logic to coadd the aperture correction values and their uncertainties.

Parameters:

evaluation_pointPoint2D

The point at which the input aperture correction is evaluated.

do_coadd_inverse_ap_corrbool, optional

If True, the inverse aperture correction is applied to the coadd.

Notes

At least one of class variables are set dynamically the first time the add method is called on any instance of this class. This behavior is based on the practical assumption that all ApCorrMap instances will have the same set of field names during the entire processing. A schema is therefore not expected at the time of initialization.

Attributes Summary

ap_corr_names	Iterable of algorithm names that have aperture correction values.
do_coadd_inverse_ap_corr	If True, the inverse aperture correction is applied to the coadd.
evaluation_point	The point at which the aperture correction is evaluated.
final_ap_corr_map	Final coadded aperture correction map.
total_weight	The total weight of the aperture correction map.

Methods Summary

add(ap_corr_map, weight)

Add an aperture correction map to the coadd.

Attributes Documentation

ap_corr_names

Iterable of algorithm names that have aperture correction values.

do_coadd_inverse_ap_corr

If True, the inverse aperture correction is applied to the coadd.

evaluation_point

The point at which the aperture correction is evaluated.

final_ap_corr_map

Final coadded aperture correction map.

This should be called after all aperture correction maps have been added.

Raises:

RuntimeError

Raised if the total weight is zero.

total_weight

The total weight of the aperture correction map.

Methods Documentation

add(ap_corr_map: ApCorrMap, weight: float) → None

Add an aperture correction map to the coadd.

Parameters:

ap_corr_mapApCorrMap

The aperture correction map to add.

weightfloat

The weight to apply to the aperture correction map.

Raises:

RuntimeError

Raised if the keys in ap_corr_map do not end in “_instFlux” or “_instFluxErr”.

ValueError

Raised if the aperture correction value or its error is missing.