2.5.14. prismatique.load.hrtem_image_y_coords

hrtem_image_y_coords(filename, skip_validation_and_conversion=False)

From a given HRTEM simulation output file that stores HRTEM images, load the \(y\)-coordinates of said HRTEM images.

See also the documentation for the class prismatique.hrtem.image.Params for a discussion on HRTEM images.

Parameters:

filenamestr

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

See the documentation for the class prismatique.hrtem.output.Params for a discussion on the layout and structuring of prismatique HRTEM simulation output files. See also the documentation for the class prismatique.hrtem.image.Params for a discussion on postprocessing HRTEM images.

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:

r_yarray_like (float, ndim=1)

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