4. Developer’s Guide

Contents:

• 4.1. Data Management
  • 4.1.1. What is PyMoDAQ’s Data?
    • 4.1.1.1. DataBase
    • 4.1.1.2. Axis
    • 4.1.1.3. DataWithAxes
    • 4.1.1.4. DataWithAxes and signal/navigation axes
    • 4.1.1.5. Uniform and Spread Data
    • 4.1.1.6. Special DataWithAxes
  • 4.1.2. DataToExport
  • 4.1.3. Saving and loading data
    • 4.1.3.1. DataSaver/DataLoader
      • 4.1.3.1.1. AxisSaverLoader
      • 4.1.3.1.2. DataSaverLoader
      • 4.1.3.1.3. DataToExportSaver
      • 4.1.3.1.4. DataLoader
      • 4.1.3.1.5. Special DataSaver
    • 4.1.3.2. Module Savers
• 4.2. Contributing
  • 4.2.1. How to contribute
  • 4.2.2. Where to contribute
    • 4.2.2.1. Factory Patterns (to be completed)
      • 4.2.2.1.1. Data Exporting
      • 4.2.2.1.2. Math functions in ROI
      • 4.2.2.1.3. Scanning modes
  • 4.2.3. Contributors
    • 4.2.3.1. Main modules
      • 4.2.3.1.1. Functionalities
      • 4.2.3.1.2. Cleaning
    • 4.2.3.2. Plugins
    • 4.2.3.3. Extensions
    • 4.2.3.4. Documentation
    • 4.2.3.5. Testing
• 4.3. Plugins
  • 4.3.1. Plugins package configuration file
  • 4.3.2. Instrument Plugins
    • 4.3.2.1. Installation
    • 4.3.2.2. Contributions
    • 4.3.2.3. Naming convention
    • 4.3.2.4. Hardware Settings
    • 4.3.2.5. Emission of data
      • 4.3.2.5.1. Data ready?
      • 4.3.2.5.2. Synchronous example:
      • 4.3.2.5.3. Asynchronous example:
      • 4.3.2.5.4. Hardware averaging
      • 4.3.2.5.5. Live Mode
    • 4.3.2.6. Hardware needed files
    • 4.3.2.7. Actuator plugin having multiple axis
    • 4.3.2.8. Modifying the UI from the instrument plugin class
      • 4.3.2.8.1. Splash Screen and info
      • 4.3.2.8.2. Modifying the UI settings
      • 4.3.2.8.3. DAQ_Move specific commands
      • 4.3.2.8.4. DAQ_Viewer specific commands
  • 4.3.3. Extension Plugins
• 4.4. Custom App
• 4.3.3. Extension Plugins
• 4.5. Managers and Mixin Objects
  • 4.5.1. Parameter Manager
  • 4.5.2. Action Manager
  • 4.5.3. Modules Manager
  • 4.5.4. ROI Manager