ess.reduce.polarization.correction.compute_polarization_correction#

ess.reduce.polarization.correction.compute_polarization_correction(*, analyzer, polarizer, analyzer_flipper, polarizer_flipper)[source]#

Compute columns of combined correction coefficients for polarizer and analyzer.

This is effectively a column resulting from a sparse matrix-matrix product.

Parameters:

  • analyzer (PolarizingElementCorrection[TypeVar(PolarizerSpin, polarization.types.Up (int), polarization.types.Down (int)), TypeVar(AnalyzerSpin, polarization.types.Up (int), polarization.types.Down (int)), polarization.types.Analyzer (str)]) – Correction coefficients for the analyzer.

  • polarizer (PolarizingElementCorrection[TypeVar(PolarizerSpin, polarization.types.Up (int), polarization.types.Down (int)), TypeVar(AnalyzerSpin, polarization.types.Up (int), polarization.types.Down (int)), polarization.types.Polarizer (str)]) – Correction coefficients for the polarizer.

  • analyzer_flipper (InverseFlipperMatrix[TypeVar(AnalyzerSpin, polarization.types.Up (int), polarization.types.Down (int)), polarization.types.Analyzer (str)]) – Flipper matrix for the analyzer.

  • polarizer_flipper (InverseFlipperMatrix[TypeVar(PolarizerSpin, polarization.types.Up (int), polarization.types.Down (int)), polarization.types.Polarizer (str)]) – Flipper matrix for the polarizer.

Returns:

PolarizationCorrection[TypeVar(PolarizerSpin, polarization.types.Up (int), polarization.types.Down (int)), TypeVar(AnalyzerSpin, polarization.types.Up (int), polarization.types.Down (int))] – Combined correction coefficients.