default_bin_config#
Module for extracting default binning configurations for artof data.
- artof.default_bin_config.get_default_bipolar_config(theta_max)#
Extract the default bipolar (alpha & beta) binning configuration.
- Parameters:
theta_max (float) – The maximum theta value from acquisition.cfg.
- Returns:
The default configuration for bipolar (alpha & beta) binning configs.
- Return type:
list
- artof.default_bin_config.get_default_e_config(e_min, e_max, e_step_size=None)#
Extract the default E binning configuration.
- Parameters:
e_min (float) – The minimum value of the E binning from acquisition.cfg.
e_max (float) – The maximum value of the E binning from acquisition.cfg.
e_step_size (float) – The step size of the E binning e from acquisition.cfg for sweep mode. Default is None and therefore E_POINTS will be used.
- Returns:
The default configuration for E binning configs.
- Return type:
list
- artof.default_bin_config.get_default_k_config(theta_max, end_energy)#
Extract the default bipolar (alpha & beta) binning configuration.
- Parameters:
theta_max (float) – The maximum theta value from acquisition.cfg.
end_energy (float) – The end energy of the spectrum from acquisition.cfg.
- Returns:
The default configuration for bipolar (alpha & beta) binning configs.
- Return type:
list
- artof.default_bin_config.get_default_phi_config()#
Extract the default phi binning configuration.
- Returns:
The default configuration for phi binning configs.
- Return type:
list
- artof.default_bin_config.get_default_t_config(aquisition, t0, si=False)#
Extract the default t binning configuration.
- Parameters:
metadata – Metadata extracted from acquisition.cfg file
t0 (int) – The t offset.
si (bool) – Whether binning configuration should be given in SI units (s).
aquisition (Acquisition)
- Returns:
The default configuration for t binning configs.
- Return type:
list
- artof.default_bin_config.get_default_theta_config(theta_max)#
Extract the default theta binning configuration.
- Parameters:
theta_max (float) – The maximum theta value from acquisition.cfg.
- Returns:
The default configuration for theta binning configs.
- Return type:
list
- artof.default_bin_config.get_default_xyr_config(spatial_diameter, scaling_factor=1, radius=False)#
Extract the default x, y or r binning configuration.
- Parameters:
spatial_diameter (int) – Spacial diameter of the detector.
scaling_factor (float) – The scaling factor of the x, y r binning (default is 1). Important for x and y in SI units.
radius (bool) – Weather the binning should be in radius or not.
- Returns:
The default configuration for x, y or r binning configs.
- Return type:
list