Families¶
The device-class abstractions a Method declares as needed_families. Affordances are a Role concern, so they live on Roles, not here; a Family advertises which Roles it satisfies via presents_as.
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.
| Family | Used by methods | Note |
|---|---|---|
RotaryStage |
energy_characterization |
|
LinearStage |
||
TiltStage |
Limited-range rotational tilt-stage Family (a goniometer). Distinct from RotaryStage (it carries no PSO Following/Marking for fly-scans) and from LinearStage (the motion is rotational, not translation). 2-BM: the LaminographyPitch Kohzu goniometer, modelled in the SampleTower Assembly. | |
Camera |
||
Scintillator |
Passive X-ray-to-light converter Family (a scintillator / phosphor screen, e.g. LuAG:Ce, GGG, YAG). Not a detector: it converts the X-ray beam to visible light that a Camera then images, so a composed scintillator-relay Assembly presents the Detector Role, NOT the bare Family (the Detector Role's multi-Family disjunction accepts either the direct-detection Camera path or the composed-Assembly path). Consumable: its material, thickness, and lot are operationally tracked across swaps, but it has no command surface (no Role). | |
EnergyDispersiveSpectrometer |
Energy-dispersive X-ray detector Family: resolves photon energy per event to give a spectrum, from which element maps or absorption edges are fit downstream. Presents_as Sensor (it produces a scalar or short-vector Reading per point, not a 2D Frame, so it is distinct from Camera and the Detector Role). One Family spans the silicon-drift and germanium variants; channel count and vendor are per-Asset settings. 2-ID: the 2-ID-D fluorescence detector (XRF mapping). 7-BM: the germanium energy-dispersive-diffraction detector. Earned in once two deployments shared it; the name deliberately avoids the reserved Detector Role noun (a detector is a Role an Asset plays, not its Family). | |
FluxMonitor |
Beam-flux / intensity monitor Family: measures incident or transmitted beam intensity as a scalar (ion chamber, X-ray beam-position monitor read as flux, four-channel picoammeter). Presents_as Sensor (a scalar Reading, not a 2D Frame, so distinct from Camera and the Detector Role); and distinct from the position-measuring PositionMonitor Family by what it measures, flux not centroid. One Family spans the ion chambers, XBPMs, and TetrAMM picoammeters; incident-vs-transmitted placement is a per-Asset setting. i22: the I0 / It ion chambers. i03: the Flux readout and the IPin ion chamber. i15-1: the JBPM TetrAMM. Earned in once three deployments shared it (the EnergyDispersiveSpectrometer precedent: a Sensor-presenting measurement Family graduates by what it measures). | |
PositionMonitor |
Beam-position monitor Family: measures the transverse position (centroid) of the beam as a short vector, typically from a four-quadrant or segmented pickup (a quadrant BPM / QBPM, an X-ray BPM read for position, or a TetrAMM / picoammeter read for centroid rather than flux). Presents_as Sensor (a scalar or short-vector Reading, not a 2D Frame, so distinct from Camera and the Detector Role). The measured-quantity sibling of FluxMonitor: FluxMonitor measures beam flux / intensity, PositionMonitor measures beam centroid / position (the same device electronics can be read either way, so the discriminator is the measured quantity, the FluxMonitor / EnergyDispersiveSpectrometer precedent of a Sensor Family earned by what it measures). The 2-word |
|
Shutter |
||
Hexapod |
hexapod_reboot |
|
MotionController |
||
TimingController |
Hardware timing-signal generation and distribution (triggers, gates, sync pulses); presents_as Controller, which carries Pulsing. Anchored at 2-BM by Timing (the softGlueZynq Zynq FPGA box). Substrate (softGlue, FPGA, Zynq) stays out of the name and lives in settings or the bound Model. | |
Objective |
Per-lens identity inside the Microscope Assembly. | |
PseudoAxis |
beamline_energy_change, grazing_incidence_scattering, single_crystal_diffraction, surface_diffraction |
Virtual-axis Family; the Objective_Selector Asset carries a LookupTable partition rule decomposing an objective index to turret rotation. |
Housing |
Containment chassis Family; the Housing Asset parents the Microscope constituents and carries the Mount. | |
GenericProbe |
APS facility-scope template, an abstract detector probe-chain. | |
Table |
Support/positioning table Family (the hutch optical tables). One Family spans the 4-DOF sample table (pure translation), the 6-DOF detector table (six virtual axes on record 2bmb:table3), and the mirror table (in operational use, its X axes driven by the energy-change IOC for stripe selection, STAGE-7); the axis set is a per-Asset settings difference, not a Family split. 'Optical' is deliberately not in the name (it would name the contents, not the table's own nature; the OpticalHousing -> Housing precedent). Instances qualify at the Asset layer: SampleTable / DetectorTable / MirrorTable. | |
Slit |
beamline_energy_change |
Beam-defining four-blade slit Family (four independently-driven blades forming a variable horizontal/vertical opening). 2-BM: ConditioningSlit (A-station L3-20) and SampleSlit (B-station). |
Aperture |
Patterned beam-shaping aperture Family: a fixed-pattern mask positioned in the beam as a unit. Distinct from Slit (a variable opening defined by four driven blades) and from a passive Mask (a fixed beam-defining opening that does not move); the discriminator is the element's nature (a fixed code pattern), not that it is driven. 2-BM: the coded aperture for compressive-sensing tomography, fine-positioned by ApertureFineDrive. | |
Mask |
Passive beam-defining mask Family: a plain fixed-opening element that shapes or limits the beam, positioned as a unit. Distinct from Slit (a variable opening via four driven blades) and Aperture (a fixed code pattern); the discriminator is the element's nature (a plain fixed opening). One Family spans the permanently-fixed masks and the movable safety-mask variant (movability is a per-Asset setting, the Table / InsertionDevice precedent). 2-BM: the M3-24 front-end exit mask. TomoWISE: the FM1 / FM2 fixed masks and the MSM movable safety mask. Earned in once two deployments shared it; beam-effect modelling stays deferred (the passive beam-path tier). | |
Window |
Passive beam-transmitting window Family: a fixed element that passes the beam while isolating the vacuum envelope. Distinct from Mask / Aperture / Slit (which define or shape an opening) and from BeamStop / Collimator (which absorb beam): a Window transmits. One Family spans the beryllium front-end windows and the downstream Kapton window; per-window identity is at the Asset layer (the Table precedent). 2-BM: the three OFHC-housed front-end Be windows (registered as FrontEndWindow child Assets) and the DetectorWindow. 32-ID: the FrontEndWindow. 19-BM: the FEExitWindow, DEntryWindow, and KaptonWindow. Earned in once three deployments shared it; beam-effect (transmission-vs-energy) modelling stays deferred (the passive beam-path tier). | |
BeamStop |
Passive beam-absorbing stop Family: a fixed element that absorbs the transmitted or direct beam for personnel safety or detector protection. Distinct from Collimator (which trims the beam envelope rather than stopping it), from Mask / Aperture (which define an opening), and from a Window (which transmits). One Family spans the white-beam, monochromatic-beam, photon, and bremsstrahlung stops; the stopped beam-mode is a per-Asset setting (the Table / InsertionDevice precedent). 2-BM: the SafetyStack BeamStop. 32-ID: WhiteBeamStop and MonochromaticBeamStop. 19-BM: PhotonStop and BremsstrahlungStop. Earned in once three deployments shared it; beam-effect modelling stays deferred (the passive beam-path tier). | |
Collimator |
Passive beam-collimating Family: a fixed element that limits the transmitted fan to the beamline acceptance and absorbs the bremsstrahlung halo. Distinct from BeamStop (which absorbs the full beam rather than trimming it), from Slit (a variable driven opening), and from Mask / Aperture (which define the beam-shaping opening). 2-BM: the SafetyStack Collimator. 19-BM: the UpstreamCollimator and DownstreamCollimator (lead). Earned in once two deployments shared it; beam-effect modelling stays deferred (the passive beam-path tier). | |
Mirror |
Beam-steering grazing-incidence mirror optic Family. 2-BM: the Y3-30 mirror (distinct from its MirrorTable support, which is Family Table). | |
Monochromator |
absorption_spectroscopy, beamline_energy_change, continuous_absorption_spectroscopy, energy_characterization |
Energy-selecting optic Family; at 2-BM the double-multilayer monochromator (DMM). The energy-change IOC drives its Bragg arms + M2 vertical offset per energy; inserting it picks the beam energy, pink-beam operation bypasses it. Distinct from GratingMonochromator (a diffraction-grating soft X-ray mono): this Family is the crystal / multilayer Bragg monochromator. |
GratingMonochromator |
Soft X-ray plane-grating monochromator (PGM) Family: selects energy with an interchangeable diffraction grating and a premirror held at a fixed-focus c-value (cff), with the exit slit setting the resolution. Distinct from Monochromator (a crystal / multilayer Bragg optic): a PGM has no Bragg crystal and disperses with a grating, so the line-density / cff / grating-translation controls and exit-slit resolution are a different optic, not a settings variant. Earned in once two deployments shared it, the soft X-ray beamlines SIX (NSLS-II 2-ID, the RIXS PGM, three gratings 500 / 1200 / 1800 l/mm) and CSX (NSLS-II 23-ID, the VLS-PGM, 200-2200 eV), and reused by ESM (NSLS-II 21-ID); grating line density and energy range are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Monochromator precedent). | |
Condenser |
Beam-condensing optic Family for full-field transmission X-ray microscopy: shapes the monochromatic beam onto the sample (a capillary or a condenser zone plate). Distinct from the ZonePlate (the imaging objective downstream of the sample) and from a Mirror (grazing-incidence steering); the discriminator is its role, conditioning the illumination onto the sample. 32-ID: the Condenser (capillary or condenser zone plate, type unconfirmed). FXI: the clens condenser. Earned in once two deployments shared it; per-Asset optical parameters live at the Asset layer. | |
ZonePlate |
transmission_xray_microscopy |
Diffractive Fresnel zone-plate objective Family for full-field transmission X-ray microscopy: magnifies the transmitted image onto the detector, set by its diameter and outermost-zone width. Distinct from the Condenser (which conditions the illumination onto the sample) and from a refractive Objective (the visible-light objective in a scintillator-relay detector); the ZonePlate is the X-ray imaging objective. 32-ID: the ZonePlate. FXI: the zp zone plate (NanoTools, about 244 um diameter, about 30 nm outermost zone, carried confirm). Earned in once two deployments shared it; per-Asset zone parameters live at the Asset layer. |
PhaseRing |
Zernike phase-ring optic Family for full-field transmission X-ray microscopy: a phase plate in the back focal plane that renders phase contrast as amplitude contrast, inserted or retracted per imaging mode. Distinct from the ZonePlate (the imaging objective) and the Condenser (the illumination optic); the discriminator is its phase-contrast role. 32-ID: the PhaseRing. FXI: the phase_ring. Earned in once two deployments shared it; the inserted/retracted state is a per-Asset setting. | |
Transfocator |
Compound-refractive-lens (CRL) transfocator Family: a beam-focusing optic of stacked refractive lenslets, individually insertable to set the focal length, that focuses the beam refractively. Distinct from Mirror (reflective grazing-incidence focusing), ZonePlate (diffractive focusing), and Condenser (illumination conditioning onto the sample); the discriminator is refractive compound-lens focusing. Graduated across eight deployments: APS 4-ID / 8-ID / 9-ID, Diamond i22, NSLS-II CHX / SMI / IXS, and SLAC LCLS-MFX; lens material, lenslet count, and fixed-versus-adjustable mounting are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Table precedent). A kinoform (a single profiled refractive lens, named at CHX but not modelled as a device) is a distinct refractive optic, not a compound-lens transfocator, and would be its own question if a deployment binds it. | |
PhaseRetarder |
Polarization phase-retarder optic Family: a diamond crystal (or a stack of them) operated near a Bragg reflection that converts the incident linear polarization to a selectable state (circular or rotated-linear), its retardation set by the crystal angle offset and tracked with energy. Presents the Positioner Role (the motorized theta / x / y circles that set and track the retardation). Distinct from Monochromator (a Bragg optic that selects energy, not polarization state) and from PolarizationAnalyzer (the post-sample optic that measures the scattered-beam polarization rather than setting the incident state); the discriminator is setting the incident polarization state upstream of the sample. Graduated on the rule-of-three across APS 4-ID POLAR (three diamond phase-retarder stages, energy-tracking) and PETRA III P09 and P22 (the shared P09 phase-retarder circles); crystal count, diamond-versus-other material, and fixed-versus-energy-tracked mounting are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Transfocator precedent). The post-sample polarization analyzer stays the distinct loose PolarizationAnalyzer Family pending its own rule-of-three (POL-2). | |
Filter |
Discrete absorber-foil changer Family; at 2-BM the C / Al foil paddles that attenuate and condition the white beam (the upstream paddle 2bma:m17 is the operational selector; the downstream 2bma:m18 is currently Faulted). | |
InsertionDevice |
Source-defining insertion-device Family (the storage-ring straight-section source). One Family spans the cryo-undulator and the wiggler; the device type and its gap / field parameters are a per-Asset settings difference, not a Family split (the Table precedent). TomoWISE: the CPMU14 cryogenic permanent-magnet undulator and the 3T3PW three-pole wiggler, switchable per operation mode. A bending-magnet source (2-BM) is not an insertion device; it stays modelled loosely as the beam source, not through this Family. | |
Goniometer |
Multi-axis sample-orientation goniometer Family: omega / chi / phi rotation plus the x / y / z sample-centring translations, with centre-of-rotation control. The MX micro-goniometer. Distinct from RotaryStage (a single tomographic rotation axis that carries PSO fly-scan Following / Marking, which the goniometer does not) and from TiltStage (a limited-range tilt with no primary rotation axis); the discriminator is the multi-axis crystal-orientation role. Graduated from pending on i03 (the Smargon), CORA's first canonical-goniometer deployment; chi-vs-kappa and axis-count are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Table precedent). The composed multi-stage scattering diffractometer (4-ID / 8-ID, the Diffractometer Assembly) binds one Goniometer Asset for its sample-orientation circles. | |
Manipulator |
Ultra-high-vacuum multi-axis sample manipulator Family: a serial stack of translations and rotations that positions a sample inside a UHV chamber, typically with cryogenic cooling. Distinct from Hexapod (a parallel-kinematic six-strut positioner), from Goniometer (the crystal-orientation circles for diffraction), and from a plain LinearStage / RotaryStage (a single in-air motion axis); the discriminator is the UHV serial-stack sample-environment role. Earned in once two deployments shared it, the soft X-ray beamlines SIX (NSLS-II 2-ID, the cryostat x/y/z/theta manipulator) and ESM (NSLS-II 21-ID, the LT six-axis cryo manipulator x/y/z/Rx/Ry/Rz); axis count, cryo range, and load-lock transfer are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Goniometer precedent). | |
ElectronAnalyzer |
Hemispherical electron energy analyzer Family: a photoemission spectrometer that disperses photoelectrons by kinetic energy (and, in angle-resolved mode, emission angle) over a window set by the pass energy and lens mode. Presents the Detector Role (it acquires the spectrum), but distinct from the photon detectors (Camera, the energy-dispersive Sensor families): it measures electrons out, not photons. Distinct too from the photon EnergyAnalyzer (the IXS diced-crystal energy analyzer): that disperses photons, this disperses electrons. Earned in once two deployments shared it, the soft / tender X-ray photoemission beamlines ESM (NSLS-II 21-ID, the ARPES Scienta SES) and SST (NSLS-II 7-ID, the HAXPES Scienta SES); analyzer model, lens-mode set, and pass-energy range are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Manipulator precedent). The photoemission electron microscope (LEEM / PEEM) is a distinct imaging instrument, deferred (PEEM-1). | |
EmissionSpectrometer |
Crystal-analyzer X-ray emission spectrometer Family: a post-sample instrument that composes one or more bent analyzer crystals and an area / position-sensitive detector along a Rowland-circle (Johann) or wavelength-dispersive (von Hamos) geometry to measure the emitted X-ray spectrum (XES) or select an emission line for high-energy-resolution fluorescence detection (HERFD). Presents the Detector Role (it acquires the emission spectrum). Distinct from EnergyDispersiveSpectrometer (a point Sensor that resolves energy electronically per event, with no analyzer crystal) and from Monochromator (a beam-conditioning Bragg optic upstream of the sample); the discriminator is the post-sample crystal-analyzer emission-dispersing role. Distinct too from the loose EnergyAnalyzer (the IXS diced-crystal analyzer selecting a fixed final energy on the inelastic-scattering arm, ANALYZER-1), which stays loose pending its own rule-of-three, and from the graduated SpectrometerArm Family (the extended dispersive grating / crystal-array positioning arm presenting the Positioner Role): an EmissionSpectrometer is the compact crystal-analyzer Detector, a SpectrometerArm is the extended dispersive positioner. Earned in once two deployments shared it, SLAC LCLS-MFX (the von Hamos six-crystal XES spectrometer) and NSLS-II ISS (8-ID, the Johann plus von Hamos crystal emission spectrometers for XES / HERFD); crystal cut, Rowland radius, and Johann-vs-von-Hamos geometry are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Manipulator precedent). MAX IV Balder is a third near-sighting (SCANIA-2D). Whether each analyzer crystal is a child Asset is deferred (SPEC-1). | |
SpectrometerArm |
Dispersive spectrometer-arm Family: a long post-sample arm that positions a diffraction grating (or an array of analyzer crystals) and carries a position-sensitive detector at its focus, energy-dispersing the scattered or emitted beam along a Rowland or backscattering geometry. Presents the Positioner Role: the arm sets the grating and detector geometry (real detx / detz / grtx axes decomposed to virtual arm radii), which is why it never fit the point-Sensor families (FluxMonitor / EnergyDispersiveSpectrometer). Distinct from EmissionSpectrometer (a compact crystal-analyzer emission spectrometer presenting the Detector Role) and from the loose EnergyAnalyzer (the IXS diced-crystal analyzer selecting a fixed final energy): the discriminator is the extended dispersive positioning arm. Graduated on the rule-of-three across NSLS-II SIX (2-ID, the soft X-ray multi-chamber grating RIXS arm), ESRF ID32 (the RIXS arm and the XES arm, the same SpectrometerArmsController class instantiated twice), and ESRF ID28 (the hard X-ray multi-analyzer two-theta arm); grating-vs-crystal-array, chamber count, and Rowland radius are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Manipulator precedent). Whether each analyzer crystal or chamber is a child Asset is deferred (IXS-1). | |
TemperatureController |
Continuous-setpoint sample-environment temperature actuator Family: drives a sample temperature to a commanded setpoint, typically via a PID control loop. Presents the Regulator Role (requires the Settable affordance). Distinct from Controller (which supervises subordinate Assets without itself performing) and Sensor (which only reports): a TemperatureController performs by acting on the temperature. Graduated on the rule-of-three across Diamond i22 (Linkam), i03 (cryostream, thawer), and i11 (Cyberstar / Eurotherm blowers, Oxford cryostreams); cooling-vs-heating and PID-vs-other are a per-Asset settings or bound-Model difference, not a Family split. FlowController (the settable-setpoint mass-flow / pump actuator sibling that also presents Regulator) graduated alongside it. | |
FlowController |
Continuous-setpoint flow / pump actuator Family: drives a fluid flow rate or a pump delivery (rate / volume) to a commanded setpoint. Presents the Regulator Role (requires the Settable affordance), the settable-actuator sibling of TemperatureController, distinct by what it actuates (mass flow / pump rate, not temperature); and distinct from Controller (which supervises subordinate Assets without performing) and Sensor (which only reports). One Family spans mass-flow controllers and syringe / peristaltic / HPLC pumps; mass-flow-vs-pump and the pump type are a per-Asset settings or bound-Model difference, not a Family split (the TemperatureController precedent). Graduated on the rule-of-three across Diamond i22 (the sample-environment pump), APS 7-BM (the Sierra Smart-Trak mass-flow controllers), NSLS-II LIX (the HPLC sample-delivery pump), and NSLS-II XFP (the footprinting sample-delivery pumps). The wider fluidic chain beyond the pump (selector valves, SEC columns, flow cells, fraction collectors) stays in the ControlPort seam pending its own rule-of-three (FLUID-1). | |
Magnet |
Sample-environment magnet Family: drives a magnetic field at the sample to a commanded setpoint (a single-axis high-field magnet or a multi-axis vector magnet). Presents the Regulator Role (requires the Settable affordance): the field is a settable process variable with a setpoint and a ramp, the TemperatureController / FlowController sibling, distinct by what it actuates (magnetic field, not temperature or flow); and distinct from Controller (which supervises subordinate Assets without performing) and Sensor (which only reports). One Family spans the split-coil superconducting magnets, the resistive electromagnets, and the multi-axis vector magnets; single-vs-vector-axis, field range, and ramp rate are a per-Asset settings or bound-Model difference, not a Family split (the TemperatureController precedent). Graduated on the rule-of-three across APS 4-ID POLAR (the 2 T / high-field magnetic-scattering magnets), Diamond i10-1 (the RASOR electromagnet and superconducting magnet), and ESRF ID32 (the 9 T / 4 T split-coil XMCD magnet); reinforced by SwissFEL Cristallina (the 3-axis vector magnet), PETRA III P09 (14 T) and P07 (17 T). The high-field-magnet personnel hazard is modelled through a Clearance, not baked into the Family. | |
PolarizationAnalyzer |
Post-sample polarization-analysis Family: a scattered-beam analyzer block that measures (or selects) the polarization state of the beam after the sample, typically an analyzer crystal on a motorized arm (two-theta / theta, and the crystal orientation circles) set to a Bragg reflection whose scattering plane resolves the linear or circular polarization components. Presents the Positioner Role (the motorized analyzer circles that set the analysis geometry). Distinct from PhaseRetarder (the upstream optic that sets the incident polarization state, not measures the scattered state) and from Monochromator (which selects energy); the discriminator is post-sample polarization analysis. Graduated on the rule-of-three across APS 4-ID POLAR (the scattered-beam polarimeter), Diamond i10 (the POLAN polarization-analysis arm), ESRF ID32 (the RIXS-arm polarimeter), and PETRA III P09 (the scattered-beam and MAG polarization analyzers); analyzer crystal, arm geometry, and linear-vs-circular analysis are a per-Asset settings or bound-Model difference, not a Family split (the InsertionDevice / Transfocator precedent). Distinct too from the loose EnergyAnalyzer (the IXS diced-crystal analyzer selecting a fixed final energy); whether the two eventually merge into one Analyzer Family is the open ANALYZER-1 question, deferred (EnergyAnalyzer stays at n=1). | |
PressureCell |
High-pressure sample-environment Family: a cell that holds the sample under a commanded pressure, typically a diamond anvil cell whose membrane gas pressure is driven to a setpoint (and read back) via a pressure controller, or a large-volume press. Presents the Regulator Role (requires the Settable affordance) for its membrane / load pressure, the sample-environment sibling of TemperatureController and FlowController, distinct by what it actuates (containment pressure, not temperature or flow). In-situ pressure / temperature metrology (ruby / Raman / Brillouin, spectroradiometry) and optional laser heating are per-Asset capabilities of the same cell, not a Family split. Graduated on the rule-of-three across APS 13-ID (the GSECARS diamond anvil cell on a PACE5000 membrane controller) and PETRA III P02 (the P02.2 diamond-anvil-cell environment); cell type (diamond anvil versus large-volume press), membrane-versus-load actuation, and the heating / metrology capabilities are a per-Asset settings or bound-Model difference, not a Family split (the TemperatureController precedent). | |
Backlight |
Sample-illumination Family: a visible-light source (a back light, ring light, or on-axis illuminator) that lights the sample for optical viewing, typically loop centering and on-axis alignment on an MX or imaging beamline. It is an illuminator, not a measuring device: it presents no Sensor / Detector Role (it produces light for a camera to see by, it does not itself acquire). Any on / off / brightness control or in / out insert axis is a per-Asset facet (a device with a motorized insert may present the Positioner Role for that axis), not the reason the Family exists. Distinct from Camera (which acquires the image the Backlight makes visible) and from any beam-diagnostic Family (it illuminates with visible light, it does not measure the X-ray beam). One Family spans back / front / ring / dual-head illuminators; single-vs-dual head, brightness control, and any insert axis are a per-Asset settings or bound-Model difference, not a Family split. Graduated on the rule-of-three across the MX and imaging fleet that shares on-axis sample illumination (Diamond i03 / i24 / i19, NSLS-II FMX, Australian Synchrotron MX3, SIRIUS MANACA, PETRA III P13 / P14, and the APS 13-ID microscope), the first illumination affordance no prior Family carried (DET-1). | |
Laser |
Optical laser Family: a visible / near-visible laser used at the sample, either a pump-probe excitation source fired in sync with the X-ray pulses (femtosecond / picosecond pump lasers on the time-resolved beamlines) or an alignment / reference laser marking the beam path and sample position. Modelled by Role, not mechanism: an optical laser presents no existing measurement Role (it is neither a Sensor / Detector nor, in itself, a Positioner; its motorized delay stage, waveplate, or shutter are per-Asset facets that may present Positioner for those axes). One Family spans the pump-probe and alignment / reference variants; pump-probe-vs-alignment is a per-Asset purpose (captured in the Asset name), not a Family split (the Table / Camera precedent). Graduated on the rule-of-three across APS 4-ID (the Ventus pump-probe laser), PSI Alvra and Bernina (each a pump-probe plus a reference laser), PSI Cristallina (the alignment laser), and SLAC LCLS-MFX (the fs pump-probe laser). Deliberately EXCLUDES lasers that are a capability of another device read by their actuation Role, not their mechanism: a sample-heating laser is a power-delivery / thermal-actuation capability of its host (the 13-ID PressureCell double-sided heating), NOT a member of this Family, so Laser never becomes a by-mechanism catch-all. Whether a given pump-probe laser is modelled as a device or carried only as a Clearance hazard (SAMPLE-1), and the class-4 laser-emission Enclosure permit / interlock (LASER-1), stay deferred open questions, orthogonal to this Family. | |
Screen |
Beam-viewing diagnostic screen Family: a phosphor / fluorescent screen (or YAG) on a motorized insert that is driven into the beam to make the X-ray beam visible to a camera for alignment and beam-profile viewing, and parked out of the beam for data collection. Presents the Positioner Role for its insert axis (the in / out or energy-tracked height move is the operable degree of freedom); the phosphor / screen material is a per-Asset setting. Distinct from Camera (the Screen makes the beam visible, the Camera acquires the image of it) and from the beam-diagnostic Sensor families (a Screen produces no scalar Reading, it is a viewing target). One Family spans single flags and multi-screen insert banks; screen material, count, and whether the insert height is energy-tracked are a per-Asset settings or bound-Model difference, not a Family split. Graduated on the rule-of-three across APS 2-BM (the energy-tracked diagnostic flag), NSLS-II BMM (the dm2 / dm3 fluorescent screens), and PETRA III P04 (the EXP2 motorized phosphor screen bank) (FLAG-1). |