2.5.5. prismatique.load.cbed_k_x_coords

cbed_k_x_coords(filename, skip_validation_and_conversion=False)

From a given STEM simulation output file that stores CBED patterns, load the \(k_x\)-coordinates of said CBED patterns.

See also the documentation for the class prismatique.cbed.Params for a discussion on CBED patterns.

Parameters:

filenamestr

The relative or absolute path to the file containing the CBED patterns of interest. Any non-temporary file generated by the function prismatique.stem.sim.run() with originally the basename "stem_sim_intensity_output.h5", or a basename of the form "stem_sim_wavefunction_output_of_subset_"+str(i)+".h5" is valid, where i is a nonnegative integer. Note that CBED patterns stored in the former are postprocessed, whereas those stored in the latter are not, hence the \(k_x\)-coordinates of the former set of CBED patterns are generally different than the latter set.

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

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_xarray_like (float, ndim=1)

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