radiens_core.curate_client

CurateClient — deprecated alias for VidereClient.

.. deprecated:: 0.0.7 CurateClient has been merged into VidereClient and will be removed in 0.1.0. Replace CurateClient() with VidereClient().

Classes

CurateClient

Bases: VidereClient

Deprecated. Use :class:VidereClient instead.

All data curation and transform operations (filtering, re-referencing, downsampling, slicing, protocol management, and bulk variants) are now available directly on :class:VidereClient.

.. deprecated:: 0.0.7 CurateClient has been merged into VidereClient and will be removed in 0.1.0. Replace CurateClient() with VidereClient().

Attributes

server_version property

server_version

Detected radiensserver version for this client instance.

Functions

apply_protocol

apply_protocol(protocol_id)

Re-apply a previously registered protocol by ID.

Parameters:

Name	Type	Description	Default
protocol_id	str	The ID of a protocol already registered with the server (e.g., returned from a previous transform call).	required

bandpass

bandpass(
    dataset, low_freq, high_freq, output_path, *, order=None
)

Apply a band-pass filter to a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to filter (metadata or ID).	required
low_freq	float	Lower cutoff frequency in Hz.	required
high_freq	float	Upper cutoff frequency in Hz.	required
output_path	str | Path	Where to save the result.	required
order	int | None	Filter order. If None, the server default is used.	None

Returns:

Type	Description
DatasetMetadata	Metadata for the new (filtered) dataset.

bandstop

bandstop(
    dataset, low_freq, high_freq, output_path, *, order=None
)

Apply a band-stop (band-reject) filter to a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to filter (metadata or ID).	required
low_freq	float	Lower cutoff frequency in Hz.	required
high_freq	float	Upper cutoff frequency in Hz.	required
output_path	str | Path	Where to save the result.	required
order	int | None	Filter order. If None, the server default is used.	None

Returns:

Type	Description
DatasetMetadata	Metadata for the new (filtered) dataset.

bulk_bandpass

bulk_bandpass(
    sources,
    low_freq,
    high_freq,
    output_dir,
    output_suffix,
    *,
    order=None,
)

Apply band-pass filter to multiple datasets at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to filter (metadata or IDs).	required
low_freq	float	Lower cutoff frequency in Hz.	required
high_freq	float	Upper cutoff frequency in Hz.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required
order	int | None	Filter order. If None, the server default is used.	None

bulk_bandstop

bulk_bandstop(
    sources,
    low_freq,
    high_freq,
    output_dir,
    output_suffix,
    *,
    order=None,
)

Apply band-stop filter to multiple datasets at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to filter (metadata or IDs).	required
low_freq	float	Lower cutoff frequency in Hz.	required
high_freq	float	Upper cutoff frequency in Hz.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required
order	int | None	Filter order. If None, the server default is used.	None

bulk_downsample

bulk_downsample(sources, factor, output_dir, output_suffix)

Downsample multiple datasets at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to downsample (metadata or IDs).	required
factor	int	Downsampling factor (e.g., 2, 4, 10).	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required

bulk_highpass

bulk_highpass(
    sources,
    frequency,
    output_dir,
    output_suffix,
    *,
    order=None,
)

Apply high-pass filter to multiple datasets at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to filter (metadata or IDs).	required
frequency	float	Cutoff frequency in Hz.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required
order	int | None	Filter order. If None, the server default is used.	None

bulk_lowpass

bulk_lowpass(
    sources,
    frequency,
    output_dir,
    output_suffix,
    *,
    order=None,
)

Apply low-pass filter to multiple datasets at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to filter (metadata or IDs).	required
frequency	float	Cutoff frequency in Hz.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required
order	int | None	Filter order. If None, the server default is used.	None

bulk_notch

bulk_notch(
    sources,
    notch_freq,
    bandwidth,
    output_dir,
    output_suffix,
)

Apply notch filter to multiple datasets at once.

The notch filter is always second-order (scipy.signal.iirnotch). Unlike other IIR filters, it does not accept a custom order.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to filter (metadata or IDs).	required
notch_freq	float	Center frequency to reject in Hz.	required
bandwidth	float	Width of the rejection band in Hz.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required

bulk_slice_time

bulk_slice_time(
    sources, start_sec, end_sec, output_dir, output_suffix
)

Slice multiple datasets in time at once.

Parameters:

Name	Type	Description	Default
sources	Sequence[FlexDataset]	Datasets to slice (metadata or IDs).	required
start_sec	float	Start time in seconds.	required
end_sec	float	End time in seconds.	required
output_dir	str | Path	Directory where output files will be written.	required
output_suffix	str	Suffix appended to each output file's base name.	required

car

car(dataset, output_path)

Apply Common Average Reference (CAR) re-referencing to a dataset.

Subtracts the mean signal across all channels from each channel. This is the most widely used reference scheme in LFP and spike analysis.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to re-reference (metadata or ID).	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (re-referenced) dataset.

clear_data_sources

clear_data_sources(dsource_ids)

Clear (unlink) data sources from the server.

Parameters:

Name	Type	Description	Default
dsource_ids	list[str] | str	List of IDs (or a single ID) to clear.	required

Returns:

Type	Description
list[str]	List of successfully cleared IDs.

close

close()

Close all gRPC channels managed by this client.

copy_data_source_file

copy_data_source_file(src_path, dest_path, *, force=False)

Copy a server-side data source file to a new location.

Parameters:

Name	Type	Description	Default
src_path	str | Path	Source file path on the server.	required
dest_path	str | Path	Destination file path on the server.	required
force	bool	If True, overwrite existing destination file.	False

downsample

downsample(dataset, factor, output_path)

Downsample a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to downsample (metadata or ID).	required
factor	int	Downsampling factor (e.g., 2, 4, 10).	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (downsampled) dataset.

export_data_source

export_data_source(dsource, dest_path, force=False)

Export a data source to a new file.

Parameters:

Name	Type	Description	Default
dsource	FlexDataset	The data source to export (ID or metadata object).	required
dest_path	str | Path	Destination file path.	required
force	bool	If True, overwrite existing destination file.	False

get_all_protocols

get_all_protocols()

List all saved protocols on the server.

Returns:

Type	Description
list[ProtocolSpec]	Summary of every protocol currently registered.

get_detect_params

get_detect_params(spike_sorter_id, channels=None)

Fetch active detection configurations per channel.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter.	required
channels	list[int] | None	Optional list of native channel indices. If None, returns params for all configured channels.	None

Returns:

Type	Description
dict[int, SpikeDetectParams]	Map from native channel index to its SpikeDetectParams.

get_dsp_group

get_dsp_group(dataset)

Get DSP filter configuration for a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required

Returns:

Type	Description
DSPGroup	The current hardware and software filter parameters.

get_kpi_metrics

get_kpi_metrics(
    dataset,
    metrics,
    channel_indices=None,
    time_range=None,
    signal_type=SignalType.AMP,
)

Retrieve computed KPI signal metrics for a linked dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
metrics	list[FlexKpiMetricId]	List of KPI metric identifiers. Accepts KpiMetricId objects, metric name strings (default KpiMode.BASE), or (mode, name) tuples.	required
channel_indices	list[int] | None	Native channel indices (ntvIdxs) to query. None returns metrics for all channels.	None
time_range	FlexTimeRange | None	Time range within the dataset (e.g. [start, end] in seconds). None returns metrics over the full recording. Lookback mode is not supported for offline files.	None
signal_type	FlexSignalType	Signal type to query. Accepts SignalType enum or string name (e.g. "amp"). Defaults to AMP.	AMP

Returns:

Type	Description
KpiMetricsResult	Metric values as a (n_channels, n_metrics) numpy array with row/column labels.

Raises:

Type	Description
ValueError	If lookback time range mode is used (not supported offline).
RadiensError	On communication failure or server error.

get_kpi_status

get_kpi_status(dataset)

Get the current KPI cache status for a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required

Returns:

Type	Description
KpiStatus	Number of packets in cache, packet duration, memory usage, and availability state.

get_neurons

get_neurons(
    dataset,
    channels=None,
    time_range=None,
    *,
    spikes_id=None,
)

Retrieve neuron descriptors for a linked dataset.

Returns spike count, rate, SNR, waveform peak amplitude, and probe position for each sorted neuron, organized by recording channel.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
channels	FlexSignalSpec | None	Channels to include. Accepts a list[int] of amplifier channel indices, a SignalSpec, "all", or None. None returns all amplifier channels.	None
time_range	FlexTimeRange | None	Time range within the dataset (e.g. [start, end] in seconds). None returns neurons over the full recording. Lookback mode is not supported for offline files.	None
spikes_id	str | None	Explicit spikes datasource ID. When None (the default), uses the first entry from DatasetMetadata.associated_spikes_ids.	None

Returns:

Type	Description
NeuronsResult	Neuron descriptors grouped by native channel index.

Raises:

Type	Description
ValueError	If lookback time range mode is used (not supported offline).
RadiensError	On communication failure or server error.

get_protocol

get_protocol(protocol_id)

Retrieve a saved protocol by ID.

Parameters:

Name	Type	Description	Default
protocol_id	str	ID of the protocol to retrieve.	required

Returns:

Type	Description
ProtocolSpec	Minimal summary of the protocol.

get_signals

get_signals(dataset, time_range=None, signals=None)

Retrieve signal data for a specific time range and channel selection.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
time_range	FlexTimeRange | None	Exact time range in seconds — [start, end] or TimeRangeSpec.subset(start, end). None returns the full recording. Only SUBSET mode is supported.	None
signals	FlexSignalSpec | None	Signal selection (e.g. list of amplifier channel indices). None returns all amplifier channels.	None

Returns:

Type	Description
SignalArrays	The requested signal data as numpy arrays.

Raises:

Type	Description
ValueError	If a non-SUBSET time range mode is provided.
RadiensError	On communication failure or server error.

get_spike_sorter_dashboard

get_spike_sorter_dashboard(spike_sorter_id, elements=None)

Get the spike sorter dashboard for monitoring sorting progress.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter to query.	required
elements	list[FlexDashElement] | None	Optional list of dashboard elements to include. Each element can be a DashElement enum, string name (e.g. "general"), or int value (1-8). If None, returns all default elements.	None

Returns:

Type	Description
SpikeSorterDashboard	Comprehensive dashboard data including summary metrics and port status.

get_spike_sorter_ids

get_spike_sorter_ids(dataset)

Get the IDs of all active spike sorters for a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required

Returns:

Type	Description
list[str]	List of active spike sorter IDs.

get_spike_sorter_state

get_spike_sorter_state(spike_sorter_id)

Get the current state and progress of a spike sorter.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter to query.	required

Returns:

Type	Description
SpikeSorterState	Current state including system status, progress, and messages.

get_spikes_by_channel

get_spikes_by_channel(
    dataset,
    channels=None,
    time_range=None,
    include_waveforms=False,
    *,
    spikes_id=None,
)

Retrieve spike timestamps and neuron labels per recording channel.

Returns one ChannelSpikeData entry per channel that has spikes in the requested time range.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
channels	FlexSignalSpec | None	Channels to include. Accepts a list[int] of amplifier channel indices, a SignalSpec, "all", or None. None returns all amplifier channels.	None
time_range	FlexTimeRange | None	Time range within the dataset (e.g. [start, end] in seconds). None returns spikes over the full recording. Lookback mode is not supported for offline files.	None
include_waveforms	bool	If True, also fetch waveform snippets for each spike. Adds a second RPC call. Default False.	False
spikes_id	str | None	Explicit spikes datasource ID. When None (the default), uses the first entry from DatasetMetadata.associated_spikes_ids.	None

Returns:

Type	Description
dict[int, ChannelSpikeData]	Map from native channel index to spike data.

Raises:

Type	Description
ValueError	If lookback time range mode is used (not supported offline).
RadiensError	On communication failure or server error.

get_spikes_by_neuron

get_spikes_by_neuron(
    dataset,
    channels=None,
    time_range=None,
    include_waveforms=False,
    *,
    spikes_id=None,
)

Retrieve spike timestamps per sorted neuron.

Same data as get_spikes_by_channel() but regrouped by neuron identity rather than by channel.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
channels	FlexSignalSpec | None	Channels to include. Accepts a list[int] of amplifier channel indices, a SignalSpec, "all", or None. None returns all amplifier channels.	None
time_range	FlexTimeRange | None	Time range within the dataset (e.g. [start, end] in seconds). None returns spikes over the full recording. Lookback mode is not supported for offline files.	None
include_waveforms	bool	If True, also fetch waveform snippets for each spike. Adds a second RPC call. Default False.	False
spikes_id	str | None	Explicit spikes datasource ID. When None (the default), uses the first entry from DatasetMetadata.associated_spikes_ids.	None

Returns:

Type	Description
dict[int, NeuronSpikeData]	Map from integer neuron label to spike data.

Raises:

Type	Description
ValueError	If lookback time range mode is used (not supported offline).
RadiensError	On communication failure or server error.

get_spikes_spec

get_spikes_spec(dataset, *, spikes_id=None)

Retrieve spike interface metadata for a linked dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to query (metadata object, ID string, or file path).	required
spikes_id	str | None	Explicit spikes datasource ID. When None (the default), uses the first entry from DatasetMetadata.associated_spikes_ids.	None

Returns:

Type	Description
SpikesSpec	Spike metadata including the biointerface ID, enabled channel indices, and spike time range.

Raises:

Type	Description
RadiensError	On communication failure or server error.

healthcheck

healthcheck(service=ServiceEndpoint.RADIENS_LIFECYCLE)

Verify the radiensserver is responsive.

Parameters:

Name	Type	Description	Default
service	ServiceEndpoint	Which gRPC service to probe (default RADIENS_LIFECYCLE). RADIENS_CORE is also supported.	RADIENS_LIFECYCLE

Raises:

Type	Description
RadiensError	If the health check fails or the server is unresponsive.

highpass

highpass(dataset, frequency, output_path, *, order=None)

Apply a high-pass filter to a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to filter (metadata or ID).	required
frequency	float	Cutoff frequency in Hz.	required
output_path	str | Path	Where to save the result.	required
order	int | None	Filter order. If None, the server default is used.	None

Returns:

Type	Description
DatasetMetadata	Metadata for the new (filtered) dataset.

kpi_calculate

kpi_calculate(dataset)

Trigger KPI computation for a linked dataset.

Must be called before get_kpi_metrics returns useful data on a freshly linked file.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to compute KPIs for (metadata object, ID string, or file path).	required

Raises:

Type	Description
RadiensError	On communication failure or server error.

kpi_clear

kpi_clear(dataset)

Clear the KPI cache for a dataset.

Resets accumulated KPI state. Useful before rerunning with changed parameters.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to clear KPI state for (metadata object, ID string, or file path).	required

Raises:

Type	Description
RadiensError	On communication failure or server error.

link_data_file

link_data_file(fpath, file_type=None)

Link a recording file and return its metadata.

Also discovers and registers any associated .spikes file found alongside the recording. If found, the returned DatasetMetadata will have associated_spikes_ids populated, enabling the spike data methods on VidereClient.

Parameters:

Name	Type	Description	Default
path		Path to the recording file (e.g. .xdat, .rhd).	required

Returns:

Type	Description
DatasetMetadata	Metadata for the linked dataset.

Raises:

Type	Description
RadiensError	On communication failure or server error.

list_data_source_ids

list_data_source_ids()

List IDs of all currently linked data sources.

Returns:

Type	Description
list[str]	List of data source IDs.

list_data_sources

list_data_sources(dsource_ids=None)

List linked data sources and their metadata.

Parameters:

Name	Type	Description	Default
dsource_ids	list[str] | str | None	Optional list of specific IDs to query. If None, lists all.	None

Returns:

Type	Description
dict[str, DatasetMetadata]	Map of data source ID to metadata.

list_directory

list_directory(directory)

List files in a remote server-side directory.

Parameters:

Name	Type	Description	Default
directory	str | Path	Server-side directory path to list.	required

Returns:

Type	Description
list[FileInfo]	Metadata for each file found in the directory.

lowpass

lowpass(dataset, frequency, output_path, *, order=None)

Apply a low-pass filter to a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to filter (metadata or ID).	required
frequency	float	Cutoff frequency in Hz.	required
output_path	str | Path	Where to save the result.	required
order	int | None	Filter order. If None, the server default is used.	None

Returns:

Type	Description
DatasetMetadata	Metadata for the new (filtered) dataset.

move_data_source_file

move_data_source_file(src_path, dest_path, *, force=False)

Move a server-side data source file to a new location.

Parameters:

Name	Type	Description	Default
src_path	str | Path	Source file path on the server.	required
dest_path	str | Path	Destination file path on the server.	required
force	bool	If True, overwrite existing destination file.	False

notch

notch(dataset, frequency, bandwidth, output_path)

Apply a notch filter to a dataset.

The notch filter is always second-order (scipy.signal.iirnotch). Unlike other IIR filters, it does not accept a custom order.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to filter (metadata or ID).	required
frequency	float	Center frequency to reject, in Hz (e.g., 60.0 for line noise).	required
bandwidth	float	Width of the rejection band in Hz.	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (filtered) dataset.

paired_ref

paired_ref(
    dataset, ref_channel, target_channel, output_path
)

Apply paired re-referencing between two specific channels.

References one target channel against one reference channel.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to re-reference (metadata or ID).	required
ref_channel	int	Native channel index of the reference electrode.	required
target_channel	int	Native channel index of the channel to re-reference.	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (re-referenced) dataset.

remove_data_source_file

remove_data_source_file(path, *, force=False)

Remove a server-side data source file.

Parameters:

Name	Type	Description	Default
path	str | Path	File path on the server to remove.	required
force	bool	If True, force removal even if the file is in use.	False

set_detect_params

set_detect_params(spike_sorter_id, params, channels)

Bulk-apply threshold, shadow, and window updates to targeted channels.

Fields in params that are None will not be modified.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter.	required
params	SpikeDetectParams	The detection parameters to apply.	required
channels	list[int]	List of native channel indices to apply the parameters to.	required

set_dsp_group

set_dsp_group(dataset, *, stage, params)

Update DSP filter configuration for a specific dataset and stage.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to update (metadata object, ID string, or file path).	required
stage	FlexFilterStage	The filter stage to update. Accepts FilterStage enum, string alias ("stage1", "hw"), or int index (0-3).	required
params	list[FlexDSPParams]	List of filter parameters for this stage. Each item can be a DSPParams object or a dict (stage is injected from stage if omitted).	required

set_kpi_packet_dur

set_kpi_packet_dur(dataset, packet_dur)

Set the KPI packet duration (integration window) for a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to configure (metadata object, ID string, or file path).	required
packet_dur	float	Duration of each KPI packet in seconds.	required

Raises:

Type	Description
RadiensError	On communication failure or server error.

set_protocol

set_protocol(nodes, edges, *, protocol_id=None)

Register a custom protocol with the server.

Build a directed acyclic graph of transform nodes and register it for later execution with apply_protocol(). The server validates the graph and returns a summary.

Use TransformNode factory methods to construct nodes, and TransformEdge to wire them together::

src  = TransformNode.source(meta)
hp   = TransformNode.highpass(300.0)
car  = TransformNode.car()
snk  = TransformNode.sink("result", "/output", RadiensFileType.XDAT)

edges = [
    TransformEdge(source=src.id, target=hp.id),
    TransformEdge(source=hp.id, target=car.id),
    TransformEdge(source=car.id, target=snk.id),
]

spec = client.set_protocol([src, hp, car, snk], edges)
client.apply_protocol(spec.id)

Parameters:

Name	Type	Description	Default
nodes	list[TransformNode]	Ordered list of transform nodes forming the graph.	required
edges	list[TransformEdge]	Directed edges connecting the nodes by ID.	required
protocol_id	str | None	Optional protocol ID. A UUID is generated if not provided.	None

Returns:

Type	Description
ProtocolSpec	Summary of the validated (server-registered) protocol.

Raises:

Type	Description
RadiensError	If the server marks one or more nodes as invalid.

slice_channels

slice_channels(dataset, channels, output_path)

Select a subset of channels from a dataset.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to slice (metadata or ID).	required
channels	Sequence[int]	System-wide channel indices to keep.	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new dataset containing only the selected channels.

slice_time

slice_time(dataset, start_sec, end_sec, output_path)

Slice a dataset in time.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to slice (metadata or ID).	required
start_sec	float	Start time in seconds.	required
end_sec	float	End time in seconds.	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (sliced) dataset.

spike_sorter_cancel

spike_sorter_cancel(spike_sorter_id)

Cancel a running spike sorter.

Sends an OFF command. After this call, the server removes the sorter immediately — subsequent calls to get_spike_sorter_state or get_spike_sorter_dashboard with the same ID will raise ServerCommunicationError ("not found"). Use spike_sorter_delete() afterward only if auto-cleanup did not occur.

Equivalent to spike_sorter_command(id, SpikeSorterCommand.OFF).

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter to cancel.	required

spike_sorter_command

spike_sorter_command(
    spike_sorter_id,
    cmd,
    *,
    sub_cmd=SpikeSorterSubCommand.NULL,
)

Send a command to a running spike sorter.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter to control.	required
cmd	FlexSpikeSorterCommand	The command to execute. Accepts SpikeSorterCommand enum or string (e.g. "off", "rebase", "clear_sort").	required
sub_cmd	FlexSpikeSorterSubCommand	Optional sub-command modifier. Accepts SpikeSorterSubCommand enum or string ("null", "detect_only").	NULL

spike_sorter_delete

spike_sorter_delete(spike_sorter_id)

Delete a spike sorter and release its resources.

Parameters:

Name	Type	Description	Default
spike_sorter_id	str	Unique ID of the spike sorter to delete.	required

Raises:

Type	Description
RadiensError	On communication failure or server error.

spike_sorter_launch

spike_sorter_launch(params)

Launch a new spike sorter on a dataset.

Parameters:

Name	Type	Description	Default
params	SpikeSorterLaunchParams	Parameters for the sorter launch, including the target dataset ID, optional clustering/feature parameters, and noise discovery settings.	required

Returns:

Type	Description
SpikeSorterLaunchResult	The unique ID and type of the launched sorter.

Raises:

Type	Description
RadiensError	On communication failure or server error.

virtual_ref

virtual_ref(dataset, ref_channel, output_path)

Apply virtual reference re-referencing to a dataset.

References all channels against a single nominated electrode.

Parameters:

Name	Type	Description	Default
dataset	FlexDataset	Dataset to re-reference (metadata or ID).	required
ref_channel	int	Native channel index of the reference electrode.	required
output_path	str | Path	Where to save the result.	required

Returns:

Type	Description
DatasetMetadata	Metadata for the new (re-referenced) dataset.