nstat.ConfigCollection

class nstat.ConfigCollection(configs=None)[source]

Bases: object

Ordered collection of TrialConfig objects.

Used by Analysis to iterate over multiple model specifications (e.g. baseline, baseline + stimulus, baseline + stimulus + history) and compare their fits.

Parameters:: configs (TrialConfig, sequence of TrialConfig, or None) – Initial configuration(s). None creates a single "Empty Config" entry (Matlab parity).

__init__(configs=None)[source]

Construct an ordered collection of GLM-fit configurations (Matlab ConfigColl).

Parameters:

configs (TrialConfig, sequence of TrialConfig, str, or None, optional) –

Initial configuration(s).

A single TrialConfig becomes the first entry.
A sequence (list/tuple) is iterated and each entry added.
None (default) or an empty sequence creates a single "Empty Config" placeholder entry — matches MATLAB ConfigColl() which routes through addConfig([]).

Raises:

TypeError – If configs contains an unsupported entry type.

Return type:

None

Notes

Empty-config placeholders (strings/sequences) are tracked separately from real TrialConfig instances — see configs for the filtered list.

See also

TrialConfig: Single GLM-fit configuration.
Analysis.RunAnalysisForAllNeurons: Iterates over a ConfigCollection.

property configs: list[TrialConfig]: List of actual TrialConfig entries (excludes empty placeholders).

add_config(cfg)[source]

Pythonic alias for addConfig().

Parameters:: cfg (TrialConfig)
Return type:: None

addConfig(cfg)[source]

Append one or more configurations to this collection.

Parameters:: cfg (Sequence[TrialConfig] | TrialConfig | str | None)
Return type:: None

get_config(idx)[source]

Return a config by 0-based index (Pythonic API).

Parameters:: idx (int)
Return type:: TrialConfig | str | list[str]

getConfig(idx)[source]

Return a config by 0-based index.

Parameters:: idx (int)

setConfig(trial, index)[source]

Apply configuration index (0-based) to the given Trial.

Parameters:

trial (Trial)
index (int)

Return type:

None

getConfigNames(index=None)[source]

Return the names for selected configs (0-based), or all if index is None.

Parameters:: index (Sequence[int] | None)
Return type:: list[str]

setConfigNames(names, index=None)[source]

Set the human-readable names for configs at 0-based index positions.

Parameters:: index (Sequence[int] | None)
Return type:: None

getSubsetConfigs(subset)[source]

Return a new collection containing only configs at 0-based subset indices.

Parameters:: subset (Sequence[int])
Return type:: ConfigCollection

toStructure()[source]

Serialize to a plain dict (Matlab ConfigColl.toStructure).

Return type:: dict[str, Any]

static fromStructure(structure)[source]

Reconstruct from a dict produced by toStructure().

Parameters:: structure (dict[str, Any])
Return type:: ConfigCollection