frb.surveys.cluster_search

A module to query for galaxy groups/clusters around a given FRB. Currently has only the Tully cluster catalog but can be possibly extended for other sources.

class frb.surveys.cluster_search.VizierCatalogSearch(coord, radius=<Quantity 90. deg>, survey=None, viziercatalog=None, cosmo=None, **kwargs)

Bases: SurveyCoord

A class to query sources within a Vizier catalog.

__init__(coord, radius=<Quantity 90. deg>, survey=None, viziercatalog=None, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

class frb.surveys.cluster_search.TullyGroupCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Tully 2015 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>, richness_cut=5)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.WenGroupCat(coord, radius=<Quantity 0.2 deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Wen+2024 group/cluster catalog.

__init__(coord, radius=<Quantity 0.2 deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>, richness_cut=5)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.UPClusterSZCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Bahk and Hwang 2024 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.ROSATXClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Xu+2022 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.TempelClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Tempel+2018 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.RASSClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Klein+ 2023 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.RedMapperClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Rykoff+ 2014 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.ACTDR5ClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Klein+ 2024 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.

class frb.surveys.cluster_search.ERASSClusterCat(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

Bases: VizierCatalogSearch

A class to query sources within the Kluge+ 2024 group/cluster catalog.

__init__(coord, radius=<Quantity 90. deg>, cosmo=None, **kwargs)

clean_catalog(catalog)

This will be survey specific.

get_catalog(query_fields=None, transverse_distance_cut=<Quantity inf Mpc>)

Get the catalog of objects

Args:

• z_lim (float) – The maximum redshift of the objects to include in the catalog.

• transverse_distance_cut (Quantity) – The maximum impact parameter of the objects to include in the catalog.

• richness_cut (int) – The minimum number of members in any group/cluster returned.

• query_fields (list) – The fields to include in the catalog. If None, all fields are used.

Returns:

A table of objects within the given limits.