ResultList

class ResultList(results=None, consistency_level='warning')

Bases: list

__init__(results=None, consistency_level='warning')

A class to store a list of bilby.core.result.Result objects from equivalent runs on the same data. This provides methods for outputting combined results.

Parameters:

results: list

A list of :class:`bilby.core.result.Result.

consistency_level: str, [ignore, warning, error]

If warning, print a warning if inconsistencies are discovered between the results. If error, raise an error if inconsistencies are discovered between the results before combining. If ignore, do nothing.

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__([results, consistency_level])	A class to store a list of bilby.core.result.Result objects from equivalent runs on the same data.
append(result)	Append a bilby.core.result.Result, or set of results, to the list.
check_consistent_data()
check_consistent_parameters()
check_consistent_priors()
check_consistent_sampler()
check_nested_samples()
combine([shuffle, consistency_level])	Return the combined results in a :class:bilby.core.result.Result` object.

append(result)

Append a bilby.core.result.Result, or set of results, to the list.

Parameters:

result: :class:`bilby.core.result.Result` or filename

pointing to a result object, to append to the list.

combine(shuffle=False, consistency_level='error')

Return the combined results in a :class:bilby.core.result.Result` object.

Parameters:

shuffle: bool

If true, shuffle the samples when combining, otherwise they are concatenated.

consistency_level: str, [ignore, warning, error]

Overwrite the class level consistency_level. If warning, print a warning if inconsistencies are discovered between the results. If error, raise an error if inconsistencies are discovered between the results before combining. If ignore, do nothing.

Returns:

result: bilby.core.result.Result

The combined result file