DataObjects.XrData

DataObjects.XrData#

DataObjects.XrData.py

Copyright (c) 2025, SAXS Team, KEK-PF

class XrData(iv, jv, M, E)#

Bases: SsMatrixData

XrData class for XR matrix data.

copy(**kwargs)#
get_ipickvalue()#
get_icurve(pickat=0.02)#

Returns an i-curve from the XR matrix data.

Parameters:

pickat (float, optional) –

Specifies the value in ssd.qv where to pick an i-curve. The i-curve will be made from self.M[i,:] where the picking index i will be determined to satisfy

self.qv[i-1] <= pickat < self.qv[i]

according to bisect_right.

Examples

>>> curve = xr.get_icurve()

>>> curve = xr.get_icurve(pickat=0.02)
get_usable_qrange()#

Returns a pair of indeces which should be used as a slice for the angular axis to trim away unusable XR data regions.

Parameters:

None

Examples

>>> i, j = xr.get_usable_qrange()
get_ibaseline(pickvalue=0.02)#

Returns a baseline i-curve from the XR matrix data.

Parameters:

pickvalue (float, optional) – See ssd.get_xr_icurve().

Examples

>>> curve = xr.get_icurve()
>>> baseline = xr.get_ibaseline()
>>> corrected_curve = curve - baseline
compute_rgcurve()#

Returns a Rg-curve.

Parameters:

None

compute_rgcurve_atsas()#

Returns an Rg-curve.

Parameters:

None

get_jcurve_array(j=None, peak=None)#

Returns the j-curve array. This method extracts the q, I, and sigq values from the XR data. It uses the first peak in the i-curve to determine the j-curve.

Parameters:

  • j (int, optional) – The index of the j-curve to use. If None, the peak argument is used.

  • peak (int, optional) – This argument is used only if j is None. The index of the peak in the i-curve to use. If None, the first peak is used.

Returns:

jcurve_array

Return type:

np.ndarray

Contents