diff --git a/CHANGELOG.md b/CHANGELOG.md index ce0a17740..3595d40a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ # Upcoming +### Features +* The `OpenEphysRecordingInterface` is now a wrapper for `OpenEphysBinaryRecordingInterface`. [PR #294](https://github.com/catalystneuro/neuroconv/pull/294) # v0.2.4 diff --git a/src/neuroconv/datainterfaces/__init__.py b/src/neuroconv/datainterfaces/__init__.py index 5d4a8f0f0..cafd6153d 100644 --- a/src/neuroconv/datainterfaces/__init__.py +++ b/src/neuroconv/datainterfaces/__init__.py @@ -19,8 +19,8 @@ BlackrockRecordingInterface, BlackrockSortingInterface, ) -from .ecephys.openephys.openephysdatainterface import ( - OpenEphysRecordingInterface, +from .ecephys.openephys.openephysbinarydatainterface import ( + OpenEphysRecordingInterface, # temporary import until transitioning to the renamed interface OpenEphysSortingInterface, ) from .ecephys.axona.axonadatainterface import ( diff --git a/src/neuroconv/datainterfaces/ecephys/openephys/openephysdatainterface.py b/src/neuroconv/datainterfaces/ecephys/openephys/openephysbinarydatainterface.py similarity index 89% rename from src/neuroconv/datainterfaces/ecephys/openephys/openephysdatainterface.py rename to src/neuroconv/datainterfaces/ecephys/openephys/openephysbinarydatainterface.py index 91991f185..d6f348e09 100644 --- a/src/neuroconv/datainterfaces/ecephys/openephys/openephysdatainterface.py +++ b/src/neuroconv/datainterfaces/ecephys/openephys/openephysbinarydatainterface.py @@ -7,8 +7,8 @@ from ....utils import get_schema_from_method_signature, FolderPathType -class OpenEphysRecordingInterface(BaseRecordingExtractorInterface): - """Primary data interface for converting OpenEphys data. Uses +class OpenEphysBinaryRecordingInterface(BaseRecordingExtractorInterface): + """Primary data interface for converting binary OpenEphys data (.dat files). Uses :py:class:`~spikeinterface.extractors.OpenEphysBinaryRecordingExtractor`.""" ExtractorName = "OpenEphysBinaryRecordingExtractor" @@ -19,7 +19,9 @@ def get_source_schema(cls): source_schema = get_schema_from_method_signature( class_method=cls.__init__, exclude=["recording_id", "experiment_id", "stub_test"] ) - source_schema["properties"]["folder_path"]["description"] = "Path to directory containing OpenEphys files." + source_schema["properties"]["folder_path"][ + "description" + ] = "Path to directory containing OpenEphys binary files." return source_schema def __init__( @@ -88,6 +90,11 @@ def get_metadata(self): return metadata +# Temporary solution for safely transitioning to the renamed interface +class OpenEphysRecordingInterface(OpenEphysBinaryRecordingInterface): + ExtractorName = "OpenEphysBinaryRecordingExtractor" + + class OpenEphysSortingInterface(BaseSortingExtractorInterface): """Primary data interface class for converting OpenEphys spiking data."""