corrections
This module contains a series of corrections that can be applied to detector images.
Module Contents
Functions
Applies Lorentz corrections to the intensities passed as an argument. This function wraps mapper_c_utils.lorentz_correction, making sure that arguments have the correct dtype and shape. |
|
Carries out an exact polarisation correction assuming that the incident light is perfectly linearly polarised. |
API
- corrections.make_float32(data_arrays)
- corrections.get_corr_ints_kout(intensities, k_out)
- corrections.reshape_to_original(intensities, k_out, start_shapes)
- corrections.lorentz(intensities: numpy.ndarray, k_in: numpy.ndarray, k_out: numpy.ndarray)
Applies Lorentz corrections to the intensities passed as an argument. This function wraps mapper_c_utils.lorentz_correction, making sure that arguments have the correct dtype and shape.
- Args:
- intensities:
The intensity values we would like to correct. This should have shape (N).
- k_in:
The wavevector of the incident light. This should have shape (3,).
- k_out:
The wavevector of the outgoing light. This should have shape (N, 3).
- Returns:
The updated intensities. You don’t need to use the returned value since the original intensity array will have been updated, but this way the function just works however you use it.
- corrections.linear_polarisation(intensities: numpy.ndarray, k_out: numpy.ndarray, polarisation_vector: numpy.ndarray)
Carries out an exact polarisation correction assuming that the incident light is perfectly linearly polarised.
- Args:
- intensities:
The intensity values we would like to correct. This should have shape (N).
- k_out:
The wavevector of the outgoing light. This should have shape (N, 3).
- polarisation_vector:
A vector describing the polarisation of the incident beam.
- Returns:
The updated intensities. You don’t need to use the returned value since the original intensity array will have been updated, but this way the function just works however you use it.