bilby.core.result.read_in_result

bilby.core.result.read_in_result(filename=None, outdir=None, label=None, extension=None, gzip=False, result_class=None)

Reads in a stored bilby result object

Parameters:

filename: str

Path to the file to be read (alternative to giving the outdir and label)

outdir, label, extension: str

Name of the output directory, label and extension used for the default naming scheme.

extension: str, optional

The file extension to use. If not given, the extension is inferred from the filename if provided. If the filename is not given, defaults to ‘json’.

result_class: bilby.core.result.Result, or child of

The result class to use. By default, bilby.core.result.Result is used, but objects which inherit from this class can be given providing additional methods.