API Reference

This section contains the complete API reference for PyFlowReg, automatically generated from docstrings.

High-Level APIs

Motion Correction

High-level functions for applying motion correction to videos and arrays.

• compensate_arr() - Array-based workflow

• compensate_recording() - File-based workflow

• FlowRegLive - Real-time processing

• OFOptions - Configuration system

Motion Correction

Session Processing

Multi-recording session processing with inter-sequence alignment.

• SessionConfig - Session configuration

• run_stage1() - Per-recording correction

• run_stage2() - Inter-sequence alignment

• run_stage3() - Valid mask computation

Session API Reference

Core Algorithms

Low-level optical flow computation engine.

• get_displacement() - Main optical flow API

• compute_flow() - Pyramid level solver

• Warping utilities

• Motion tensor computation

Core Algorithms

Utilities

I/O System

File format readers and writers.

• HDF5, TIFF, MAT, MDF support

• Multi-file handling

• VideoReader/VideoWriter interface

I/O System

Image Processing

Image processing utilities.

• Pyramid resizing

• Gaussian filtering

• Cross-correlation pre-alignment

• Visualization tools

Utilities