lsst.pipe.tasks  21.0.0-125-g25893231+6d8227318b
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.interpImage.InterpImageConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.interpImage.InterpImageConfig:

Public Member Functions

def validate (self)
 

Static Public Attributes

 modelPsf = measAlg.GaussianPsfFactory.makeField(doc="Model Psf factory")
 
 useFallbackValueAtEdge
 
 fallbackValueType
 
 fallbackUserValue
 
 negativeFallbackAllowed
 
 transpose
 

Detailed Description

Config for InterpImageTask

Definition at line 34 of file interpImage.py.

Member Function Documentation

◆ validate()

def lsst.pipe.tasks.interpImage.InterpImageConfig.validate (   self)

Definition at line 70 of file interpImage.py.

Member Data Documentation

◆ fallbackUserValue

lsst.pipe.tasks.interpImage.InterpImageConfig.fallbackUserValue
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="If fallbackValueType is 'USER' then use this as the fallbackValue; ignored otherwise",
default=0.0,
)

Definition at line 55 of file interpImage.py.

◆ fallbackValueType

lsst.pipe.tasks.interpImage.InterpImageConfig.fallbackValueType
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of statistic to calculate edge fallbackValue for interpolation",
allowed={
"MEAN": "mean",
"MEDIAN": "median",
"MEANCLIP": "clipped mean",
"USER": "user value set in fallbackUserValue config",
},
default="MEDIAN",
)

Definition at line 44 of file interpImage.py.

◆ modelPsf

lsst.pipe.tasks.interpImage.InterpImageConfig.modelPsf = measAlg.GaussianPsfFactory.makeField(doc="Model Psf factory")
static

Definition at line 37 of file interpImage.py.

◆ negativeFallbackAllowed

lsst.pipe.tasks.interpImage.InterpImageConfig.negativeFallbackAllowed
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Allow negative values for egde interpolation fallbackValue? If False, set "
"fallbackValue to max(fallbackValue, 0.0)"),
default=False,
)

Definition at line 60 of file interpImage.py.

◆ transpose

lsst.pipe.tasks.interpImage.InterpImageConfig.transpose
static
Initial value:
= pexConfig.Field(dtype=int, default=False,
doc="Transpose image before interpolating? "
"This allows the interpolation to act over columns instead of rows.")

Definition at line 66 of file interpImage.py.

◆ useFallbackValueAtEdge

lsst.pipe.tasks.interpImage.InterpImageConfig.useFallbackValueAtEdge
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Smoothly taper to the fallback value at the edge of the image?",
default=True,
)

Definition at line 39 of file interpImage.py.


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