API Reference

Workflows

CorrectionWorkflow([half_polarized])	Create a workflow for polarization correction.
He3CellWorkflow(*[, in_situ, incoming_polarized])	Workflow for computing transmission functions for He3 cells.
HalfPolarizedWorkflow(*, polarizer_workflow)	Create a half-polarized workflow, i.e, with a polarizer but no analyzer.
PolarizationAnalysisWorkflow(*, ...)	Create a polarization analysis workflow.
SupermirrorWorkflow()	Workflow for computing transmission functions for supermirror polarizing elements.

Classes

Analyzer	NewType creates simple unique types with almost zero runtime overhead.
Depolarized	NewType creates simple unique types with almost zero runtime overhead.
DirectBeamBackgroundQRange	NewType creates simple unique types with almost zero runtime overhead.
DirectBeamNoCell	NewType creates simple unique types with almost zero runtime overhead.
DirectBeamQRange	NewType creates simple unique types with almost zero runtime overhead.
Down	NewType creates simple unique types with almost zero runtime overhead.
EfficiencyLookupTable(table)	Efficiency of a supermirror as a lookup table.
HalfPolarizedCorrectedData(up, down)	Polarization-corrected sample data for half-polarized case.
He3CellLength(x)	Length for a given cell.
He3CellPressure(x)	Pressure for a given cell.
He3DirectBeam(x)	Direct beam data for a given cell and spin state as a function of wavelength.
He3FillingTime(x)	Filling wall-clock time for a given cell.
He3OpacityFunction(opacity0)	Wavelength-dependent opacity function for a given cell.
He3PolarizationFunction(C, T1)	Time-dependent polarization function for a given cell.
He3TransmissionFunction(opacity_function, ...)	Wavelength- and time-dependent transmission for a given cell.
He3TransmissionEmptyGlass(x)	Transmission of the empty glass for a given cell.
PolarizationCorrectedData(upup, updown, ...)	Polarization-corrected sample data.
Polarized	NewType creates simple unique types with almost zero runtime overhead.
Polarizer	NewType creates simple unique types with almost zero runtime overhead.
SecondDegreePolynomialEfficiency(a, b, c)	Efficiency of a supermirror as a second-degree polynomial
SupermirrorEfficiencyFunction()	Base class for supermirror efficiency functions
TotalPolarizationCorrectedData	NewType creates simple unique types with almost zero runtime overhead.
Up	NewType creates simple unique types with almost zero runtime overhead.

Top-level functions

Submodules