2.4.1.1. prismatique.hrtem.image.blank_unprocessed_image_signal

blank_unprocessed_image_signal(sample_specification, skip_validation_and_conversion=False)

Generate a blank unprocessed HRTEM intensity image as a hyperspy signal.

This Python function may help users determine what postprocessing sequence they require to obtain postprocessed HRTEM intensity images with the desired pixel sizes, number of pixels, etc. For a discussion on postprocessing HRTEM intensity images, see the documentation for the class prismatique.hrtem.image.Params.

Parameters:

sample_specificationprismatique.sample.ModelParams | prismatique.sample.PotentialSliceSubsetIDs

The simulation parameters specifying the sample model.

If sample_specification is of the type prismatique.sample.ModelParams, then sample_specifications specifies sample model parameters that are used to construct the model from scratch, i.e. the potential slices for each frozen phonon configuration subset are calculated from said model parameters. See the documentation for the classes prismatique.discretization.Params and prismatique.thermal.Params for discussions on potential slices and frozen phonon configuration subsets respectively. Note that of parameters stored in sample_specification, only the following are used:

• sample_specification

  • atomic_coords_filename

  • unit_cell_tiling

  • discretization_params

    • interpolation_factors

Otherwise, if sample_specification is an instance of the class prismatique.sample.PotentialSliceSubsetIDs then sample_specification specifies a set of files, where each file stores the pre-calculated potential slices for a frozen phonon configuration subset. See the documentation for the aforementioned class for a further discussion on specifying pre-calculated potential slices.

Returns:

image_signalhyperspy._signals.signal2d.Signal2D

The blank unprocessed image, represented as a hyperspy signal. The convention used in prismatique is that, when converted to a hyperspy signal, the HRTEM intensity image is visualized with the \(x\)-axis being the horizontal axis, increasing from left to right, and the \(y\)-axis being the vertical axis, increasing from bottom to top, both expressed in units of \(Å\).