Skip to main content
Ctrl+K

AutoClean

  • AutoClean EEG Pipeline
  • Getting Started
  • Tutorials
  • API Reference
  • Development
  • GitHub
  • AutoClean EEG Pipeline
  • Getting Started
  • Tutorials
  • API Reference
  • Development
  • GitHub

Section Navigation

  • Core Classes
    • Pipeline
    • Task
  • Mixins (autoclean.mixins)
    • basic_steps.BasicStepsMixin
    • channels.ChannelsMixin
    • artifacts.ArtifactsMixin
    • autoreject_epochs.AutoRejectEpochsMixin
    • channels.ChannelsMixin
    • eventid_epochs.EventIDEpochsMixin
    • regular_epochs.RegularEpochsMixin
    • outlier_detection.OutlierDetectionMixin
    • gfp_clean_epochs.GFPCleanEpochsMixin
    • ica.IcaMixin
    • segment_rejection.SegmentRejectionMixin
    • visualization.VisualizationMixin
    • ica.ICAReportingMixin
  • Standalone Functions (autoclean.functions)
    • filtering.filter_data
    • referencing.rereference_data
    • resampling.resample_data
    • basic_ops.crop_data
    • basic_ops.drop_channels
    • channels.detect_bad_channels
    • channels.interpolate_bad_channels
    • regular.create_regular_epochs
    • statistical.create_sl_epochs
    • eventid.create_eventid_epochs
    • quality.detect_outlier_epochs
    • quality.gfp_clean_epochs
    • ica_processing.fit_ica
    • ica_processing.classify_ica_components
    • ica_processing.apply_ica_rejection
    • segment_rejection.annotate_noisy_segments
    • segment_rejection.annotate_uncorrelated_segments
    • dense_oscillatory.detect_dense_oscillatory_artifacts
    • autoreject.autoreject_epochs
    • plotting.plot_raw_comparison
    • plotting.plot_ica_components
    • plotting.plot_psd_topography
    • reports.generate_processing_report
    • reports.create_processing_summary
  • IO (autoclean.io)
    • import_.import_eeg
    • export.save_raw_to_set
    • export.save_epochs_to_set
    • export.save_stc_to_file
  • Reports (autoclean.step_functions)
    • reports.create_run_report
    • reports.update_task_processing_log
    • reports.create_json_summary
    • reports.generate_bad_channels_tsv
  • Utils (autoclean.utils)
    • bids.step_convert_to_bids
    • bids.step_sanitize_id
    • bids.step_create_dataset_desc
    • bids.step_create_participants_json
    • config.load_config
    • config.validate_signal_processing_params
    • config.validate_eeg_system
    • config.hash_and_encode_yaml
    • config.decode_compressed_yaml
    • database.set_database_path
    • database.get_run_record
    • database.manage_database
    • file_system.step_prepare_directories
    • logging.configure_logger
    • logging.message
    • logging.LogLevel
    • montage.load_valid_montages
    • montage.get_10_20_to_gsn_mapping
    • montage.get_gsn_to_10_20_mapping
    • montage.convert_channel_names
    • montage.get_standard_set_in_montage
    • montage.validate_channel_set
  • Tools (autoclean.tools)
  • Montage Constants

Indices

  • General Index
  • API Reference

API Reference#

This page provides an overview of the AutoClean API.

  • Core Classes
    • Pipeline
    • Task
  • Mixins (autoclean.mixins)
    • Available Mixins
    • SignalProcessingMixin
    • ReportingMixin
  • Standalone Functions (autoclean.functions)
    • Available Function Categories
  • IO (autoclean.io)
    • Raw
  • Reports (autoclean.step_functions)
    • Report Functions
  • Utils (autoclean.utils)
    • Bids
    • Config
    • Database
    • FileSystem
    • Logging
    • Montage
  • Tools (autoclean.tools)
    • Available Tools
    • AutoClean Review GUI
  • Montage Constants
    • Constants

© Copyright 2024-2025, Cincibrainlab Team.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.