sasdata.data_util.roi module

class sasdata.data_util.roi.CartesianROI(qx_range: tuple[float, float] = (0.0, 0.0), qy_range: tuple[float, float] = (0.0, 0.0))

Bases: GenericROI

Base class for data manipulators with a Cartesian (rectangular) ROI.

class sasdata.data_util.roi.GenericROI(center: tuple[float, float] = (0.0, 0.0))

Bases: object

Base class used to set up the data from a Data2D object for processing. This class performs any coordinate system independent setup and validation.

validate_and_assign_data(data2d: Data2D = None) → None

Check that the data supplied is valid and assign data to variables. This method must be executed before any further data processing happens

Parameters:

data2d – A Data2D object which is the target of a child class’ data manipulations.

class sasdata.data_util.roi.PolarROI(r_range: tuple[float, float], phi_range: tuple[float, float] = (0.0, 6.283185307179586), center: tuple[float, float] = (0.0, 0.0))

Bases: GenericROI

Base class for data manipulators with a polar ROI.

validate_and_assign_data(data2d: Data2D = None) → None

Check that the data supplied valid and assign data variables. This method must be executed before any further data processing happens

Parameters:

data2d – A Data2D object which is the target of a child class’ data manipulations.