MatchBackgroundsTask

Python API summary

from lsst.pipe.tasks.matchBackgrounds import MatchBackgroundsTask

classMatchBackgroundsTask(*args, **kwargs)

Match the backgrounds of a list of warped exposures to a reference...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(warps, skyMap)

Match the backgrounds of a list of warped exposures to the same patches in a reference visit...

See also

See the MatchBackgroundsTask API reference for complete details.

Retargetable subtasks

reference

Default

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitTask

Field type

ConfigurableField

Choose reference visit to match backgrounds to

Configuration fields

connections

Data type

lsst.pipe.base.config.MatchBackgroundsConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

gridStatistic

Default

'MEANCLIP'

Field type

str ChoiceField (optional)

Choices

'MEAN'

mean

'MEDIAN'

median

'MEANCLIP'

clipped mean

None

Field is optional

Type of statistic to estimate pixel value for the grid points

interpStyle

Default

'AKIMA_SPLINE'

Field type

str ChoiceField (optional)

Choices

'CONSTANT'

Use a single constant value.

'LINEAR'

Use linear interpolation.

'NATURAL_SPLINE'

A cubic spline with zero second derivative at endpoints.

'AKIMA_SPLINE'

A higher-level non-linear spline that is more robust to outliers.

'NONE'

No background estimation is to be attempted.

None

Field is optional

Algorithm to interpolate the background values. Maps to an enum; see afw.math.Background for more information.

numIter

Default

3

Field type

int Field

Number of iterations of outlier rejection. Ignored if gridStatistic != 'MEANCLIP'.

numSigmaClip

Default

3

Field type

int Field

Sigma for outlier rejection. Ignored if gridStatistic != 'MEANCLIP'.

refWarpVisit

Default

None

Field type

int Field (optional)

Reference visit ID. If None, the best visit is chosen using the list of visits.

saveLogOutput

Default

True

Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

tractBgModel

Data type

lsst.pipe.tasks.tractBackground.TractBackgroundConfig

Field type

ConfigField

Background model for the entire tract

undersampleStyle

Default

'REDUCE_INTERP_ORDER'

Field type

str ChoiceField (optional)

Choices

'THROW_EXCEPTION'

throw an exception if there are too few points.

'REDUCE_INTERP_ORDER'

use an interpolation style with a lower order.

None

Field is optional

Behavior if there are too few points in the grid for requested interpolation style