yt.analysis_modules.two_point_functions.two_point_functions.FcnSet.add_function

FcnSet.add_function(function, out_labels, sqrt, corr_norm=None)

Add a function to the list that will be evaluated at the generated pairs of points.

Parameters:

function : Function

The two point function of the form fcn(a, b, r1, r2, vec).

out_labels : List of strings

A list of strings labeling the outputs of the function.

sqrt : List of booleans

A list of booleans which when True will square-root the corresponding element of the output in the text output (write_out_means()).

corr_norm : Float

Used when calculating two point correlations. If set, the output of the function is divided by this number. Default = None.

Examples

>>> f1 = tpf.add_function(function=rms_vel, out_labels=['RMSvdiff'],
... sqrt=[True])