__init__.py

from .baserecording import BaseRecording, BaseRecordingSegment
from .basesorting import BaseSorting, BaseSortingSegment, SpikeVectorSortingSegment
from .baseevent import BaseEvent, BaseEventSegment
from .basesnippets import BaseSnippets, BaseSnippetsSegment
from .baserecordingsnippets import BaseRecordingSnippets

from .loading import load

# main extractor from dump and cache
from .binaryrecordingextractor import BinaryRecordingExtractor, read_binary
from .npzsortingextractor import NpzSortingExtractor, read_npz_sorting
from .numpyextractors import (
    NumpyRecording,
    SharedMemoryRecording,
    NumpySorting,
    SharedMemorySorting,
    NumpyEvent,
    NumpySnippets,
)
from .zarrextractors import ZarrRecordingExtractor, ZarrSortingExtractor, read_zarr, get_default_zarr_compressor
from .binaryfolder import BinaryFolderRecording, read_binary_folder
from .sortingfolder import NumpyFolderSorting, NpzFolderSorting, read_numpy_sorting_folder, read_npz_folder
from .npysnippetsextractor import NpySnippetsExtractor, read_npy_snippets
from .npyfoldersnippets import NpyFolderSnippets, read_npy_snippets_folder

# utility extractors (equivalent to OLD subrecording/subsorting)
from .channelslice import ChannelSliceRecording, ChannelSliceSnippets
from .unitsselectionsorting import UnitsSelectionSorting
from .frameslicerecording import FrameSliceRecording
from .frameslicesorting import FrameSliceSorting

from .channelsaggregationrecording import ChannelsAggregationRecording, aggregate_channels
from .unitsaggregationsorting import UnitsAggregationSorting, aggregate_units

# generator of simple object for testing or examples
from .generate import (
    generate_recording,
    generate_sorting,
    add_synchrony_to_sorting,
    create_sorting_npz,
    generate_snippets,
    synthesize_random_firings,
    inject_some_duplicate_units,
    inject_some_split_units,
    synthetize_spike_train_bad_isi,
    generate_templates,
    NoiseGeneratorRecording,
    noise_generator_recording,
    generate_recording_by_size,
    InjectTemplatesRecording,
    inject_templates,
    generate_ground_truth_recording,
)

# utils to append and concatenate segment (equivalent to OLD MultiRecordingTimeExtractor)
from .segmentutils import (
    append_recordings,
    AppendSegmentRecording,
    concatenate_recordings,
    ConcatenateSegmentRecording,
    split_recording,
    select_segment_recording,
    SelectSegmentRecording,
    append_sortings,
    AppendSegmentSorting,
    concatenate_sortings,
    ConcatenateSegmentSorting,
    split_sorting,
    SplitSegmentSorting,
    select_segment_sorting,
    SelectSegmentSorting,
)

# default folder
from .globals import (
    set_global_tmp_folder,
    get_global_tmp_folder,
    is_set_global_tmp_folder,
    reset_global_tmp_folder,
    get_global_dataset_folder,
    set_global_dataset_folder,
    is_set_global_dataset_folder,
    get_global_job_kwargs,
    set_global_job_kwargs,
    reset_global_job_kwargs,
    is_set_global_job_kwargs_set,
)

# tools
from .core_tools import (
    read_python,
    write_python,
    normal_pdf,
    ms_to_samples,
)
from .job_tools import (
    get_best_job_kwargs,
    ensure_n_jobs,
    ensure_chunk_size,
    TimeSeriesChunkExecutor,
    split_job_kwargs,
    fix_job_kwargs,
)
from .recording_tools import (
    write_binary_recording,
    write_memory_recording,
    write_recording_to_zarr,
    write_to_h5_dataset_format,
    get_random_data_chunks,
    get_channel_distances,
    get_closest_channels,
    get_noise_levels,
    get_chunk_with_margin,
    apply_raised_cosine_taper,
    order_channels_by_depth,
)
from .sorting_tools import (
    spike_vector_to_spike_trains,
    spike_vector_to_indices,
    random_spikes_selection,
    apply_merges_to_sorting,
    apply_splits_to_sorting,
)

from .waveform_tools import extract_waveforms_to_buffers, estimate_templates, estimate_templates_with_accumulator
from .snippets_tools import snippets_from_sorting

# waveform extractor
# Important not for compatibility!!
# This wil be commented after 0.100 relase but the module will not be removed.
# from .waveform_extractor import (
#     WaveformExtractor,
#     BaseWaveformExtractorExtension,
# extract_waveforms,
# load_waveforms,
#     precompute_sparsity,
# )

# retrieve datasets
from .datasets import download_dataset

from .old_api_utils import (
    create_recording_from_old_extractor,
    create_sorting_from_old_extractor,
    create_extractor_from_new_recording,
    create_extractor_from_new_sorting,
)

# templates addition
# from .injecttemplates import InjectTemplatesRecording, InjectTemplatesRecordingSegment, inject_templates


# channel sparsity
from .sparsity import ChannelSparsity, compute_sparsity, estimate_sparsity

from .template import Templates

# SortingAnalyzer and AnalyzerExtension
from .sortinganalyzer import (
    SortingAnalyzer,
    AnalyzerExtension,
    create_sorting_analyzer,
    load_sorting_analyzer,
    get_available_analyzer_extensions,
    get_default_analyzer_extension_params,
)

# template tools
from .template_tools import (
    get_template_amplitudes,
    get_template_extremum_channel,
    get_template_extremum_channel_peak_shift,
    get_template_extremum_amplitude,
)


from .analyzer_extension_core import (
    ComputeRandomSpikes,
    compute_random_spikes,
    ComputeWaveforms,
    compute_waveforms,
    ComputeTemplates,
    compute_templates,
    ComputeNoiseLevels,
    compute_noise_levels,
)

from .motion import Motion

# Important not for compatibility!!
# This wil be uncommented after 0.100
from .waveforms_extractor_backwards_compatibility import (
    extract_waveforms,
    load_waveforms,
    load_sorting_analyzer_or_waveforms,
)