Helper Utilities

Internal helper modules for data models, logging, and common operations.

List Data Model

Qt-compatible list and table data models for the GUI file lists.

Logger Writer

Stream-like wrapper that redirects stdout/stderr writes to the Python logging system.

class xpcsviewer.helper.logwriter.LoggerWriter(level)

Bases: object

Parameters:

level (Callable[[str], None])

__init__(level)

Parameters:

level (Callable[[str], None])

Return type:

None

write(message)

Parameters:

message (str)

Return type:

None

flush()

Return type:

None

Utility Functions

Shared utility functions for data normalization and array slicing.

Helper utilities for XPCS data processing.

Provides common data transformation functions used across analysis modules:

• get_min_max: Percentile-based intensity range calculation

• norm_saxs_data: SAXS intensity normalization (I, I*q^2, I*q^4)

• create_slice: Slice creation for array subsetting

xpcsviewer.helper.utils.get_min_max(data, min_percent=0, max_percent=100, **kwargs)

Calculate intensity min/max values using percentiles.

Parameters:

• data (ArrayLike) – Input array.

• min_percent (float) – Lower percentile (0-100).

• max_percent (float) – Upper percentile (0-100).

• **kwargs (Any) – Optional plot_norm and plot_type for symmetric scaling.

Returns:

Tuple of (vmin, vmax) values.

Return type:

tuple[float, float]

xpcsviewer.helper.utils.norm_saxs_data(Iq, q, plot_norm=0)

Normalize SAXS intensity data.

Parameters:

• Iq (ndarray[tuple[Any, ...], dtype[floating[Any]]]) – Intensity array.

• q (ndarray[tuple[Any, ...], dtype[floating[Any]]]) – Q-values array.

• plot_norm (int) – Normalization mode (0=none, 1=I*q^2, 2=I*q^4, 3=I/I_0).

Returns:

Tuple of (normalized_Iq, xlabel, ylabel).

Return type:

tuple[ndarray[tuple[Any, …], dtype[floating[Any]]], str, str]

xpcsviewer.helper.utils.create_slice(arr, x_range)

Create a slice for array subsetting based on value range.

Parameters:

• arr (ndarray[tuple[Any, ...], dtype[floating[Any]]]) – 1D sorted array of values.

• x_range (tuple[float, float]) – Tuple of (min_value, max_value) defining the range.

Returns:

Slice object for the array subset.

Return type:

slice