sharp.qoi.get_qoi

sharp.qoi.get_qoi(qoi)

Get a quantity of interest from string.

get_qoi_names() can be used to retrieve the names of all available quantities of interest.

Parameters:

qoistr, callable or None

Quantity of interest as string. If callable it is returned as is. If None, returns None.

Returns:

quantitycallable

The quantity of interest.

Notes

When passed a string, this function always returns a copy of the scorer object. Calling get_qoi twice for the same scorer results in two separate QoI objects.