ewoksfluo.tasks.example_data.scan_data.save_2d_xrf_scans#

ewoksfluo.tasks.example_data.scan_data.save_2d_xrf_scans(filename, emission_line_groups, first_scan_number, shape, mosaic, energy=12, flux=10000000.0, expo_time=0.1, counting_noise=True, integral_type=True, rois=(), nmcas=1, max_deviation=0, seed=None, interrupt_fraction=None)[source]#

Simulates and saves 2D XRF scans to a NeXus file.

Parameters:

  • filename (str) – Output file path.

  • emission_line_groups (List[str]) – List of emission line groups as “Element-Group”.

  • first_scan_number (int) – Scan number of the first scan in the output file.

  • shape (Tuple[int, int]) – Scan shape.

  • mosaic (Tuple[int, int]) – Split shape in this number of blocks.

  • energy (float) – Incident X-ray energy in keV.

  • flux (float) – Incident X-ray flux in photons per second.

  • expo_time (float) – Exposure time per point in seconds.

  • counting_noise (bool) – If True, adds Poisson noise to data.

  • integral_type (bool) – If True, data represents integrated intensities.

  • rois (Sequence) – Regions of interest as energy ranges.

  • ndetectors – Number of detectors.

  • max_deviation (float) – Maximum deviation from a perfect grid as a fraction of the scan step size.

  • seed (Optional[int]) – Random seed for reproducibility.

  • interrupt_fraction (Optional[float])

  • nmcas (int)

Return type:

List[int]

Returns:

Scan numbers as many as there are blocks in the mosaic.

Raises:

ValueError – If shape is not 2D.