2.8.1.1. prismatique.stem.output.data_size

data_size(stem_system_model_params, output_params=None, skip_validation_and_conversion=False)

Calculate the data size of the STEM simulation output that one could generate according to a given STEM system model, and output parameter set.

Note that data size due to HDF5 file overhead and metadata are not taken into account.

Parameters:

stem_system_model_paramsprismatique.stem.system.ModelParams

The simulation parameters related to the modelling of the STEM system. See the documentation for the class prismatique.stem.system.ModelParams for a discussion on said parameters.

output_paramsprismatique.stem.output.Params | None, optional

The output parameters for the STEM simulation. See the documentation for the class prismatique.stem.output.Params for a discussion on said parameters. If output_params is set to None [i.e. the default value], then the aforementioned simulation parameters are set to default values.

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:

output_data_sizeint

The data size in units of bytes.