Target release
Epic

SCLP-1 - Getting issue details... STATUS

Document status
DRAFT
Document owner

Haley Marts

Designer

Sebastian C. Aderhold 

Developers

Haley Marts 

QA

Goals

  • Develop an improved microphonics measurement application with enhanced visualization and multi cavity measurement capabilities
  • Streamline the data collection process for multiple cryomodules and cavities through:
    • Implementation of parallel operations for multi rack measurements
    • Development of simultaneous data collection capabilities across multiple configurations
    • Enable flexible cavity selection across different racks
  • Provide better data analysis tools and interactive visualizations
  • Implement an improved user interface with:
    • Simplified cryomodule naming (using Cryo 1, 2, 3 instead of ACCL:L3B:18)
    • Hierarchical selection system (Linac → Cryomodule → Rack A/B → Cavities 1-4, 4-8)
    • Support for selecting any combination of cavities
  • Enhance the measurement system to:
    • Support parallel operations through PyQt shell command execution
    • Enable simultaneous measurements across multiple racks
    • Improve the existing script_path infrastructure for multi-configuration support

Background and strategic fit

The current microphonics measurement system is limited to measuring one cryomodule at a time with one rack at a time. This project aims to expand capabilities to handle multiple simultaneous measurements while adding new visualization features and improving the user interface.

Assumptions

  • Existing hardware configurations will remain unchanged
  • The application will be integrated into the sc_linac_physics repository
  • The system will continue to use the existing script_path infrastructure for data collection

Requirements


TitleUser StoryImportanceNotes
1Data AcquisitionI want to collect waveform data from multiple cavities, so that I can analyze microphonics behavior across the accelerator system

VERY IMPORTANT

  • Default sampling rate: 2000 samples/sec
  • Buffer length: 16384
  • Configurable decimation rates: 1, 2, 4, 8
  • Error handling for offline cavity conditions
  • Acquisition time calculation: BUFFER_LENGTH * decimation_num * number_of_buffers / DEFAULT_SAMPLING_RATE


2Hardware IntegrationI need access to all supported cryomodule configurations across different linac sections, so I can collect data from any cavity in the system.High

IP




3Data Processing and AnalysisI need access to all supported cryomodule configurations across different linac sections, so I can collect data from any cavity in the system.High
  • FFT analysis up to 150Hz
  • Histogram analysis of detuning
  • Spectrogram visualization
  • Interactive plot features (frequency identification on hover)
  • Multi cavity comparison capabilities




4User InterfaceI want an intuitive interface for selecting measurement configurations and visualizing data, so I can efficiently perform measurements and analysis.High
  • Hierarchical selection (Linac → Cryomodule → Rack → Cavities)
  • Multi cavity selection capabilities
  • Real time acquisition status display
  • Integration with physics elog system
  • Interactive plot customization
  • Colorblind friendly visualization options




5VisualizationI want detailed, interactive plots with multiple visualization options, so I can analyze cavity behavior.High
  • Histogram plots (-200 to 200 Hz range, log scale)
  • FFT plots (0-150 Hz range)
  • Spectrogram visualization
  • Interactive features (zoom, hover data)
  • Multi cavity comparison view




6Error Handling and Logging I want clear error messages and logging capabilities so I can troubleshoot issues and maintain system reliability.High
  • Error handling for offline cavity
  • User friendly error messages
  • System status logging
  • Integration with existing logging




7DocumentationI want documentation so I can understand, maintain, and use the system effectively.High
  • In code documentation requirements
  • Documentation for new users
  • System architecture documentation
  • User guide documentation





User interaction and design

Questions

Below is a list of questions to be addressed as a result of this requirements document:


QuestionOutcome
1Performance optimization for multi rack measurements
2Integration with elog system
3Detailed requirements for spectrogram implementation

Not Doing