lentil.Pupil.freeze

Pupil.freeze(inplace=True)

Cache properties defined in Plane.__freeze_attrs__.

When this function is called, properties defined in Plane.__freeze_attrs__ are cached and the cached value is returned until thaw() is called.

By default, only opd is frozen, as defined by Plane.__freeze_attrs__.

Parameters:

inplace (bool, optional) – If True (default), the caching operation is performed on the Plane in place, otherwise the original object is unchanged and a copy is returned.

Return type:

None or Plane

See also

thaw()