Trimming.UsableQrange

Trimming.UsableQrange#

Trimming.UsableQrange.py

class UsableQrange(start, stop, icurve, pre_rg)#

Bases: object

Holds information about the usable Q range in XR data.

start#

The starting index of the usable Q range.

Type:

int

stop#

The stopping index of the usable Q range.

Type:

int

icurve#

The intensity curve associated with the XR data.

Type:

ICurve

pre_rg#

The preliminary Rg information associated with the XR data.

Type:

PreliminaryRg

Parameters:

  • start (int) – The starting index of the usable Q range.

  • stop (int) – The stopping index of the usable Q range.

  • icurve (ICurve) – The intensity curve associated with the XR data.

  • pre_rg (PreliminaryRg) – The preliminary Rg information associated with the XR data.

get_usable_qrange_impl(xr_data, ip_effect_info=False, nguiniers=None, return_object=False, debug=True)#

Get the usable Q range for the given XR data.

Parameters:

  • xr_data (XRData) – The XR data to analyze.

  • ip_effect_info (bool) – Whether to consider inter-particle effects.

  • nguiniers (int or None) – Number of Guinier points to consider. If None, use default.

  • return_object (bool) – If True, return a UsableQrange object. If False, return (start, stop).

  • debug (bool) – If True, enable debug mode.

Returns:

The usable Q range as a UsableQrange object or as (start, stop) tuple.

Return type:

UsableQrange or (int, int)

Contents