Skip to content

nltools.utils

The warning categories nltools raises, so you can filter them.

Cross-cutting utilities used across the nltools package.

Classes:

Name Description
DesignMatrixWarning

A DesignMatrix operation was skipped, or the design itself is suspect.

ResamplingWarning

Data is (or will be) resampled to a different space than it arrived in.

Classes

DesignMatrixWarning

Bases: UserWarning

A DesignMatrix operation was skipped, or the design itself is suspect.

Raised by regressor builders (add_poly, add_dct_basis, convolve) when the requested columns already exist and are skipped, and by BrainData.fit() when the design it receives is rank deficient. Subclasses UserWarning so it participates in default filtering while staying individually silenceable: warnings.filterwarnings("ignore", category=DesignMatrixWarning).

ResamplingWarning

Bases: UserWarning

Data is (or will be) resampled to a different space than it arrived in.

Raised when a data image does not match the mask/template it is loaded against — a detected template at another resolution, or a mask in a different space — and nltools resamples to reconcile them. Subclasses UserWarning so it participates in default filtering while staying individually silenceable: warnings.filterwarnings("ignore", category=ResamplingWarning).