Overview
The RHEED pipeline processes data in three stages:- Data cleaning and standardization: auto-classifies the recording type (stationary vs. rotating), crops to the illuminated region, corrects detector orientation, and for rotating recordings, detects the rotational period and aligns each rotation cycle to consistent azimuthal positions
- Pattern extraction: segments diffraction features using deep learning models and quantifies morphological metrics per feature
- Timeseries analysis: tracks how extracted metrics evolve across video frames, detects transitions, and identifies changes in surface structure
Key Metrics
For rotating RHEED data, the pipeline automatically detects the rotational period, identifies high-symmetry reference frames, and aligns each rotation cycle before extracting metrics per azimuthal angle. This corrects for variations in rotation speed and ensures equivalent positions are compared consistently across cycles.
- Guide
- Technical Details
Adding RHEED Data
Choose the acquisition method that fits the instrument:- Desktop integration: use RHEED Camera (GenTL) on the instrument workstation. Open Documentation in the desktop app for camera setup, then see Finding Collected Data. The integration controls collection; viewing a growth does not start a second acquisition.
- Upload: add recorded videos or images through Manual Upload.
- Custom acquisition: use Stream RHEED to send frames from your own Python application.
Browser screen capture
Use Screen Capture when the source is a RHEED display. That reference covers source selection, capture settings, and pause, resume, and end behavior for browser capture. Gateway recordings are controlled through their integrations, not browser capture settings.Viewing Results
Once processing completes (or during a live stream), the RHEED workspace shows several sections:Video player: Scrub through the recorded or live video. Reference frame positions are highlighted on the scrub bar for rotating recordings. You can jump to a specific frame number or drag the scrubber to isolate a moment in time.Growth analysis chart: The main analysis view. Select which timeseries to plot (lattice spacing, strain, intensity, FWHM, spot count, oscillation period) and choose the azimuth angle for rotating data. Changepoints appear as shaded bands when the detected surface reconstruction changes (see Technical Details).Saved patterns: Extract individual frames for detailed fingerprint analysis. Click Save Frame to extract the current video frame. Each saved frame shows the fingerprint overlay with extracted diffraction features, intensity maxima positions, and horizontal spacing between the specular spot and nearest features.Azimuth Calibration
For rotating RHEED recordings, the pipeline automatically detects the rotational period and identifies high-symmetry reference frames. You can refine these in the azimuth calibration panel:- Label azimuths with crystal orientation names (e.g.,
Al[100]) - Unit Calibration: enter a spacing in pixels (Relative Units) and the known distance it corresponds to (Real Units, in nm, Å, or px). Lattice spacing is then reported as a real-space value in Å instead of pixels.
Reanalysis
If you need to adjust analysis parameters, open the workflow configuration drawer to update reference frames or rotational period, then re-run the pipeline.Comparing Patterns
Save multiple frames and use the pattern comparison tools to view fingerprint overlays side by side or generate difference masks between two patterns. This is useful for identifying subtle changes in surface structure across a growth run.Related Documentation
Investigate an Unexpected Change
Investigate an event in a notebook and examine the evidence.
Investigate Consistency Within a Growth
Analyze RHEED data consistency across a growth.