autoemxsp.runners.collect_particle_statistics module
Batch acquisition (and optional quantification) of X-ray spectra for a list of powder samples.
- param samples:
- List of sample definitions. Each dictionary must contain:
‘ID’ (str): Sample identifier (SampleConfig.ID).
‘pos’ (tuple of float): (x, y) stage coordinates in mm (SampleConfig.center_pos).
- type samples:
list of dict
- param n_par_target:
Target amount of particles to analyse
- type n_par_target:
int
- param microscope_ID:
Identifier for the microscope hardware. Must correspond to a calibration folder in ./XSp_calibs/Microscopes/<ID> (MicroscopeConfig.ID). Default is ‘PhenomXL’.
- type microscope_ID:
str, optional
- param microscope_type:
Type of microscope. Allowed: ‘SEM’ (implemented), ‘STEM’ (not implemented). Default is ‘SEM’ (MicroscopeConfig.type).
- type microscope_type:
str, optional
- param detector_type:
Default : BSD
- type detector_type:
str, optional
- param sample_halfwidth:
Half-width of the sample area in mm for mapping/acquisition. Default is 3.0 (SampleConfig.half_width_mm).
- type sample_halfwidth:
float, optional
- param sample_substrate_type:
Type of sample substrate. Allowed: ‘Ctape’, ‘None’. Default is ‘Ctape’ (SampleSubstrateConfig.type).
- type sample_substrate_type:
str, optional
- param sample_substrate_shape:
Shape of the substrate. Allowed: ‘circle’, ‘square’. Default is ‘circle’ (SampleSubstrateConfig.shape).
- type sample_substrate_shape:
str, optional
- param sample_substrate_width_mm:
Lateral dimension of substrate holder in mm (SampleSubstrateConfig.stub_w_mm).
- type sample_substrate_width_mm:
float, optional
- param working_distance:
Working distance in mm for acquisition. If None, taken from microscope driver. Default is 5.0 (MeasurementConfig.working_distance).
- type working_distance:
float, optional
- param is_manual_navigation:
If True, navigation to sample positions is manual. Default is False (MeasurementConfig.is_manual_navigation).
- type is_manual_navigation:
bool, optional
- param is_auto_substrate_detection:
If True, substrate elements are detected automatically. Implemented only for ‘Ctape’ substrates. Default is False (SampleSubstrateConfig.auto_detection).
- type is_auto_substrate_detection:
bool, optional
- param auto_adjust_brightness_contrast:
If True, brightness/contrast are set automatically. Default is True (MicroscopeConfig.is_auto_BC).
- type auto_adjust_brightness_contrast:
bool, optional
- param contrast:
Manual contrast setting (required if auto_adjust_brightness_contrast is False). Default is 4.3877 (MicroscopeConfig.contrast).
- type contrast:
float, optional
- param brightness:
Manual brightness setting (required if auto_adjust_brightness_contrast is False). Default is 0.4504 (MicroscopeConfig.brightness).
- type brightness:
float, optional
- param powder_meas_cfg_kwargs:
Additional keyword arguments for PowderMeasurementConfig.
- type powder_meas_cfg_kwargs:
dict, optional
- param output_filename_suffix:
String appended to output filenames. Default is ‘’.
- type output_filename_suffix:
str, optional
- param development_mode:
If True, enables development/debug features. Default is False.
- type development_mode:
bool, optional
- param verbose:
If True, print verbose output. Default is True.
- type verbose:
bool, optional
- param results_dir:
Directory where results are saved. Default is None.
- type results_dir:
str, optional
- returns:
comp_analyzer – The composition analysis object containing the results and methods for further analysis.
- rtype:
EMXSp_Composition_Analyzer