2.5.16. prismatique.load.integration_limits_of_2d_stem_output

integration_limits_of_2d_stem_output(filename, skip_validation_and_conversion=False)[source]

From a given STEM simulation output file that stores 2D-STEM integrated CBED intensity patterns, load the 2D-STEM integration limits.

See the documentation for the class prismatique.stem.output.Params for a discussion on 2D-STEM integrated CBED intensity patterns, i.e. STEM intensity images.

Parameters:
filenamestr

The relative or absolute path to the file containing the integrated CBED intensity patterns of interest. Any non-temporary file generated by the function prismatique.stem.sim.run() with originally the basename "stem_sim_intensity_output.h5" is valid.

See the documentation for the class prismatique.stem.output.Params for a discussion on the layout and structuring of prismatique STEM simulation output files.

skip_validation_and_conversionbool, optional

If skip_validation_and_conversion is set to False, then validations and conversions are performed on the above parameters.

Otherwise, if skip_validation_and_conversion is set to True, no validations and conversions are performed on the above parameters. This option is desired primarily when the user wants to avoid potentially expensive validation and/or conversion operations.

Returns:
integration_limitsarray_like (float, shape=(2,))

integration_limits[0] is the lower integration limit in mrads; integration_limits[1] is the upper integration limit in mrads.