Interactive Pop Workflow API

This page lists the public pop_* wrappers exported by eegprep. Use return_com=True on history-relevant wrappers when you need the replayable command string. In normal Python, assign returned values explicitly; in eegprep-console, registered wrappers can update the shared session automatically.

eegprep.pop_addindepvar	Return (variable, values, categorical_flag) for STUDY designs.
eegprep.pop_adjustevents	Adjust event offset of all or selected events.
eegprep.pop_autorej	Run EEGLAB's automatic epoch rejection protocol.
eegprep.pop_averef	Convert data to average reference through pop_reref(EEG, []).
eegprep.pop_biosig	Import BIOSIG-style EDF/BDF/GDF files.
eegprep.pop_chancenter	Recenter channel locations using a known or optimized sphere center.
eegprep.pop_chancoresp	Return 1-based channel correspondences by label.
eegprep.pop_chanedit	Edit EEG channel-location metadata.
eegprep.pop_chanevent	Import events from rising, falling, or both edges of data channels.
eegprep.pop_chanplot	Plot precomputed STUDY channel or component measures.
eegprep.pop_chansel	Open an EEGLAB pop_chansel-style channel selector.
eegprep.pop_clean_rawdata	Clean continuous EEG data using the clean_rawdata workflow.
eegprep.pop_clust	Run deterministic k-means clustering on STUDY.etc.preclust.
eegprep.pop_clustedit	Run cluster edit and plotting actions on STUDY.cluster.
eegprep.pop_comments	Edit or assign dataset comments.
eegprep.pop_compareerps	Compare ERP averages for selected datasets using pop_comperp.
eegprep.pop_comperp	Compute and plot grand-average ERPs across loaded datasets.
eegprep.pop_copyset	Copy dataset set_in to set_out using EEGLAB-facing indices.
eegprep.pop_crossf	Run legacy pop_crossf through EEGPrep's pop_newcrossf implementation.
eegprep.pop_delset	Delete dataset indices from ALLEEG and return a history command.
eegprep.pop_dipfit_gridsearch	Run a standalone spherical coarse grid search for ICA components.
eegprep.pop_dipfit_headmodel	Validate headmodel inputs, then fail clearly until FieldTrip is ported.
eegprep.pop_dipfit_loreta	Validate LORETA prerequisites, then fail clearly until a backend exists.
eegprep.pop_dipfit_nonlinear	Run standalone nonlinear dipole refinement for one component.
eegprep.pop_dipfit_settings	Configure DIPFIT settings without requiring an EEGLAB runtime.
eegprep.pop_dipplot	Plot localized DIPFIT component positions.
eegprep.pop_editeventfield	Add, remove, rename, or update fields in EEG.event.
eegprep.pop_editeventvals	Edit individual EEG.event values.
eegprep.pop_editoptions	Update EEGPrep's EEGLAB-compatible options dictionary.
eegprep.pop_editset	Edit dataset metadata fields in an EEG dictionary.
eegprep.pop_eegfilt	Filter EEG data through the legacy pop_eegfilt interface.
eegprep.pop_eegfiltnew	Filter EEG data using EEGLAB's Hamming-windowed FIR defaults.
eegprep.pop_eegplot	Inspect EEG channel or component activity in the scrolling browser.
eegprep.pop_eegthresh	Mark or reject epochs using EEGLAB pop_eegthresh semantics.
eegprep.pop_envtopo	Plot largest component ERP envelopes and component maps.
eegprep.pop_epoch	Extract data epochs time locked to event types or event indices.
eegprep.pop_erpimage	Plot an ERP image for one channel or component.
eegprep.pop_eventstat	Compute and plot statistics for numeric EEG event fields.
eegprep.pop_expevents	Export EEG.event as a tab-delimited text file.
eegprep.pop_expica	Export the ICA weight matrix or inverse weight matrix.
eegprep.pop_export	Export EEG data or ICA activity to a delimited text file.
eegprep.pop_exportbids	Export EEG dataset(s) as BIDS-like EEGLAB files and sidecars.
eegprep.pop_fileio	Import a supported EEG data file with MNE/File-IO-style readers.
eegprep.pop_fileio_brainvision_mat	Import a BrainVision Analyzer MATLAB file.
eegprep.pop_findmatchingcomps	Find current-dataset components matching another set of scalp maps.
eegprep.pop_firma	Filter EEG data using a moving-average FIR filter.
eegprep.pop_firpm	Filter EEG data using a Parks-McClellan equiripple FIR filter.
eegprep.pop_firpmord	Estimate Parks-McClellan FIR order and pass/stop weights.
eegprep.pop_firws	Filter EEG data using a windowed-sinc FIR filter.
eegprep.pop_firwsord	Estimate a windowed-sinc FIR order.
eegprep.pop_fusechanrej	Keep only common channels across datasets with the same subject/session.
eegprep.pop_headplot	Plot ERP or component maps on a spline-interpolated 3-D head mesh.
eegprep.pop_icathresh	Set ICA rejection thresholds and update reject.gcompreject.
eegprep.pop_icflag	Flag ICLabel-classified components for later rejection.
eegprep.pop_iclabel	Classify independent components using ICLabel.
eegprep.pop_importbids	Load one or more EEG files from a BIDS dataset.
eegprep.pop_importdata	Import data from an array or supported file into an EEG dataset.
eegprep.pop_importepoch	Import per-epoch metadata from a text table.
eegprep.pop_importerplab	Import an ERPLAB-style event text file through the generic event importer.
eegprep.pop_importevent	Import events from a text table or record array.
eegprep.pop_importgroupvar	Attach one imported variable value per STUDY subject.
eegprep.pop_importpres	Import a Presentation LOG file using EEGPrep's generic event importer.
eegprep.pop_interp	Interpolate EEG channels using EEGLAB pop_interp semantics.
eegprep.pop_jointprob	Mark or reject epochs by local/global joint probability.
eegprep.pop_kaiserbeta	Estimate Kaiser window beta from passband ripple.
eegprep.pop_leadfield	Compute a standalone spherical leadfield for explicit source points.
eegprep.pop_limo	Report that standalone EEGPrep does not run external LIMO workflows.
eegprep.pop_limoresults	Report that standalone EEGPrep does not browse external LIMO results.
eegprep.pop_listfactors	Return factor descriptors for one STUDY or design structure.
eegprep.pop_load_frombids	Load an EEG data file of a supported format from a BIDS dataset.
eegprep.pop_loadbci	Import a BCI2000-style file into an EEG dictionary.
eegprep.pop_loadset	Load EEGLAB dataset from .set or .mat file.
eegprep.pop_loadset_h5	Load EEG data from HDF5 file.
eegprep.pop_loadstudy	Load a STUDY JSON file saved by pop_savestudy.
eegprep.pop_mergeset	Merge two or more EEG datasets.
eegprep.pop_multifit	Fit multiple ICA components using grid search and nonlinear refinement.
eegprep.pop_newcrossf	Plot event-related channel/component cross-coherence.
eegprep.pop_newset	Store or retrieve datasets following EEGLAB's pop_newset contract.
eegprep.pop_newtimef	Plot a channel or component ERSP/ITC decomposition.
eegprep.pop_plotdata	Plot component ERP activations in a rectangular array.
eegprep.pop_plottopo	Plot channel ERP traces in a rectangular/scalp-like array.
eegprep.pop_preclust	Prepare a STUDY component clustering matrix.
eegprep.pop_precomp	Precompute STUDY channel or component measures.
eegprep.pop_prop	Plot properties of one channel or independent component.
eegprep.pop_prop_extended	Render the EEGLAB viewprops-style extended property dashboard.
eegprep.pop_readlocs	Read channel locations and return an EEGPrep chanlocs list.
eegprep.pop_rejchan	Reject channels by probability, kurtosis, spectrum, or standard deviation.
eegprep.pop_rejchanspec	Reject bad channels from spectral outliers.
eegprep.pop_rejcont	Reject continuous data portions based on high-frequency power.
eegprep.pop_rejepoch	Remove rejected epochs.
eegprep.pop_rejkurt	Mark or reject epochs by local/global kurtosis.
eegprep.pop_rejmenu	Open a compact rejection menu that combines stored non-browser marks.
eegprep.pop_rejspec	Mark or reject epochs by spectral power thresholds.
eegprep.pop_rejtrend	Mark or reject epochs containing line-like trends.
eegprep.pop_reref	Convert an EEG dataset to average or common-reference data.
eegprep.pop_resample	Resample EEG data to a new sampling rate.
eegprep.pop_rmbase	Remove baseline means from an epoched or continuous EEG dataset.
eegprep.pop_rmdat	Keep or remove continuous data around event types.
eegprep.pop_runica	Run ICA decomposition with EEGLAB pop_runica calling semantics.
eegprep.pop_runscript	Run a Python history script selected by the user.
eegprep.pop_saveh	Save dataset or session command history to a script file.
eegprep.pop_saveset	Save EEG data to file.
eegprep.pop_savestudy	Save a STUDY structure as an EEGPrep JSON .study file.
eegprep.pop_select	Select EEG data using EEGLAB pop_select semantics.
eegprep.pop_selectcomps	Inspect components and optionally mark them in EEG.reject.gcompreject.
eegprep.pop_selectevent	Select, rename, or delete events using EEGLAB pop_selectevent semantics.
eegprep.pop_signalstat	Compute and plot statistics for one channel or component.
eegprep.pop_snapread	Import a SnapMaster .SMA file.
eegprep.pop_spectopo	Plot channel or component spectra and scalp maps.
eegprep.pop_study	Create or edit a STUDY structure from loaded EEG datasets.
eegprep.pop_studydesign	Edit STUDY designs and select the current design.
eegprep.pop_studyerp	Create a STUDY marked as a simple ERP design.
eegprep.pop_studywizard	Load selected datasets and create a STUDY.
eegprep.pop_subcomp	Remove ICA components from data.
eegprep.pop_timef	Run legacy pop_timef through EEGPrep's pop_newtimef implementation.
eegprep.pop_timtopo	Plot channel ERP traces and scalp maps at selected latencies.
eegprep.pop_topochansel	Select channels by label/index using EEGPrep's channel selector.
eegprep.pop_topoplot	Plot EEGLAB-style 2-D scalp maps for ERP latencies or ICA components.
eegprep.pop_viewprops	Render channel/component property overview figures and activity views.
eegprep.pop_writeeeg	Write continuous EEG data to an EDF/BDF/GDF-compatible file.
eegprep.pop_writelocs	Write channel locations and return a replayable history command.
eegprep.pop_xfirws	Design a FIRFilt windowed-sinc FIR and optionally export an .fir file.

Coverage Notes

Major user-facing workflows are described in the user guide. Thin compatibility wrappers, legacy import/export helpers, and plotting helpers are discoverable here and through their function docstrings. Packaged GUI Help topics live under src/eegprep/resources/help and are opened by pophelp.