Methods¶
The technique catalog. Each Method names a technique abstractly and declares the device Families or Roles it binds and the Capability contract it realizes. A Method binds by Role (federation-portable) where a functional contract fits, and by Family (anatomical) where a specific device class is meant.
Generated from the catalog descriptor
This page is generated from catalog/catalog.yaml. Edit the descriptor, not this page. For the naming, governance, and closed-core conventions, see the Catalog overview.
| Method | Capability | Needed families | Required roles | Purpose |
|---|---|---|---|---|
motor_homing |
cora.capability.maintenance |
Positioner |
Reference-position seek for motorized Devices; leaves encoders zeroed for absolute moves. | |
resolution_alignment |
cora.capability.alignment |
Positioner, Detector |
The resolution step, an iterative propagation-distance peak search on a mounted resolution target. | |
focus_alignment |
cora.capability.alignment |
Positioner, Detector |
The focus step, an iterative Sample-Z peak search for depth-of-focus. | |
center_alignment |
cora.capability.alignment |
Positioner, Detector |
The center step, iterative 0/180 convergence on the rotation-axis pixel position. | |
roll_alignment |
cora.capability.alignment |
Positioner, Detector |
The roll step, iterative 0/180 Y-delta correction so the rotation axis is perpendicular to the camera Y axis. | |
pitch_alignment |
cora.capability.alignment |
Positioner, Detector |
The pitch step, iterative 0/180 sharpness-delta correction so the rotation axis is perpendicular to the beam. | |
dark_field |
cora.capability.acquisition |
Shutter, Detector |
Dark-frame stack plus pixel-wise baseline, producing a Dataset for reconstruction subtraction. | |
flat_field |
cora.capability.acquisition |
Shutter, Detector |
Flat-field stack (shutter open, no sample) plus pixel-wise baseline, producing a Dataset for reconstruction division. | |
hexapod_reboot |
cora.capability.maintenance |
Hexapod |
Recovery for a stuck hexapod controller: IOC stop, PDU power-cycle, IOC start, enable check. | |
tomography |
cora.capability.tomography |
Positioner, Detector |
The canonical imaging routine; a Run producing an H5 projection-stack Dataset from operator exposure, projections, and angle-range. | |
sensitivity_characterization |
cora.capability.characterization |
Positioner, Detector |
Pre-step measuring motor-sensitivity constants empirically (bump an axis by a known delta, observe centroid shift, K = shift/bump). | |
energy_characterization |
cora.capability.characterization |
Monochromator, RotaryStage |
Energy calibration via a channel-cut crystal: rock a crystal of known 2d through its Bragg peak, fit the peak angle, recover the true beam energy, and re-save the corrected per-energy curve as a new revision (ENERGY-7). | |
streaming_tomography |
cora.capability.tomography |
Positioner, Detector |
Live-reconstruction tomography supporting mid-flight adjust_run steering on observed reco quality. | |
continuous_rotation_tomography |
cora.capability.tomography |
Positioner, Detector |
N back-to-back rotation Runs sharing one Plan and Subject under a Campaign(intent=Series). | |
mosaic_tomography |
cora.capability.tomography |
Positioner, Detector |
Tiled lateral-translation tomography for samples larger than the field of view, stitched in post. | |
xpcs |
cora.capability.xpcs |
Detector, Shutter, Controller |
Coherent-scattering time-series acquisition: a high-rate frame stream on a coherent area detector, gated by the softGlue timing, correlated downstream into g2. The frame stream is DAQ-owned, distinct from a poll-to-Done capture (the event-stream acquisition axis). | |
powder_diffraction |
cora.capability.diffraction |
Detector |
Powder / polycrystalline diffraction: an azimuthally-integrated ring pattern on an area or strip detector as the sample is spun, giving a one-dimensional intensity-vs-angle pattern for phase ID, Rietveld refinement, or total-scattering / PDF. | |
single_crystal_diffraction |
cora.capability.diffraction |
PseudoAxis |
Detector |
Small-molecule / chemical single-crystal diffraction: indexed Bragg reflections collected over sample orientations on an area detector, for small-unit-cell structure solution. Distinct from macromolecular_crystallography by sample scale and refinement pipeline. |
macromolecular_crystallography |
cora.capability.diffraction |
Positioner, Detector |
Macromolecular crystallography (MX) rotation data collection: a rotation series on a protein crystal mounted on a goniometer, area-detector frames per oscillation wedge, for macromolecular structure solution. | |
serial_crystallography |
cora.capability.diffraction |
Positioner, Detector, Controller |
Serial crystallography (SSX / SFX): still or minimal-rotation single shots across many crystals delivered by fixed-target chip or injector, each a diffraction pattern, merged downstream. Distinct from macromolecular_crystallography by the fixed-target / serial delivery act rather than a rotation series. | |
surface_diffraction |
cora.capability.diffraction |
PseudoAxis |
Detector |
Surface / interface diffraction and reflectivity: specular and off-specular Bragg intensities measured with a multi-circle diffractometer at grazing incidence, for surface structure and layer profiles. |
small_wide_angle_scattering |
cora.capability.scattering |
Detector |
Small- and wide-angle X-ray scattering (SAXS/WAXS): a single exposure capturing both the small-angle and wide-angle diffuse pattern on area detectors, for nanostructure and packing. SAXS and WAXS are one simultaneous act, not two Methods. | |
grazing_incidence_scattering |
cora.capability.scattering |
PseudoAxis |
Detector |
Grazing-incidence small/wide-angle scattering (GISAXS / GIWAXS): SAXS/WAXS geometry at a grazing angle on a reflecting surface or thin film, probing in-plane and out-of-plane nanostructure. Distinct from small_wide_angle_scattering by the grazing surface-sensitive geometry. |
coherent_diffraction_imaging |
cora.capability.scattering |
Detector, Positioner |
Coherent diffraction imaging (CDI): oversampled coherent far-field diffraction patterns from an isolated or scanned sample, phase-retrieved into a real-space image. Distinct from ptychography by the single-view (non-scanning) act. | |
ptychography |
cora.capability.scattering |
Detector, Positioner |
Ptychography: coherent diffraction patterns recorded at overlapping scan positions of a confined probe, jointly phase-retrieved into a high-resolution image and probe. Distinct from coherent_diffraction_imaging by the overlapping-scan act. | |
absorption_spectroscopy |
cora.capability.absorption_spectroscopy |
Monochromator |
Step-scanned X-ray absorption spectroscopy (XAS / XANES / EXAFS): the monochromator steps the incident energy across an edge while transmission or fluorescence yield is recorded, giving an absorption energy scan. XANES and EXAFS are near-edge and extended windows of one scan. | |
continuous_absorption_spectroscopy |
cora.capability.absorption_spectroscopy |
Monochromator |
Continuous-energy X-ray absorption spectroscopy (QEXAFS / trajectory-energy fly-scan): the monochromator sweeps energy continuously while yield is streamed, for fast / time-resolved XAS. Distinct from absorption_spectroscopy by the continuous fly-scan act rather than discrete steps. | |
xray_fluorescence_mapping |
cora.capability.emission_spectroscopy |
Sensor, Positioner |
Scanning X-ray fluorescence mapping (XRF): a focused beam raster-scans the sample while an energy-dispersive detector records the fluorescence spectrum per pixel, giving element maps. Distinct from the crystal-analyzer emission Methods by the energy-dispersive point detector. | |
xray_emission_spectroscopy |
cora.capability.emission_spectroscopy |
Detector |
X-ray emission spectroscopy (XES / HERFD): a crystal-analyzer spectrometer disperses the emitted fluorescence lines to high energy resolution at a fixed incident energy, resolving chemical state. Distinct from xray_fluorescence_mapping by the wavelength-dispersive crystal analyzer. | |
resonant_inelastic_scattering |
cora.capability.emission_spectroscopy |
Positioner |
Resonant inelastic X-ray scattering (RIXS): the incident energy is tuned to an absorption edge and the energy-loss spectrum of scattered photons is dispersed on a long spectrometer arm, giving a two-dimensional incident-vs-emitted map of electronic excitations. | |
inelastic_scattering |
cora.capability.emission_spectroscopy |
Positioner |
Momentum-resolved (non-resonant) inelastic X-ray scattering (IXS): a multi-analyzer spectrometer arm resolves small energy losses versus momentum transfer, probing phonons and collective excitations. Distinct from RIXS by the non-resonant momentum-scan act. | |
xray_photoelectron_spectroscopy |
cora.capability.photoemission_spectroscopy |
Detector, Positioner |
X-ray photoelectron spectroscopy (XPS / soft-X-ray photoemission): an electron analyzer records the kinetic-energy distribution of photoemitted electrons at a fixed photon energy, giving core-level and valence spectra for chemical state. | |
hard_xray_photoelectron_spectroscopy |
cora.capability.photoemission_spectroscopy |
Detector, Positioner |
Hard X-ray photoelectron spectroscopy (HAXPES): XPS at multi-keV photon energy for greater probing depth, requiring a hard-X-ray-optimized analyzer and optics. Distinct from xray_photoelectron_spectroscopy by the depth-sensitive hard-X-ray act, not merely a photon-energy parameter. | |
angle_resolved_photoemission |
cora.capability.photoemission_spectroscopy |
Detector, Positioner |
Angle-resolved photoemission spectroscopy (ARPES): an electron analyzer resolves photoelectron intensity versus kinetic energy AND emission angle, mapping the electronic band structure. Distinct from XPS by the added angle-resolved dimension. | |
radiography |
cora.capability.tomography |
Detector |
Radiography: a single (or time-series) transmission projection through the sample onto a scintillator-coupled camera, without the rotation series that tomography adds. The projection primitive beneath tomography. | |
transmission_xray_microscopy |
cora.capability.tomography |
ZonePlate |
Detector |
Full-field transmission X-ray microscopy (TXM): a zone-plate-magnified transmission image (optionally Zernike phase contrast), per projection, optionally rotated for nano-tomography. Distinct from tomography by the X-ray objective (zone plate) forming a magnified image rather than a scintillator-relay projection. |
beamline_energy_change |
cora.capability.energy_change |
Monochromator, Slit, PseudoAxis |
Set the beam energy by driving the energy-tracking optic axes (the DMM Bragg arms + M2 offset, and the sample-slit vertical pair) to their per-energy positions as one coordinated move. |