FrameSet

class lsst.images.FrameSet

Bases: DescribableMixin, ABC

A container or factory for Transform objects that relates frames.

Notes

FrameSet supposes in (__contains__) tests on individual Frame objects to test whether they are known to the frame set, and indexing (__getitem__) of pairs of frames to return a Transform that maps the first to the second.

Methods Summary

describe(*[, brief, detail, exclude])	Return a Report describing this object.
get(in_frame, out_frame)	Return the Transform that maps the two frames, or None if at least one is not known to the FrameSet.

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

get(in_frame, out_frame)

Return the Transform that maps the two frames, or None if at least one is not known to the FrameSet.

Parameters:

• in_frame (TypeVar(I, bound= Frame)) – Frame to transform from.

• out_frame (TypeVar(O, bound= Frame)) – Frame to transform to.

Return type:

Optional[Transform[TypeVar(I, bound= Frame), TypeVar(O, bound= Frame)]]