ess.powder.types#

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

The domain types are used to define parameters and to request results from a Sciline pipeline.

Module Attributes

CalibrationFilename

Filename of the instrument calibration file.

DspacingBins

Bin edges for d-spacing.

OutFilename

Filename of the output.

TwoThetaBins

Bin edges for grouping in 2theta.

UncertaintyBroadcastMode(value)

Mode for broadcasting uncertainties.

ValidTofRange

Min and max tof value of the instrument.

CalibrationData

Detector calibration data.

DspacingHistogram

Histogrammed intensity vs d-spacing.

ElasticCoordTransformGraph

Graph for transforming coordinates in elastic scattering.

IofDspacing

Data that has been normalized by a vanadium run.

IofTof

Data that has been normalized by a vanadium run and converted to ToF.

IofDspacingTwoTheta

Data that has been normalized by a vanadium run, and grouped into 2theta bins.

MaskedDetectorIDs

1-D variable listing all masked detector IDs.

CaveMonitorPosition

Position of DREAM's cave monitor.

PixelMaskFilename

Filename of a pixel mask.

TofMask

TofMask is a callable that returns a mask for a given TofData.

TwoThetaMask

TwoThetaMask is a callable that returns a mask for a given TwoThetaData.

WavelengthMask

WavelengthMask is a callable that returns a mask for a given WavelengthData.

Beamline(**data)

A beamline / instrument.

ReducerSoftwares

Pieces of software used to reduce the data.

Source(**data)

Information about a neutron source.

CIFAuthors

List of authors to save to output CIF files.

ReducedTofCIF

Reduced data in time-of-flight, ready to be saved to a CIF file.

TimeOfFlightLookupTableFilename

Filename of the time-of-flight lookup table.

Classes

AccumulatedProtonCharge(*args, **kwargs)

Total proton charge.

DataWithScatteringCoordinates(x)

Data with scattering coordinates computed for all events: wavelength, 2theta, d-spacing.

DetectorLtotal(x)

Total path length of neutrons from source to detector (L1 + L2).

DspacingData(x)

Data converted to d-spacing.

FilteredData(x)

Raw data without invalid events.

FocussedDataDspacing(x)

Intensity vs d-spacing after focussing pixels.

FocussedDataDspacingTwoTheta(x)

Intensity vs (d-spacing, 2theta) after focussing pixels.

MaskedData(x)

Data with masked pixels, tof regions, wavelength regions, 2theta regions, or dspacing regions.

MonitorFilename(x)

Filename for monitor data.

MonitorLtotal(x)

Total path length of neutrons from source to monitor.

NormalizedRunData(x)

Data that has been normalized by proton charge.

ProtonCharge(x)

Time-dependent proton charge.

RawDataAndMetadata(*args, **kwargs)

Raw data and associated metadata.

TofData(x)

Data with time-of-flight coordinate.

TofMonitorData(x)

Monitor data with time-of-flight coordinate.

WavelengthMonitor(x)

Monitor histogram in wavelength.