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.

__annotations__ = {}

__doc__ = '\nBase class for data manipulators with a Cartesian (rectangular) ROI.\n'

__firstlineno__ = 68

__init__(qx_range: tuple[float, float] = (0.0, 0.0), qy_range: tuple[float, float] = (0.0, 0.0)) → None

Assign the variables used to label the properties of the Data2D object. Also establish the upper and lower bounds defining the ROI.

The units of these parameters are A^-1 :param qx_range: Bounds of the ROI along the Q_x direction. :param qy_range: Bounds of the ROI along the Q_y direction.

__module__ = 'sasdata.data_util.roi'

__static_attributes__ = ('qx_max', 'qx_min', 'qy_max', 'qy_min')

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.

__annotations__ = {}

__dict__ = mappingproxy({'__module__': 'sasdata.data_util.roi', '__firstlineno__': 7, '__doc__': '\nBase class used to set up the data from a Data2D object for processing.\nThis class performs any coordinate system independent setup and validation.\n', '__init__': <function GenericROI.__init__>, 'validate_and_assign_data': <function GenericROI.validate_and_assign_data>, '__static_attributes__': ('center_x', 'center_y', 'data', 'err_data', 'phi_data', 'q_data', 'qx_data', 'qy_data'), '__dict__': <attribute '__dict__' of 'GenericROI' objects>, '__weakref__': <attribute '__weakref__' of 'GenericROI' objects>, '__annotations__': {}})

__doc__ = '\nBase class used to set up the data from a Data2D object for processing.\nThis class performs any coordinate system independent setup and validation.\n'

__firstlineno__ = 7

__init__(center: tuple[float, float] = (0.0, 0.0))

Assign the variables used to label the properties of the Data2D object.

In classes inheriting from GenericROI, the variables used to define the boundaries of the Region Of Interest are also set up during __init__.

__module__ = 'sasdata.data_util.roi'

__static_attributes__ = ('center_x', 'center_y', 'data', 'err_data', 'phi_data', 'q_data', 'qx_data', 'qy_data')

__weakref__

list of weak references to the object

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.

__annotations__ = {}

__doc__ = '\nBase class for data manipulators with a polar ROI.\n'

__firstlineno__ = 90

__init__(r_range: tuple[float, float], phi_range: tuple[float, float] = (0.0, 6.283185307179586), center: tuple[float, float] = (0.0, 0.0)) → None

Assign the variables used to label the properties of the Data2D object. Also establish the upper and lower bounds defining the ROI.

The units are A^-1 for radial parameters, and radians for anglar ones. :param r_range: Tuple (r_min, r_max) defining limits for |Q| values to use during averaging. :param phi_range: Tuple (phi_min, phi_max) defining limits for φ in radians (in the ROI).

Note that Phi is measured anti-clockwise from the positive x-axis.

__module__ = 'sasdata.data_util.roi'

__static_attributes__ = ('phi_data', 'phi_max', 'phi_min', 'r_max', 'r_min')

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.