2.5.17. prismatique.load.k_xy_coords_of_3d_stem_output

k_xy_coords_of_3d_stem_output(filename, skip_validation_and_conversion=False)

From a given STEM simulation output file that stores 3D-STEM integrated CBED intensity patterns, load the radial scattering momenta coordinates \(k_{xy}\) of said integrated CBED intensity patterns.

See the documentation for the class prismatique.stem.output.Params for a discussion on 3D-STEM integrated CBED intensity patterns.

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:

k_xyarray_like (float, ndim=1)

The set of \(k_xy\)-coordinates, in ascending order, and in units of 1/Å.