lsst.meas.algorithms g1581cd22ba+2a89f360ba
Loading...
Searching...
No Matches
lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask Class Reference
Inheritance diagram for lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask:

Public Member Functions

 __init__ (self, schema, **kwargs)
 
 run (self, *, exposure, catalog)
 

Public Attributes

str flux_name = name + "_instFlux"
 
str err_name = name + "_instFluxErr"
 
str flag_name = name + "_flag"
 
 schema = schema
 

Static Public Attributes

 ConfigClass = NormalizedCalibrationFluxConfig
 

Protected Member Functions

 _measure_aperture_correction (self, exposure, catalog)
 

Static Protected Attributes

str _DefaultName = "normalizedCalibrationFlux"
 

Detailed Description

Task to measure the normalized calibration flux.

Parameters
----------
schema : `lsst.afw.table.Schema`
    Schema for the input table; will be modified in place.
**kwargs : `dict`
    Additional kwargs to pass to lsst.pipe.base.Task.__init__()

Raises
------
NormalizedCalibrationFluxError
    Raised if there are not enough sources to calculate normalization.

Definition at line 123 of file normalizedCalibrationFlux.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.__init__ ( self,
schema,
** kwargs )

Definition at line 141 of file normalizedCalibrationFlux.py.

Member Function Documentation

◆ _measure_aperture_correction()

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask._measure_aperture_correction ( self,
exposure,
catalog )
protected
Internal method to do the aperture correction measurement.

This measures the aperture correction with the regular task,
and if that fails does a fallback median estimate.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure the normalized calibration flux is measured on.
    This is only used for the bounding box.
catalog : `lsst.afw.table.SourceCatalog`
    SourceCatalog containing measurements to be used to compute
    normalized calibration flux.

Returns
-------
ap_corr_field : `lsst.afw.math.ChebyshevBoundedField`
    Aperture correction field to normalize the calibration flux.
ap_corr_err_field : `lsst.afw.math.ChebyshevBoundedField`
    Aperture correction to adjust the calibration flux error.

Definition at line 272 of file normalizedCalibrationFlux.py.

◆ run()

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.run ( self,
* ,
exposure,
catalog )
Measure the Normalized calibration flux.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure the normalized calibration flux is measured on.
catalog : `lsst.afw.table.SourceCatalog`
    SourceCatalog containing measurements to be used to compute
    normalized calibration fluxes.  The catalog is modified in-place.

Returns
-------
Struct : `lsst.pipe.base.Struct`
    Contains the following:

    ``ap_corr_map``
        aperture correction map (`lsst.afw.image.ApCorrMap`)
        that contains two entries for the raw flux field:
        - flux field (e.g. config.{raw_calibflux_name}_instFlux): 2d model
        - flux sigma field (e.g. config.{raw_calibflux_name}_instFluxErr): 0 field

Definition at line 181 of file normalizedCalibrationFlux.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask._DefaultName = "normalizedCalibrationFlux"
staticprotected

Definition at line 139 of file normalizedCalibrationFlux.py.

◆ ConfigClass

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.ConfigClass = NormalizedCalibrationFluxConfig
static

Definition at line 138 of file normalizedCalibrationFlux.py.

◆ err_name

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.err_name = name + "_instFluxErr"

Definition at line 159 of file normalizedCalibrationFlux.py.

◆ flag_name

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.flag_name = name + "_flag"

Definition at line 166 of file normalizedCalibrationFlux.py.

◆ flux_name

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.flux_name = name + "_instFlux"

Definition at line 152 of file normalizedCalibrationFlux.py.

◆ schema

lsst.meas.algorithms.normalizedCalibrationFlux.NormalizedCalibrationFluxTask.schema = schema

Definition at line 179 of file normalizedCalibrationFlux.py.


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