API Reference#

ESSpowder#

Module Attributes#

providers

Sciline providers for powder diffraction.

RunNormalization(value[, names, module, ...])

Type of normalization applied to each run.

with_pixel_mask_filenames(workflow, masks)

Return modified workflow with pixel mask filenames set.

Submodules#

calibration

Tools for detector calibration.

conversion

Coordinate transformations for powder diffraction.

correction

Correction algorithms for powder diffraction.

filtering

Prototype for event filtering.

grouping

Grouping and merging of pixels / voxels.

logging

Logging tools for ess.power.

masking

Masking functions for the powder workflow.

smoothing

Smoothing arrays data.

transform

Signal transformation algorithms for powder diffraction.

types

This module defines the domain types used in ess.powder.

ESSdream#

Workflows#

DreamGeant4MonitorHistogramWorkflow()

Workflow with default parameters for the Dream Geant4 simulation, using a histogrammed monitor for the normalization.

DreamGeant4MonitorIntegratedWorkflow()

Workflow with default parameters for the Dream Geant4 simulation, using integrated counts of the monitor for the normalization.

DreamGeant4ProtonChargeWorkflow()

Workflow with default parameters for the Dream Geant4 simulation, using proton charge for the normalization.

DreamGeant4Workflow(*, run_norm, **kwargs)

Workflow with default parameters for the Dream Geant4 simulation.

DreamPowderWorkflow(*, run_norm, **kwargs)

Dream powder workflow with default parameters.

DreamWorkflow(**kwargs)

Dream generic workflow with default parameters.

Top-level functions#

instrument_view(data[, dim, pixel_size, ...])

Three-dimensional visualization of the DREAM instrument.

load_geant4_csv(file_path)

Load a GEANT4 CSV file for DREAM.

Top-level classes#

InstrumentConfiguration(value[, names, ...])

Choose between high-flux and high-resolution configurations.

Submodules#

beamline

data

Data for tests and documentation with DREAM.

diagnostics

Detector diagnostics for DREAM.

io

Input/output for DREAM.

SNS powder#

powgen

Functions and classes for the POWGEN instrument.