circleclust.utils

Functions

debug_plot_screen_iteration(h_train, ...[, ...])
debug_plot_window_selection(rms_tr_mean, ...)
find_intervals(x)	Finds continuous positive intervals in 1d-array.
fit_gaussian_shifted(y[, mu])	Fits a vertically-shifted Gaussian to data.
gaussian_shifted(x, A, mu, sigma, C)	Computes gaussian normal distribution with a vertical shift.
verbose_print(message[, verbose])	Print a message if verbose is True.
warning_print(message)	Print a warning message to stderr without raising.

circleclust.utils.verbose_print(message, verbose=False)

Print a message if verbose is True.

Parameters:

• message (str) – Message to print

• verbose (bool) – Whether to print the message

circleclust.utils.warning_print(message)

Print a warning message to stderr without raising.

The message is prefixed with “WARNING:”.

Parameters:

message (str) – The message to write to stderr.

circleclust.utils.find_intervals(x)

Finds continuous positive intervals in 1d-array.

Parameters:

x (np.ndarray) – 1D array of non-negative numeric values

Returns:

2D array - N intervals x 2 indices (start, end)

Return type:

np.ndarray

circleclust.utils.debug_plot_screen_iteration(h_train, s_train, h_test, s_test, iteration, i_window, outdir='debug')

Parameters:

• h_train (ndarray)

• s_train (ndarray)

• h_test (ndarray)

• s_test (ndarray)

• iteration (int)

• i_window (int)

• outdir (str)

circleclust.utils.debug_plot_window_selection(rms_tr_mean, rms_ts_mean, i0, outdir='debug')

Parameters:

• rms_tr_mean (ndarray)

• rms_ts_mean (ndarray)

• i0 (int)

• outdir (str)

circleclust.utils.gaussian_shifted(x, A, mu, sigma, C)

Computes gaussian normal distribution with a vertical shift.

Parameters:

• x (ndarray) – array-like Input x values

• A (float) – float Amplitude

• mu (float) – float Mean

• sigma (float) – float Standard deviation

• C (float) – float Vertical shift constant

Returns:

array-like

Gaussian values

Return type:

y

circleclust.utils.fit_gaussian_shifted(y, mu=None)

Fits a vertically-shifted Gaussian to data.

Parameters:

• y (ndarray) – array-like Input data values on an equispaced grid

• mu (float | None) – float or None If float, uses fixed center; if None, fits center

Returns:

array

Fitted parameters A, mu, sigma, C or None

Return type:

popt