2.5.20. prismatique.load.output_layer_depths

output_layer_depths(filename, skip_validation_and_conversion=False)

From a given STEM simulation output file, load the output layer depths stored or specified therein.

Parameters:

filenamestr

The relative or absolute path to the file containing the output layer depths. Any non-temporary file generated by the function prismatique.stem.sim.run() that does not store potential slice or S-matrix data, is a valid file. In other words, any file generated by a STEM simulation with originally the basename "stem_sim_intensity_output.h5", "stem_sim_params.json", or a basename of the form "stem_sim_wavefunction_output_of_subset_"+str(i)+".h5", where i is a nonnegative integer.

See the documentation for the class prismatique.stem.output.Params for a discussion on the layout and structure of prismatique STEM 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:

layer_depthsarray_like (float, ndim=1)

The output layer depths, in units of Å, in ascending order. Note that for STEM simulations that use the PRISM algorithm, layer_depths is a single-element array, where the single element is the the \(z\)-dimension of the sample’s supercell in units of Å [see the documentation for the class prismatique.discretization.Params for a discussion on the sample’s supercell].