2.5.9. prismatique.load.defocii

defocii(filename, skip_validation_and_conversion=False)[source]

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

Parameters:

filenamestr

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

See the documentation for the classes prismatique.stem.output.Params and prismatique.hrtem.output.Params for discussions on the layout and structure of prismatique STEM and 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_defociiarray_like (float, ndim=1): The beam defocii, in units of Å, in ascending order.