Home

Caution

Docs are moved to docs/ (index at docs/README.md). This Wiki is deprecated.

Welcome to the spotlight-control wiki!

User's Manual

• Configuration and calibration
  • Profiles and arenas
  • Software dependencies and configurations
  • Aligning the two cameras
  • Running the arena registration scan
  • Fitting the arena registration model
• Data collection
  • The experiment protocol string
  • Using the recording application
• Post-processing
  • Generating videos and consolidating metadata
  • Visualizing the travel path of the motion stages (optional)
• Troubleshooting

Developer's Manual

Note: The asterisk^* indicates that the page is also part of the User's Manual.

• Design overview
  • Data in shared memory
  • Pseudocode of CPP threads
• Hardware considerations
  • Hardware limit for camera frame rates
• Environment setup
  • Software dependencies and configurations
  • eGrabber and JAI camera configuration
• Installing the Spotlight control programs
  • Compiling CPP code
  • Uploading Arduino code
  • Installing Python code
• Configuration and calibration
  • Profiles and arenas^*
  • Calibration algorithm
  • Calibration implementation and procedure^*
• C++ programs (under the recorder/ folder)
  • pco-camera-server
  • align-cameras (Aligning the two cameras)^*
  • run-arena-registration-scan (Running the arena registration scan)^*
  • run-spotlight (Using the recording application)^*
    • The experiment protocol string
• Python programs (under spotlight-tools/)
  • fit-arena-registration (Fitting the arena registration model)^*
  • postprocess-recording (Generating videos and consolidating metadata)^*
  • visualize-stage-trajectory (Visualizing the travel path of the motion stages)^*
• Troubleshooting^*