SelectedEventFunctionParams

class libcasm.monte.sampling.SelectedEventFunctionParams(

self: SelectedEventFunctionParams,

)

Bases: pybind11_object

Parameters controlling selected event data collection

Constructor

Default constructor only.

Methods

collect(…)	Add the name of a quantity to be collected for each selected event, along with optional custom settings.
collect_hop_correlations(…)	Update to collect hop correlations data
copy(…)	Returns a copy of the SelectedEventFunctionParams.
do_not_collect(…)	Remove the name of a quantity to be collected, and remove all custom settings for that quantity.
do_not_collect_hop_correlations(…)	Update to not collect hop correlations data
evaluate(…)	Add the name of a function to be evaluated for each selected event, along with optional order of evaluation.
from_dict(…)	Construct SelectedEventFunctionParams from a Python dict.
get_parameters(…)	Get the custom settings for a quantity to be collected
reset(…)	Clear all quantities to be collected and any custom settings
to_dict(…)	Represent the SelectedEventFunctionParams as a Python dict.

Attributes

correlations_data_params	Parameters for hop correlations data, which may be None if hop correlations data is not to be collected.
function_names	The names of the selected event data functions which should be evaluated to collect data during a simulation.