pycbc.catalog package

Submodules

This modules contains information about the announced LIGO/Virgo compact binary mergers

pycbc.catalog.catalog.get_source(source)[source]: Get the source data for a particular GW catalog

pycbc.catalog.catalog.list_catalogs()[source]: Return a list of possible GW catalogs to query

pycbc.catalog.catalog.populate_catalogs()[source]: Refresh set of known catalogs

This package provides information about LIGO/Virgo detections of compact binary mergers

class pycbc.catalog.Catalog(source='gwtc-3')[source]

Manage a set of binary mergers

median1d(param, return_errors=False)[source]

Return median 1d marginalized parameters

Parameters:

name (str) – The name of the parameter requested
return_errors (Optional, {bool, False}) – If true, return a second and third parameter that represents the lower and upper 90% error on the parameter.

Returns:

param – The requested parameter

Return type:

nump.ndarray or tuple

class pycbc.catalog.Merger(name, source=None)[source]

Informaton about a specific compact binary merger

median1d(name, return_errors=False)[source]

Return median 1d marginalized parameters

Parameters:

name (str) – The name of the parameter requested
return_errors (Optional, {bool, False}) – If true, return a second and third parameter that represents the lower and upper 90% error on the parameter.

Returns:

param – The requested parameter

Return type:

float or tuple

strain(ifo, duration=32, sample_rate=4096)[source]

Return strain around the event

Currently this will return the strain around the event in the smallest format available. Selection of other data is not yet available.

Parameters:: ifo (str) – The name of the observatory you want strain for. Ex. H1, L1, V1
Returns:: strain – Strain around the event.
Return type:: pycbc.types.TimeSeries

pycbc.catalog.find_event_in_catalog(name, source=None)[source]

Get event data from a catalog

Parameters:

name (str) – Name of event to retrieve from catalog
source (str, None) – If not provided, look through each catalog until event is found. If provided, only check that specific catalog.