ixbounds module

class DMT.extraction.ixbounds.Bounds[source]

Bases: object

Base class for all Bounds classes used by XStep to select a sub-region of the reference data for fitting.

property high[source]

Getter for the upper (high) bounds of the boundaries.

property low[source]

Getter for the lower bounds of the boundaries.

class DMT.extraction.ixbounds.XBounds(xdata)[source]

Bases: Bounds

Implements X-axis boundaries based on the base class Bounds.

update(xdata)[source]

Overwrite the current lower and upper boundaries.

Parameters:
xdataarray, np.array

The x-axis values that shall lie within the boundaries self.low, self.high.

class DMT.extraction.ixbounds.XYBounds(xdata=None, ydata=None, new_bounds=None)[source]

Bases: Bounds

Implements two dimensional XY-axis boundaries based on the base class Bounds. Basically this is a rectangular area.

update(xdata, ydata)[source]

Overwrite the current lower and upper X and Y boundaries.

Parameters:
xdataarray, np.array

The x-axis values that shall lie within the boundaries.

ydataarray, np.array

The y-axis values that shall lie within the boundaries.

class DMT.extraction.ixbounds.YBounds(ydata)[source]

Bases: Bounds

Implements Y-axis boundaries based on the base class Bounds.

update(ydata)[source]

Overwrite the current lower and upper boundaries.

Parameters:
ydataarray, np.array

The y-axis values that shall lie within the boundaries.