compare_mask_to_legacy

lsst.images.tests.compare_mask_to_legacy(mask, legacy_mask, plane_map=None, *, label='mask')

Compare a Mask object to a legacy lsst.afw.image.Mask object.

Parameters:

• mask (Mask) – Mask to compare.

• legacy_mask (Any) – Legacy lsst.afw.image.Mask to compare against.

• plane_map (Mapping[str, MaskPlane] | None, default: None) – Mapping from legacy plane name to the new mask plane; defaults to the planes in mask.schema. Schema planes the map does not name are compared under their own names. A plane the legacy mask does not define must have no pixels set in mask.

• label (str, default: 'mask') – Prefix for the failure message; each plane is reported as "{label}[<plane>]".

Return type:

None