InstantFocus

class sofia_redux.scan.source_models.beams.instant_focus.InstantFocus

Bases: ABC

Initialize an InstantFocus object.

The instant focus is designed to store focus measurements for later access. Focus measurements may be derived from the configuration, asymmetry, and elliptical elongation parameters.

Attributes Summary

is_complete	Return whether all focus parameters are available.
is_valid	Return whether the focus is valid.

Methods Summary

copy()	Return a copy of the focus.
copy_from(focus)	Copy the focus from another focus object.
derive_from(configuration[, asymmetry, ...])	Derive the focus from the asymmetry and elongation measurements.

Attributes Documentation

is_complete

Return whether all focus parameters are available.

Returns:

bool

is_valid

Return whether the focus is valid.

For the focus to be valid, it must contain at least one value in the x, y, or z attribute (not None).

Returns:

bool

Methods Documentation

copy()

Return a copy of the focus.

Returns:

InstantFocus

copy_from(focus)

Copy the focus from another focus object.

Parameters:

focusInstantFocus

Returns:

None

derive_from(configuration, asymmetry=None, elongation=None, elongation_weight=None)

Derive the focus from the asymmetry and elongation measurements.

The focus results are derived from the (x, y) asymmetry measurement, and from the elongation in the z-direction.

Parameters:

configurationConfiguration

The SOFSCAN configuration options.

asymmetryAsymmetry2D, optional

The source asymmetry.

elongationfloat, optional

The source elongation.

elongation_weightfloat, optional

The source elongation weight.

Returns:

None