DescribableMixin

class lsst.images.DescribableMixin

Bases: object

Mixin that wires repr, str, rich, and HTML rendering to _describe.

Methods Summary

describe(*[, brief, detail, exclude])

Return a Report describing this object.

Methods Documentation

describe(*, brief=False, detail=False, exclude=())

Return a Report describing this object.

Parameters:

• brief (bool, optional) – Whether to build only what repr and str read.

• detail (bool, optional) – Whether to include extras that are too expensive for a default report, such as per-plane set-pixel counts.

• exclude (Collection [str], optional) – Names of report elements to omit.

Returns:

report – Report describing this object.

Return type:

Report