cubnm.utils

Utility functions

avail_gpus()

Get the number of available GPUs

is_jupyter()

This function checks if the current environment is a Jupyter notebook.

fc_norm_euclidean(x, y)

Calculates Euclidean distance of two FC arrays

get_bw_params(src)

Get Balloon-Windkessel model parameters
cubnm.utils.avail_gpus()

Get the number of available GPUs

Returns

int

Number of available GPUs

cubnm.utils.is_jupyter()

This function checks if the current environment is a Jupyter notebook.

Returns:

bool: True if the current environment is a Jupyter notebook, False otherwise.

cubnm.utils.fc_norm_euclidean(x, y)

Calculates Euclidean distance of two FC arrays divided by their maximum possible distance, equal to the distance of np.ones(n_pairs) and -np.ones(n_pairs) or 2 * np.sqrt(n_pairs)

Parameters

x, y: np.ndarray

FC arrays. Shape: (n_pairs,)

Returns

float

Normalized Euclidean distance

cubnm.utils.get_bw_params(src)

Get Balloon-Windkessel model parameters

Parameters

src: {‘friston2003’, ‘heinzle2016-3T’}

  • ‘friston2003’: Friston et al. 2003

  • ‘heinzle2016-3T’: Heinzle et al. 2016, 3T parameters

Returns

dict

Balloon-Windkessel model parameters