Asymmetry2D

class sofia_redux.scan.source_models.beams.asymmetry_2d.Asymmetry2D(x=None, y=None, x_weight=0.0, y_weight=0.0)

Bases: ABC

Initialize an Asymmetry2D object.

The 2-dimensional asymmetry is a simple container for asymmetry measurements of (x, y) data. It is used to provide informational strings and significance/RMS values when requested.

Parameters:

xfloat or numpy.ndarray

The asymmetry in the x-direction.

yfloat or numpy.ndarray

The asymmetry in the y-direction.

x_weightfloat or numpy.ndarray

The asymmetry weight (1/variance) in the x-direction.

y_weightfloat or numpy.ndarray

The asymmetry weight (1/variance) in the y-direction.

Attributes Summary

x_rms	Return the root-mean-square of the asymmetry in the x-direction.
x_significance	Return the significance of the asymmetry in x.
y_rms	Return the root-mean-square of the asymmetry in the y-direction.
y_significance	Return the significance of the asymmetry in x.

Methods Summary

copy()

Return a copy of the Asymmetry2D object.

Attributes Documentation

x_rms

Return the root-mean-square of the asymmetry in the x-direction.

Returns:

rmsfloat

x_significance

Return the significance of the asymmetry in x.

Returns:

significancefloat

y_rms

Return the root-mean-square of the asymmetry in the y-direction.

Returns:

rmsfloat

y_significance

Return the significance of the asymmetry in x.

Returns:

significancefloat

Methods Documentation

copy()

Return a copy of the Asymmetry2D object.

Returns:

Asymmetry2D