GravitySpyTable#

class gwpy.table.GravitySpyTable(
data=None,
masked=False,
names=None,
dtype=None,
meta=None,
copy=True,
rows=None,
copy_indices=True,
units=None,
descriptions=None,
**kwargs,
)[source]#

Bases: EventTable

A container for a table of Gravity Spy Events.

As well as Events from the O1 Glitch Classification Paper which includes:

  • PCAT

  • PC-LIB

  • WDF

  • WDNN

  • Karoo GP

See also

astropy.table.Table

for details on parameters for creating a GravitySpyTable

Methods Summary

download([download_path, parallel, ...])

Download image files associated with entries in a GravitySpyTable.

search(gravityspy_id[, howmany, era, ifos, ...])

Perform a GravitySpy 'Similarity Search' for the given ID.

Methods Documentation

download(
download_path: str | Path = 'download',
parallel: int = 1,
download_durs: Sequence[float] = (0.5, 1.0, 2.0, 4.0),
*,
training_set: bool = False,
labelled_samples: bool = False,
) → list[str][source]#

Download image files associated with entries in a GravitySpyTable.

Parameters:
parallelint, optional

Number of parallel threads to use for parallel file reading.

download_pathstr optional

Target directory for downloaded images.

download_durslist optional

List of durations to download, must be a subset of [0.5, 1.0, 2.0, 4.0]. Default is to download all the available GSpy durations.

training_setbool, optional

If True download training set data.

labelled_samplesbool, optional

If True download only labelled samples.

classmethod search(
gravityspy_id: str,
howmany: int = 10,
era: str = 'ALL',
ifos: tuple[str, ...] | str = ('H1', 'L1'),
database: str = 'similarity_index_o3',
host: str = 'https://gravityspytools.ciera.northwestern.edu',
timeout: float | None = 30.0,
**kwargs,
) → Self[source]#

Perform a GravitySpy ‘Similarity Search’ for the given ID.

Parameters:
gravityspy_idstr

The unique 10 character hash that identifies a Gravity Spy image.

howmanyint, optional

The number of similar images you would like.

erastr, optional

Which era to search, see online for more information.

ifostuple, str`, optional

The list of interferometers to include in the search.

databasestr, optional

The database to query.

hoststr, optional

The URL (scheme and FQDN) of the Gravity Spy host to query

timeoutfloat, optional

How long to wait for the server to respond before giving up.

**kwargs

Other kwargs are passed to requests.get to perform the actual remote communication.

Returns:
tableGravitySpyTable

A GravitySpyTable containing similar events based on an evaluation of the Euclidean distance of the input image to all other images in some Feature Space.

Notes

For an online version, and documentation of the search, see

https://gravityspytools.ciera.northwestern.edu/search/