BracketedValues

class sofia_redux.scan.utilities.bracketed_values.BracketedValues(start=nan, end=nan, unit=None)

Bases: ABC

Initialize a BracketedValues object.

The bracketed values class is used to represent a range, and may perform operations with other BracketedValues objects.

Parameters:

startint or float or units.Quantity, optional

The starting value of the range.

endint or float or units.Quantity, optional

The ending value of the range.

unitunits.Unit or str, optional

The unit of the range.

Attributes Summary

midpoint

Return the midpoints of the bracket.

Methods Summary

copy()	Return a copy of the bracket.
merge(other)	Combine with another bracket.

Attributes Documentation

midpoint

Return the midpoints of the bracket.

The midpoint is the mean of the start and end points of the bracket.

Returns:

float or units.Quantity

Methods Documentation

copy()

Return a copy of the bracket.

Returns:

BracketedValues

merge(other)

Combine with another bracket.

The resulting (start, end) points of the bracket will be (min[self.start, other.start], max[self.end, other.end]).

Parameters:

otherBracketedValues

Returns:

None