Open service¶
Open acquisition files into transport-neutral API v2 models.
OpenServiceError ¶
Bases: Exception
Domain error with a stable machine-readable API v2 code.
open_acquisition ¶
open_acquisition(
path: str,
*,
channel_indices: Sequence[int] | None = None,
) -> OpenedAcquisition
Open one file and return generic selected 2-D channel planes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str
|
Filesystem path to an acquisition supported by AcqStore. |
required |
channel_indices
|
Sequence[int] | None
|
Optional ordered source-channel indices. |
None
|
Returns:
| Type | Description |
|---|---|
OpenedAcquisition
|
Transport-neutral acquisition data. Arrays preserve their source dtype. |
Raises:
| Type | Description |
|---|---|
OpenServiceError
|
For path, format, channel, calibration, or decoding failures. |