2.5.23. prismatique.load.scan_pattern_type

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

From a given STEM simulation output file, load the probe scan pattern type stored or specified therein.

Parameters:

filenamestr

The relative or absolute path to the file containing or specifying the probe scan pattern type. 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:

pattern_type“rectangular grid” | “jittered rectangular grid” | “no underlying rectangular grid”: If scan_pattern_type=="rectangular grid", then the probe positions making up the scan pattern lie exactly on a regular rectangular grid. If scan_pattern_type=="jittered rectangular grid", then the set of probe positions making up the scan pattern lie is equal to the set of positions obtained by generating an underlying rectangular grid to which a random positional deviation is applied to each point. In this case, the pattern is irregular but rectangular grid-like. If scan_pattern_type=="no underlying rectangular grid", then the scan pattern is irregular and not rectangular grid-like, i.e. this case is different from the previous two.