DescribeOptions

class lsst.images.DescribeOptions(brief=False, detail=False, exclude=frozenset({}))

Bases: object

Rendering options threaded through a tree of Report objects.

Options that apply to a single type only (such as the bbox understood by SkyProjection) are explicit keyword arguments on that type’s _describe instead of members here, so that this class stays meaningful at every level of a report tree.

Parameters:

• brief (bool, default: False)

• detail (bool, default: False)

• exclude (frozenset[str], default: frozenset())

Attributes Summary

brief	Whether to build only what repr and str read.
detail	Whether to include extras that are too expensive for a default report, such as per-plane set-pixel counts that must scan the mask.
exclude	Names of report elements a composite has already shown once at the top level, and which its children should therefore omit.

Methods Summary

for_child(*exclude)

Return the options a child report should be built with.

Attributes Documentation

brief: bool = False

Whether to build only what repr and str read.

When True, implementations skip children, tables, and any derived value that is expensive to compute. Which fields feed repr is governed by FieldRole, not by this flag.

detail: bool = False

Whether to include extras that are too expensive for a default report, such as per-plane set-pixel counts that must scan the mask.

exclude: frozenset[str] = frozenset({})

Names of report elements a composite has already shown once at the top level, and which its children should therefore omit.

Methods Documentation

for_child(*exclude)

Return the options a child report should be built with.

Parameters:

*exclude (str) – Names of report elements the child should omit because the parent displays them once at the top level. Replaces, rather than adds to, any exclude set on self.

Returns:

options – Options carrying this object’s brief and detail settings.

Return type:

DescribeOptions