Interfaces#
- Extracellular Electrophysiology
- Base Recording
BaseRecordingExtractorInterfaceBaseRecordingExtractorInterface.keywordsBaseRecordingExtractorInterface.get_metadata_schema()BaseRecordingExtractorInterface.get_metadata()BaseRecordingExtractorInterface.channel_idsBaseRecordingExtractorInterface.remove_channels()BaseRecordingExtractorInterface.get_original_timestamps()BaseRecordingExtractorInterface.get_timestamps()BaseRecordingExtractorInterface.set_aligned_timestamps()BaseRecordingExtractorInterface.set_aligned_segment_timestamps()BaseRecordingExtractorInterface.set_aligned_starting_time()BaseRecordingExtractorInterface.set_aligned_segment_starting_times()BaseRecordingExtractorInterface.set_probe()BaseRecordingExtractorInterface.has_probe()BaseRecordingExtractorInterface.align_by_interpolation()BaseRecordingExtractorInterface.add_to_nwbfile()
- Base Sorting
BaseSortingExtractorInterfaceBaseSortingExtractorInterface.keywordsBaseSortingExtractorInterface.get_metadata_schema()BaseSortingExtractorInterface.units_idsBaseSortingExtractorInterface.register_recording()BaseSortingExtractorInterface.get_original_timestamps()BaseSortingExtractorInterface.get_timestamps()BaseSortingExtractorInterface.set_aligned_timestamps()BaseSortingExtractorInterface.set_aligned_segment_timestamps()BaseSortingExtractorInterface.set_aligned_starting_time()BaseSortingExtractorInterface.set_aligned_segment_starting_times()BaseSortingExtractorInterface.subset_sorting()BaseSortingExtractorInterface.add_channel_metadata_to_nwb()BaseSortingExtractorInterface.add_to_nwbfile()BaseSortingExtractorInterface.rename_unit_ids()
- AlphaOmega
AlphaOmegaRecordingInterfaceAlphaOmegaRecordingInterface.display_nameAlphaOmegaRecordingInterface.associated_suffixesAlphaOmegaRecordingInterface.infoAlphaOmegaRecordingInterface.stream_idAlphaOmegaRecordingInterface.get_source_schema()AlphaOmegaRecordingInterface.get_extractor_class()AlphaOmegaRecordingInterface.get_metadata()
- Axon Recording
- Axona Recording
AxonaRecordingInterfaceAxonaRecordingInterface.display_nameAxonaRecordingInterface.associated_suffixesAxonaRecordingInterface.infoAxonaRecordingInterface.get_source_schema()AxonaRecordingInterface.get_extractor_class()AxonaRecordingInterface.extract_nwb_file_metadata()AxonaRecordingInterface.extract_ecephys_metadata()AxonaRecordingInterface.get_metadata()
AxonaUnitRecordingInterfaceAxonaLFPDataInterfaceAxonaPositionDataInterface
- Biocam Recording
- Blackrock Recording
- CellExplorer Sorting
add_channel_metadata_to_recoder()add_channel_metadata_to_recorder_from_session_file()add_channel_metadata_to_recorder_from_channel_map_file()CellExplorerRecordingInterfaceCellExplorerRecordingInterface.display_nameCellExplorerRecordingInterface.associated_suffixesCellExplorerRecordingInterface.infoCellExplorerRecordingInterface.sampling_frequency_keyCellExplorerRecordingInterface.binary_file_extensionCellExplorerRecordingInterface.get_extractor_class()CellExplorerRecordingInterface.get_source_schema()CellExplorerRecordingInterface.get_original_timestamps()
CellExplorerLFPInterfaceCellExplorerLFPInterface.display_nameCellExplorerLFPInterface.keywordsCellExplorerLFPInterface.associated_suffixesCellExplorerLFPInterface.infoCellExplorerLFPInterface.sampling_frequency_keyCellExplorerLFPInterface.binary_file_extensionCellExplorerLFPInterface.get_metadata()CellExplorerLFPInterface.add_to_nwbfile()
CellExplorerSortingInterface
- European Data Format (EDF) Recording
EDFRecordingInterfaceEDFRecordingInterface.display_nameEDFRecordingInterface.keywordsEDFRecordingInterface.associated_suffixesEDFRecordingInterface.infoEDFRecordingInterface.get_source_schema()EDFRecordingInterface.get_stream_names()EDFRecordingInterface.get_available_channel_ids()EDFRecordingInterface.get_extractor_class()EDFRecordingInterface.extract_nwb_file_metadata()EDFRecordingInterface.extract_subject_metadata()EDFRecordingInterface.get_metadata()
- European Data Format (EDF) Analog
EDFAnalogInterfaceEDFAnalogInterface.display_nameEDFAnalogInterface.keywordsEDFAnalogInterface.associated_suffixesEDFAnalogInterface.infoEDFAnalogInterface.get_source_schema()EDFAnalogInterface.get_stream_names()EDFAnalogInterface.get_available_channel_ids()EDFAnalogInterface.channel_idsEDFAnalogInterface.get_metadata()EDFAnalogInterface.add_to_nwbfile()
- Intan Amplifier
IntanRecordingInterfaceIntanRecordingInterface.display_nameIntanRecordingInterface.keywordsIntanRecordingInterface.associated_suffixesIntanRecordingInterface.infoIntanRecordingInterface.stream_idIntanRecordingInterface.get_source_schema()IntanRecordingInterface.get_extractor_class()IntanRecordingInterface.get_metadata()
- Intan Analog
- Intan Stimulation
IntanStimInterfaceIntanStimInterface.parent_containerIntanStimInterface.display_nameIntanStimInterface.keywordsIntanStimInterface.associated_suffixesIntanStimInterface.infoIntanStimInterface.get_source_schema()IntanStimInterface.get_metadata()IntanStimInterface.get_channel_names()IntanStimInterface.add_to_nwbfile()
- KiloSort Sorting
- MaxOne Recording
- MCSRaw Recording
- MEArec Recording
- Neuralynx Recording & Sorting
NeuralynxRecordingInterfaceNeuralynxRecordingInterface.display_nameNeuralynxRecordingInterface.associated_suffixesNeuralynxRecordingInterface.infoNeuralynxRecordingInterface.get_stream_names()NeuralynxRecordingInterface.get_source_schema()NeuralynxRecordingInterface.get_extractor_class()NeuralynxRecordingInterface.get_metadata()
NeuralynxSortingInterfaceextract_neo_header_metadata()
- NeuroScope Recording & Sorting
filter_non_neural_channels()add_recording_extractor_properties()NeuroScopeRecordingInterfaceNeuroScopeRecordingInterface.display_nameNeuroScopeRecordingInterface.associated_suffixesNeuroScopeRecordingInterface.infoNeuroScopeRecordingInterface.get_extractor_class()NeuroScopeRecordingInterface.get_source_schema()NeuroScopeRecordingInterface.get_ecephys_metadata()NeuroScopeRecordingInterface.get_metadata()NeuroScopeRecordingInterface.get_original_timestamps()
NeuroScopeLFPInterfaceNeuroScopeSortingInterface
- OpenEphys Recording
- Phy Sorting
- Plexon Recording & Sorting
- Spike2
- Spikegadgets Recording
- SpikeGLX Recording
SpikeGLXConverterPipeSpikeGLXRecordingInterfaceSpikeGLXRecordingInterface.display_nameSpikeGLXRecordingInterface.keywordsSpikeGLXRecordingInterface.associated_suffixesSpikeGLXRecordingInterface.infoSpikeGLXRecordingInterface.get_source_schema()SpikeGLXRecordingInterface.get_extractor_class()SpikeGLXRecordingInterface.get_metadata()SpikeGLXRecordingInterface.get_original_timestamps()
SpikeGLXNIDQInterfaceSpikeGLXNIDQInterface.display_nameSpikeGLXNIDQInterface.keywordsSpikeGLXNIDQInterface.associated_suffixesSpikeGLXNIDQInterface.infoSpikeGLXNIDQInterface.get_source_schema()SpikeGLXNIDQInterface.get_metadata()SpikeGLXNIDQInterface.get_channel_names()SpikeGLXNIDQInterface.add_to_nwbfile()SpikeGLXNIDQInterface.get_event_times_from_ttl()
- Tucker-Davis Technologies (TDT) Recording
- White Matter Recording
- XClust Sorting
- Base Recording
- Intracellular Electrophysiology
- Optical Physiology
- Imaging
- Segmentation
- Image
- Fiber Photometry
- Base Fiber Photometry
BaseFiberPhotometryInterfaceBaseFiberPhotometryInterface.keywordsBaseFiberPhotometryInterface.get_original_timestamps()BaseFiberPhotometryInterface.get_timestamps()BaseFiberPhotometryInterface.set_aligned_timestamps()BaseFiberPhotometryInterface.set_aligned_starting_time()BaseFiberPhotometryInterface.align_by_interpolation()BaseFiberPhotometryInterface.get_metadata()BaseFiberPhotometryInterface.get_metadata_template()BaseFiberPhotometryInterface.get_metadata_schema()BaseFiberPhotometryInterface.add_to_nwbfile()
- Doric Fiber Photometry
- TDT Fiber Photometry
TDTFiberPhotometryInterfaceTDTFiberPhotometryInterface.keywordsTDTFiberPhotometryInterface.display_nameTDTFiberPhotometryInterface.infoTDTFiberPhotometryInterface.associated_suffixesTDTFiberPhotometryInterface.get_available_streams()TDTFiberPhotometryInterface.get_metadata()TDTFiberPhotometryInterface.get_metadata_schema()TDTFiberPhotometryInterface.get_conversion_options_schema()TDTFiberPhotometryInterface.get_original_timestamps()TDTFiberPhotometryInterface.get_timestamps()TDTFiberPhotometryInterface.set_aligned_timestamps()TDTFiberPhotometryInterface.set_aligned_starting_time()TDTFiberPhotometryInterface.add_to_nwbfile()
- CSV Fiber Photometry
- Multi-File CSV Fiber Photometry
- NPM Fiber Photometry
- pyPhotometry Fiber Photometry
PyPhotometryFiberPhotometryInterfacePyPhotometryFiberPhotometryInterface.display_namePyPhotometryFiberPhotometryInterface.associated_suffixesPyPhotometryFiberPhotometryInterface.infoPyPhotometryFiberPhotometryInterface.get_available_streams()PyPhotometryFiberPhotometryInterface.get_metadata()PyPhotometryFiberPhotometryInterface.add_to_nwbfile()
PyPhotometryConverter
- GuPPy Fiber Photometry
GuppyInterfaceGuppyInterface.keywordsGuppyInterface.display_nameGuppyInterface.infoGuppyInterface.associated_suffixesGuppyInterface.recording_sitesGuppyInterface.event_namesGuppyInterface.analyzed_event_onsetsGuppyInterface.recording_site_to_store_idsGuppyInterface.event_store_to_event_nameGuppyInterface.get_metadata()GuppyInterface.get_metadata_schema()GuppyInterface.add_to_nwbfile()
GuppyConverter
- Base Fiber Photometry
- Behavior
- Audio
AudioInterfaceAudioInterface.display_nameAudioInterface.keywordsAudioInterface.associated_suffixesAudioInterface.infoAudioInterface.get_metadata_schema()AudioInterface.get_metadata()AudioInterface.get_original_timestamps()AudioInterface.get_timestamps()AudioInterface.set_aligned_timestamps()AudioInterface.set_aligned_starting_time()AudioInterface.set_aligned_segment_starting_times()AudioInterface.align_by_interpolation()AudioInterface.add_to_nwbfile()
- BORIS
- DeepLabCut
DeepLabCutInterfaceDeepLabCutInterface.display_nameDeepLabCutInterface.keywordsDeepLabCutInterface.associated_suffixesDeepLabCutInterface.infoDeepLabCutInterface.get_source_schema()DeepLabCutInterface.get_available_subjects()DeepLabCutInterface.get_metadata_schema()DeepLabCutInterface.get_metadata()DeepLabCutInterface.get_original_timestamps()DeepLabCutInterface.get_timestamps()DeepLabCutInterface.set_aligned_timestamps()DeepLabCutInterface.add_to_nwbfile()
- FicTrac
FicTracDataInterfaceFicTracDataInterface.display_nameFicTracDataInterface.keywordsFicTracDataInterface.associated_suffixesFicTracDataInterface.infoFicTracDataInterface.timestamps_columnFicTracDataInterface.columns_in_dat_fileFicTracDataInterface.column_to_nwb_mappingFicTracDataInterface.spatial_series_descriptionsFicTracDataInterface.get_source_schema()FicTracDataInterface.get_metadata()FicTracDataInterface.add_to_nwbfile()FicTracDataInterface.get_original_timestamps()FicTracDataInterface.get_timestamps()FicTracDataInterface.set_aligned_timestamps()FicTracDataInterface.set_aligned_starting_time()
extract_session_start_time()parse_fictrac_config()
- LightningPose
- Neuralynx NVT
NeuralynxNvtInterfaceNeuralynxNvtInterface.display_nameNeuralynxNvtInterface.keywordsNeuralynxNvtInterface.associated_suffixesNeuralynxNvtInterface.infoNeuralynxNvtInterface.get_original_timestamps()NeuralynxNvtInterface.get_timestamps()NeuralynxNvtInterface.set_aligned_timestamps()NeuralynxNvtInterface.get_metadata()NeuralynxNvtInterface.get_metadata_schema()NeuralynxNvtInterface.add_to_nwbfile()
- SLEAP
SLEAPInterfaceSLEAPInterface.display_nameSLEAPInterface.keywordsSLEAPInterface.associated_suffixesSLEAPInterface.infoSLEAPInterface.get_source_schema()SLEAPInterface.get_available_tracks()SLEAPInterface.get_available_videos()SLEAPInterface.get_original_timestamps()SLEAPInterface.get_timestamps()SLEAPInterface.set_aligned_timestamps()SLEAPInterface.add_to_nwbfile()SLEAPInterface.get_metadata()
- Video
- MedPC
MedPCInterfaceMedPCInterface.keywordsMedPCInterface.display_nameMedPCInterface.infoMedPCInterface.associated_suffixesMedPCInterface.get_metadata()MedPCInterface.get_metadata_schema()MedPCInterface.get_original_timestamps()MedPCInterface.get_timestamps()MedPCInterface.set_aligned_timestamps()MedPCInterface.set_aligned_starting_time()MedPCInterface.add_to_nwbfile()
- VAME
VameInterfaceVameInterface.display_nameVameInterface.keywordsVameInterface.associated_suffixesVameInterface.infoVameInterface.get_source_schema()VameInterface.get_metadata_schema()VameInterface.get_metadata()VameInterface.get_original_timestamps()VameInterface.get_timestamps()VameInterface.set_aligned_timestamps()VameInterface.get_available_sessions()VameInterface.add_to_nwbfile()
- keypoint-MoSeq
MoseqKeyPointsInterfaceMoseqKeyPointsInterface.display_nameMoseqKeyPointsInterface.keywordsMoseqKeyPointsInterface.associated_suffixesMoseqKeyPointsInterface.infoMoseqKeyPointsInterface.get_source_schema()MoseqKeyPointsInterface.get_available_recordings()MoseqKeyPointsInterface.get_metadata_schema()MoseqKeyPointsInterface.get_metadata()MoseqKeyPointsInterface.add_to_nwbfile()
- Audio
- Events
- Text
- Time Intervals
TimeIntervalsInterfaceTimeIntervalsInterface.keywordsTimeIntervalsInterface.get_metadata()TimeIntervalsInterface.get_metadata_schema()TimeIntervalsInterface.get_original_timestamps()TimeIntervalsInterface.get_timestamps()TimeIntervalsInterface.set_aligned_starting_time()TimeIntervalsInterface.set_aligned_timestamps()TimeIntervalsInterface.align_by_interpolation()TimeIntervalsInterface.add_to_nwbfile()
- CSV
- Excel
- Time Intervals