Compute Comparison

Return to Homepage

class gval.comparison.compute_comparison.ComparisonProcessing

Class for Processing Agreement Maps and Tabulations

registered_functions

Available statistical functions with names as keys and parameters as values

Type:

dict

available_functions() → list

Lists all available functions

Return type:

List of available functions

comparison_function_from_string(func: Callable) → Callable

Decorator function to compose a pairing dict comparison function from a string argument

Parameters:

func (Callable) – Function requiring check for pairing_dict comparison function

Returns:

Function with appropriate comparison function

Return type:

Callable

function_signature_check(func)

Validates signature of registered function

Parameters:

func (function) – Function to check the signature of

get_all_parameters()

Get all the possible arguments

Return type:

List of all possible arguments for functions

get_parameters(func_name: str) → list

Get parameters of registered function

Parameters:

func_name (str) –

Return type:

List of parameter names for the associated function

process_agreement_map(**kwargs) → DataArray | Dataset

Parameters:

**kwargs –

Returns:

• Union[xr.DataArray, xr.Dataset]

• Agreement map.

register_function(name: str, vectorize_func: bool = False)

Register decorator function in comparison class

Parameters:

• name (str) – Name of function to register in comparison class

• vectorize_func (bool) – Whether to vectorize the function

Return type:

Decorator function

register_function_class(vectorize_func: bool = False)

Register decorator function for an entire class

Parameters:

vectorize_func (bool) – Whether to vectorize the function