API Documentation

Parametrization

• nm_stream_abc.py
  • PNStream
    • PNStream.load_model()
    • PNStream.run()
    • PNStream.save_after_stream()
    • PNStream.save_sidecar()
• nm_stream_offline.py
  • Stream
    • Stream.run()
• nm_settings.py
  • get_default_settings()
  • test_settings()
• nm_define_nmchannels.py
  • get_default_channels_from_data()
  • set_channels()
• nm_generator.py
  • raw_data_generator()
• nm_run_analysis.py
  • DataProcessor
    • DataProcessor.process()
    • DataProcessor.save_sidecar()
• nm_resample.py
  • Resampler
    • Resampler.up
    • Resampler.process()
• nm_normalization.py
  • NORM_METHODS
• nm_rereference.py
  • ReReferencer
    • ReReferencer.process()
• nm_projection.py
  • Projection
    • Projection.calc_proj_matrix()
    • Projection.calc_projection_matrix()
    • Projection.get_projected_cortex_subcortex_data()
    • Projection.init_projection_run()
    • Projection.project_features()
• nm_IO.py
  • get_paths_example_data()
  • load_nm_channels()
  • loadmat()
  • read_BIDS_data()
  • read_plot_modules()
  • save_features_and_settings()
  • write_csv()

Feature Estimation

• nm_features_abc.py
  • Feature
    • Feature.calc_feature()
    • Feature.test_settings()
• nm_features.py
  • Features
    • Features.estimate_features()
    • Features.register_new_feature()
• nm_filter.py
  • BandPassFilter
    • BandPassFilter.filter_bank
    • BandPassFilter.filter_data()
• nm_oscillatory.py
  • FFT
    • FFT.calc_feature()
    • FFT.test_settings()
  • BandPower
    • BandPower.calc_feature()
    • BandPower.test_settings()
  • STFT
    • STFT.calc_feature()
    • STFT.test_settings()
• nm_fooof.py
  • FooofAnalyzer
    • FooofAnalyzer.calc_feature()
    • FooofAnalyzer.test_settings()
• nm_kalmanfilter.py
  • define_KF()
• nm_hjorth_raw.py
  • Hjorth
    • Hjorth.calc_feature()
    • Hjorth.test_settings()
  • Raw
    • Raw.calc_feature()
    • Raw.test_settings()
• nm_sharpwaves.py
  • SharpwaveAnalyzer
    • SharpwaveAnalyzer.analyze_waveform()
    • SharpwaveAnalyzer.calc_feature()
    • SharpwaveAnalyzer.test_settings()
• nm_bursts.py
  • Burst
    • Burst.calc_feature()
    • Burst.get_burst_amplitude_length()
    • Burst.test_settings()
• nm_coherence.py
  • NM_Coherence
    • NM_Coherence.calc_feature()
    • NM_Coherence.test_settings()
• nm_nolds.py
  • Nolds
    • Nolds.calc_feature()
    • Nolds.test_settings()
• nm_mne_connectivity.py
  • MNEConnectivity
    • MNEConnectivity.calc_feature()
    • MNEConnectivity.test_settings()
• nm_linelength.py
  • LineLength
    • LineLength.calc_feature()
    • LineLength.test_settings()

Analysis

• nm_analysis.py
• nm_decode.py
  • 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()
• nm_plots.py
  • get_plt_path()
  • plot_bar_performance_per_channel()
• nm_RMAP.py
• nm_stats.py
  • cluster_wise_p_val_correction()
  • cluster_wise_p_val_correction_numba()
  • permutationTest()
  • permutationTestSpearmansRho()
  • permutationTest_relative()
  • permutation_numba_onesample()
  • permutation_numba_twosample()
• nm_cohortwrapper.py
• nm_across_patient_decoding.py