2.5.11. prismatique.load.hrtem_beam_tilts

hrtem_beam_tilts(filename, skip_validation_and_conversion=False)

From a given HRTEM simulation output file, load the beam tilts stored or specified therein that were used in the simulation.

Parameters:

filenamestr

The relative or absolute path to the file containing the beam tilts. Any non-temporary file generated by the function prismatique.hrtem.sim.run(), with originally the basename "hrtem_sim_params.json", or a basename of the form "hrtem_sim_wavefunction_output_of_subset_"+str(i)+".h5", where i is a nonnegative integer.

See the documentation for the class prismatique.hrtem.output.Params for a discussion on the layout and structure of prismatique HRTEM simulation output files respectively.

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:

beam_tiltsarray_like (float, shape=(num_tilts, 2))

If we let num_tilts be the number of beam tilts, then beam_tilts[i][0] and beam_tilts[i][1] are the \(x\)- and \(y\)-components of the i th beam tilt in units of mrads, where 0<=i<num_vectors.