API Documentation

Analysis

• decode
  • Decoder
    • Decoder.ClassMissingException
    • Decoder.append_previous_n_samples()
    • Decoder.bay_opt_wrapper()
    • Decoder.calc_movement_detection_rate()
    • Decoder.get_movement_grouped_array()
    • Decoder.run_Bay_Opt()
    • Decoder.run_CV()
    • Decoder.run_CV_caller()
    • Decoder.save()
    • Decoder.set_CV_results()
    • Decoder.set_data_grid_points()
    • Decoder.set_data_ind_channels()
• feature_reader
  • FeatureReader
    • FeatureReader.filter_features()
    • FeatureReader.get_epochs()
    • FeatureReader.normalize_features()
    • FeatureReader.plot_all_features()
    • FeatureReader.plot_cort_projection()
    • FeatureReader.plot_subject_grid_ch_performance()
    • FeatureReader.plot_target_averaged_channel()
    • FeatureReader.plot_target_avg_all_channels()
    • FeatureReader.read_results()
    • FeatureReader.read_target_ch()
    • FeatureReader.run_ML_model()
• plots
  • NM_Plot
    • NM_Plot.plot_cortex()
• RMAP
  • ConnectivityChannelSelector
    • ConnectivityChannelSelector.get_available_connectomes()
    • ConnectivityChannelSelector.get_closest_node()
    • ConnectivityChannelSelector.get_rmap_correlations()
    • ConnectivityChannelSelector.load_connectome()
    • ConnectivityChannelSelector.plot_grid()
  • RMAPCross_Val_ChannelSelector
    • RMAPCross_Val_ChannelSelector.load_fingerprint()
• stats
  • cluster_wise_p_val_correction()
  • cluster_wise_p_val_correction_numba()
  • permutationTest()
  • permutationTestSpearmansRho()
  • permutationTest_relative()
  • permutation_numba_onesample()
  • permutation_numba_twosample()

Feature Classes

• bispectra
  • Bispectra
    • Bispectra.calc_feature()
• bursts
  • Bursts
    • Bursts.calc_feature()
• coherence
  • Coherence
    • Coherence.calc_feature()
• fooof
  • FooofAnalyzer
    • FooofAnalyzer.calc_feature()
• hjorth
  • Hjorth
    • Hjorth.calc_feature()
• linelength
  • LineLength
    • LineLength.calc_feature()
• mne_connectivity
  • MNEConnectivity
    • MNEConnectivity.calc_feature()
• nolds
  • Nolds
    • Nolds.calc_feature()
• oscillatory
  • FFT
    • FFT.calc_feature()
  • Welch
    • Welch.calc_feature()
  • STFT
    • STFT.calc_feature()
• sharpwaves
  • SharpwaveAnalyzer
    • SharpwaveAnalyzer.analyze_waveform()
    • SharpwaveAnalyzer.calc_feature()
• bandpower
  • BandPower
    • BandPower.calc_feature()

Filter

• mne_filter
  • MNEFilter
    • MNEFilter.filter_bank
    • MNEFilter.filter_data()
• notch_filter
  • NotchFilter

Processing

• artifacts
  • PARRMArtifactRejection
• normalization
  • Normalizer
• projection
  • Projection
    • Projection.calc_proj_matrix()
    • Projection.calc_projection_matrix()
    • Projection.get_projected_cortex_subcortex_data()
    • Projection.init_projection_run()
    • Projection.project_features()
• rereference
  • ReReferencer
    • ReReferencer.process()
• resample
  • Resampler
    • Resampler.up
    • Resampler.process()

stream

• generator
  • RawDataGenerator
• mnelsl_player
  • LSLOfflinePlayer
    • LSLOfflinePlayer.start_player()
    • LSLOfflinePlayer.stop_player()
• mnelsl_stream
  • LSLStream
• settings
  • NMSettings
    • NMSettings.from_file()
    • NMSettings.model_computed_fields
    • NMSettings.model_config
    • NMSettings.model_fields
• Stream
  • Stream
    • Stream.plot_raw_signal()

utils

• channels
  • get_default_channels_from_data()
  • set_channels()
• database
  • NMDatabase
    • NMDatabase.create_table()
    • NMDatabase.fetch_all()
    • NMDatabase.head()
    • NMDatabase.infer_type()
    • NMDatabase.insert_data()
• io
  • get_coord_list()
  • get_paths_example_data()
  • load_channels()
  • loadmat()
  • read_BIDS_data()
  • read_grid()
  • read_mne_data()
  • write_csv()
• logging
  • NMLogger
    • NMLogger.log_to_file()
    • NMLogger.set_level()
• types
  • BoolSelector
    • BoolSelector.model_computed_fields
    • BoolSelector.model_config
    • BoolSelector.model_fields
  • FrequencyRange
    • FrequencyRange.model_computed_fields
    • FrequencyRange.model_config
    • FrequencyRange.model_fields
  • NMBaseModel
    • NMBaseModel.model_computed_fields
    • NMBaseModel.model_config
    • NMBaseModel.model_fields
  • NMFeature
    • NMFeature.calc_feature()
  • NMPreprocessor
  • create_validation_error()