Overview
isx
is a python package for interacting with Inscopix data.
This package encapsulates the following I/O functionality:
Reading Inscopix files (
.isxd
,.isxb
,.gpio
,.imu
)Writing Inscopix files (
.isxd
)Exporting Inscopix files to third-party formats (
.mp4
,.tiff
,.csv
)
The isx
package is built from the pyisx
project, a python binding for isxcore, a C++ API for interacting with Inscopix data.
Install
This package is available on pypi.
To install isx
, run the following command in a python environment:
pip install isx
Attention
Currently, pyisx is only supported for x86 architectures, which can be problematic, specifically on the newer Mac computers with Apple Silicon. For usage with Apple Silicon, the Rosetta software must be installed, and the Terminal app must be configured to use this software for automatic translation of x86 binaries to arm64. Read more here on how to configure Rosetta on Mac computers.
Please refer to the Installation guide for more details.
File Types
This package encapsulates the following I/O functionality:
The following table summarizes all Inscopix file types and the functionality supported by this package:
File Type |
File Format |
Read |
Write |
Export |
Description |
---|---|---|---|---|---|
|
|
Yes |
Yes |
|
Recording acquired from a microscope |
|
|
Yes |
Yes |
|
Image acquired from a microscope |
|
|
Yes |
No |
|
Compressed recording acquired from a behavior camera |
|
|
Yes |
Yes |
|
Neural cells represented as a set of temporal activity traces and spatial footprints. A |
|
|
Yes |
Yes |
|
Neural events (e.g., calcium events) represented as a set of discrete signal traces. An |
|
|
Yes |
Yes |
|
Vessels represented as a set of vessel diameter or red blood cell (rbc) velocity traces. A |
|
|
Yes |
No |
|
General purpose input/output signals recorded from an acquisition device |
|
|
Yes |
No |
|
Inertial measurement unit (accelerometer, magnetometer, orientation) recorded from an acquisition device |
|
|
No |
No |
N/A |
Compressed recording acquired from a microscope. A |
Next Steps
To learn more about how to use the isx
package, refer to the Examples guide and the API Reference.