ENCORE runners plots

encore.plotters.encore.plot_example(figures, answer)

Example plotting function for ENCORE algorithms.

This function demonstrates how algorithm results (“answer”) are mapped to GUI figures defined in the configuration file. It retrieves pre-created MatplotlibWidget instances from the figures dictionary and populates them with visualizations derived from the analysis output.

Each figure is optional: if a figure name is not present in the configuration or GUI, it is safely skipped.

Expected figure keys (as defined in the YAML configuration):

  • example_plot_raster: Raster-like representation of ensemble activity.

  • example_plot_dFFo: Single-neuron dFFo time series.

  • example_plot_secondary_dFFo: Secondary dFFo trace plotted manually.

  • example_plot_many_dFFo: Multiple dFFo traces displayed in subplots.

Expected entries in the answer dictionary:

  • raster: 2D array-like structure (ensembles, time).

  • neuron_dFFo: 1D array representing dFFo for a single neuron.

  • other_dFFo: 1D array representing an additional dFFo trace.

  • many_neurons_dFFo: 2D array (neurons, time) for multi-neuron plots.

This function serves as a reference template for developers implementing custom plotting routines for new algorithms.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the results produced by the corresponding analysis function.

encore.plotters.encore.plot_ica(figures, answer)

Plots the results of the ICA algorithm, including assembly templates, time projections, binary assembly templates, core cells and binary assemblies.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the ICA output data from MATLAB, including assembly templates, time projections, binary assembly templates, and binary assemblies.

Returns:

None

Return type:

None

encore.plotters.encore.plot_pca(figures, answer)

Plots the results of the PCA algorithm, including eigen values, principal components, rho and delta values, correlation of cells, core cells and ensembles time course.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the PCA output data from MATLAB, including eigen values, principal components, rho and delta values, correlation of cells, core cells and ensembles time course.

Returns:

None

Return type:

None

encore.plotters.encore.plot_sgc(figures, answer)

Plots the results of the SGC algorithm. Currently only the ensembles timecourse and the neurons in ensembles are supported.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the keys ‘timecourse’ and ‘neus_in_ens’ from the SGC results.

Returns:

None

Return type:

None

encore.plotters.encore.plot_svd(figures, answer)

Plots and saves the results of the SVD algorithm, including similarity maps, singular values, components, and ensemble timecourses.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the SVD output data from MATLAB, including matrices for similarity maps, singular values, component vectors, ensemble timecourses, and neuron groupings.

Returns:

None

Return type:

None

encore.plotters.encore.plot_x2p(figures, answer)

Plots the results of the X2P algorithm, including similarity map, EPI, onsemble activity, offsemble activity, activity, onsembles neurons and offsemble neurons.

Parameters:

  • figures (dict[str, MatplotlibWidget]) – Dictionary mapping figure names (strings) to MatplotlibWidget instances created by the GUI.

  • answer (dict) – Dictionary containing the X2P output data from MATLAB, including similaty map, EPI, onsemble activity, offsemble activity, activity, onnsembles neurons and offsemble neurons.

Returns:

None

Return type:

None