field_from_legacy_background#

lsst.images.fields.field_from_legacy_background(legacy_background, bounds=None, unit=None)#

Convert a legacy lsst.afw.math.Background or lsst.afw.math.BackgroundList instance to a BaseField object.

Parameters:
  • legacy_background (TypeAliasType | TypeAliasType) – Legacy background object to convert.

  • bounds (Bounds | None, default: None) – The bounds of the returned field, if they should be different from the bounding box of legacy_background.

  • unit (UnitBase | None, default: None) – The units of the returned field (lsst.afw.math.Background objects do not know their units).

Return type:

TypeAliasType

This page was last modified on .