Public members¶

optical = False

FRB(dm: float | Quantity | None = None, **kwargs)

Initialise.

generate_x_frb()

assemble_row(**kwargs)

probabilistic_association(img, include_img_err: bool = True, ...)

Performs a customised PATH run on an image.

consolidate_candidate_tables(sort_by: str = 'separation', ...)

write_candidate_tables()

load_output_file()

classmethod default_params()

to_param_dict()

classmethod host_name(frb_name: str)

hg_name()

set_host(host_galaxy: TransientHostCandidate, ...)

classmethod default_host_params(frb_name: str, position=None, **)

get_host(name: str | None = None) → TransientHostCandidate

If self.host_galaxy is a string, checks for a host galaxy with that in the transient’s field and sets self.host_galaxy to that object. If self.host_galaxy is None, sets it to an empty TransientHostCandidate with the same z and z_err.

date_from_name()

dm_mw_ism_ne2001_baror(...) → Quantity

Derives the ISM component of the DM using the Bar-Or, Prochaska implementation of NE2001: https://github.com/FRBs/ne2001

dm_mw_ism_ne2001(...) → Quantity[Quantity]

dm_mw_ism_ymw16(...)

dm_mw_ism(ism_model: str = 'ne2001', ...)

dm_mw_ism_cum(...)

dm_mw_halo(model: str | frb.halos.models.ModifiedNFW = 'all', **)

dm_mw_halo_cum(rmax: float = 1.0, ...)

dm_exgal(ism_model: str = 'ne2001', halo_model: str = 'pz19')

dm_cosmic(z_max: float | None = None, **kwargs)

dm_halos_avg(z_max: float | None = None, **kwargs)

dm_host_from_tau(afg: Quantity | float, ...)

Implements an inverted form of Equation 9, equivalent to Equation 23, of Cordes et al 2022 (https://www.doi.org/10.3847/1538-4357/ac6873) Note that the quantity returned is in the HOST FRAME.

tau_mw(x_tau: float = 4.0)

Implements Equation 8 of Cordes et al 2022 (https://www.doi.org/10.3847/1538-4357/ac6873)

z_from_dm(dm_host: Quantity = 0, **kwargs)

foreground_accounting(rmax=1.0, ...)

host_probability_unseen(img: image.ImagingImage, ...)

Uses the Marnoch+2023 method to estimate the probability that this FRB’s host galaxy is unseen in the given image.

read_p_z_dm(path: str | None = None)

classmethod from_dict(dictionary: dict, **kwargs) → FRB

Construct an Object or appropriate child class (FRB, Galaxy…) from a passed dict.

deprojected_host_offset()

update_output_file()

update_param_file(param: str)