The API

A large part of the motivation behind the choice of Python for the HiPERCAM pipeline was to make it straightforward for observers to write their own add-ons and scripts. Real data invariably throws up exceptions to the rule which might require a hand-crafted approach. The pipeline API (Application Programmers Interface) is designed to allow you to do so.

Contents:

• API quick start
  • HiPERCAM hcm files and hipercam.MCCD objects
  • Dealing with raw data files
  • Command line inputs
• HiPERCAM’s hcm file format
  • HDU structure and keywords
  • Foreign data
  • Example headers
• HiPERCAM’s windows format
• Modules
  • hipercam.ccd
  • hipercam.hlog
  • hipercam.window
• Timing
  • No clear mode
  • Clear mode
  • Drift mode
  • Summary of symbols and corresponding header parameters
• Timing tests
  • WHT commissioning run, October 2017
• Reporting problems
• Data logging