API Reference¶
Auto-generated reference for every public function and class in the package.
Modules¶
| Module | Description |
|---|---|
pipeline.session |
Per-session pipeline factory and process_session |
pipeline.batch |
Multi-session export: process_sessions, aggregate, and the vr-foraging-packaging CLI |
processors |
AbstractProcessor base class and all processor implementations |
nwb |
NwbSession — build and write NWB-Zarr files |
Quick navigation¶
pipeline.session¶
create_processors— return the ordered processor list for a datasetresolve_site_table_processor— return the correct site-table processorresolve_position_velocity_processor— return the correct position/velocity processorprocess_session— run all processors and write parquets
pipeline.export¶
process_sessions— Phase 1: per-session parquetsaggregate— Phase 2: flat cross-session parquetsAGGREGATED_TABLES— the fixed set of tables Phase 2 flattens
pipeline.cli¶
Cli— root parserSessionCommand—sessionBatchCommand—batchAggregateCommand—aggregate
processors¶
AbstractProcessor— base class for all processorsSessionMetadataProcessorSiteTableProcessorPositionAndVelocityProcessorLicksProcessorSniffingProcessorSoftwareEventsProcessorEventsProcessor