2.5.15. prismatique.load.hrtem_intensity_image

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

From a given HRTEM simulation output file that stores an HRTEM intensity image, load said HRTEM intensity image into a hyperspy signal.

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

Parameters:

filenamestr

The relative or absolute path to the file containing the HRTEM intensity image. Any non-temporary file generated by the function prismatique.stem.sim.run(), with originally the basename "hrtem_sim_intensity_output.h5" is valid, where i is a nonnegative integer. See the documentation for the class prismatique.hrtem.output.Params for a discussion on the layout and structuring of prismatique HRTEM 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:

hrtem_intensity_image_signalhyperspy._signals.signal2d.Signal2D: The HRTEM intensity image, stored in an instance of the hyperspy._signals.signal2d.Signal2D class. See the documentation and/or reference guide for the hyperspy package for details on how to use instances of the hyperspy._signals.signal2d.Signal2D class.