lsst.ip.diffim  22.0.1-24-g1ad7a390+a9625a72a8
Static Public Attributes | List of all members
lsst.ip.diffim.zogy.ZogyConfig Class Reference
Inheritance diagram for lsst.ip.diffim.zogy.ZogyConfig:

Static Public Attributes

 templateFluxScaling
 
 scienceFluxScaling
 
 scaleByCalibration
 
 correctBackground
 
 ignoreMaskPlanes
 
 maxPsfCentroidDist
 
 doSpatialGrid
 
 gridInnerSize
 

Detailed Description

Configuration parameters for the ZogyTask

Definition at line 72 of file zogy.py.

Member Data Documentation

◆ correctBackground

lsst.ip.diffim.zogy.ZogyConfig.correctBackground
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Subtract exposure background mean to have zero expectation value."
)

Definition at line 95 of file zogy.py.

◆ doSpatialGrid

lsst.ip.diffim.zogy.ZogyConfig.doSpatialGrid
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Split the exposure and perform matching with the spatially varying PSF."
)

Definition at line 111 of file zogy.py.

◆ gridInnerSize

lsst.ip.diffim.zogy.ZogyConfig.gridInnerSize
static
Initial value:
= pexConfig.Field(
dtype=float,
default=8,
doc="Approximate useful inner size of the grid cells in units of the "
"estimated matching kernel size (doSpatialGrid=True only)."
)

Definition at line 116 of file zogy.py.

◆ ignoreMaskPlanes

lsst.ip.diffim.zogy.ZogyConfig.ignoreMaskPlanes
static
Initial value:
= pexConfig.ListField(
dtype=str,
default=("INTRP", "EDGE", "DETECTED", "SAT", "CR", "BAD", "NO_DATA", "DETECTED_NEGATIVE"),
doc="Mask planes to ignore for statistics"
)

Definition at line 101 of file zogy.py.

◆ maxPsfCentroidDist

lsst.ip.diffim.zogy.ZogyConfig.maxPsfCentroidDist
static
Initial value:
= pexConfig.Field(
dtype=float,
default=0.2,
doc="Maximum centroid difference allowed between the two exposure PSFs (pixels)."
)

Definition at line 106 of file zogy.py.

◆ scaleByCalibration

lsst.ip.diffim.zogy.ZogyConfig.scaleByCalibration
static
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Compute the flux normalization scaling based on the image calibration."
"This overrides 'templateFluxScaling' and 'scienceFluxScaling'."
)

Definition at line 88 of file zogy.py.

◆ scienceFluxScaling

lsst.ip.diffim.zogy.ZogyConfig.scienceFluxScaling
static
Initial value:
= pexConfig.Field(
dtype=float,
default=1.,
doc="Science flux scaling factor (Fn in ZOGY paper)"
)

Definition at line 82 of file zogy.py.

◆ templateFluxScaling

lsst.ip.diffim.zogy.ZogyConfig.templateFluxScaling
static
Initial value:
= pexConfig.Field(
dtype=float,
default=1.,
doc="Template flux scaling factor (Fr in ZOGY paper)"
)

Definition at line 76 of file zogy.py.


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