screamlab.settings module

The settings module is responsible for managing configuration options.

class screamlab.settings.Properties(prefit: bool = False, buildup_types: list = None, spectrum_fit_type: str = None, spectrum_for_prefit: int = -1, path_to_experiment: str = '', procno: int = 103, expno: list = None, output_folder: str = '', subspec=None, scream3d=False)

Bases: object

A class to manage and validate properties related to spectral fitting and buildup types.

property scream3d: bool

Whether the SCREAM DNP data were acquired using a pseudo-3D experiment.

Default is False.

Type:

bool

property subspec: list

Specifies region of subspectrum.

Default is None.

Type:

List of int, optional

property output_folder: str

The current folder path where the output is being saved.

Folder path for saving output.

Default is an empty string (“”).

Type:

str

property expno: list

List of experiment numbers (expno; TopSpin) that should be used for analysis.

Two different input formats are allowed. [1, 8] means using all experiment numbers between 1 and 8, while [1, 3, 5, 7, 8] allows for a specific selection.

Default is None.

Type:

List of int

property procno: int

Processing number according to Bruker’s TopSpin

Default is 103 (standard in SCREAM-DNP experiments).

Type:

int, optional

property path_to_experiment: str

Path to the experiment data.

Returns the path where experiment-related data is stored. This is typically a directory path in string format.

Default is an empty string (“”).

Type:

str

property spectrum_fit_type: list

A list specifying the spectrum fit type

Options supporded: “global”, “independent, “numint”.

Type:

str, optional

property buildup_types: list

A list of buildup function types

Options supporded: “exponential”,”biexponential”, “exponential_with_offset”, “biexponential_with_offset”, “stretched_exponential”, “stretched_exponential_decay”, “biexponential_decay”.

Default is [“exponential”].

Type:

List of str, optional

property prefit: bool

Indicates whether a prefit should be performed or not.

Default is False.

Type:

bool, optional

property spectrum_for_prefit: int

Specifies the spectrum used for prefit.

Default is -1, meaning the last spectrum in screamlab.settings.Spectra.

Type:

int, optional