astro_prost.helpers

Classes

GalaxyCatalog

Short summary.

Transient

Short summary.

PriorzObservedTransients

Short summary.

SnRateAbsmag

Short summary.

Functions

ps1cone(ra, dec, radius[, table, release, format, ...])

Short summary.

ps1search([table, release, format, columns, baseurl, ...])

Short summary.

build_glade_candidates(transient_name, transient_pos, ...)

Short summary.

build_decals_candidates(transient_name, transient_pos, ...)

Short summary.

build_panstarrs_candidates(transient_name, ...[, ...])

Short summary.

calc_dlr(transient_pos, galaxies_pos, a, a_std, ...[, ...])

Short summary.

find_panstarrs_shreds(objids, ra_allgals, dec_allgals, ...)

Short summary.

Module Contents

class GalaxyCatalog(name, data=None, n_samples=1000)[source]

Short summary.

Parameters:
  • name (type) – Description of parameter name.

  • data (type) – Description of parameter data.

  • n_samples (type) – Description of parameter n_samples.

name[source]
data[source]
n_samples[source]
name[source]
data[source]
n_samples[source]
get_candidates(transient, cosmo, timequery=False, verbose=False)[source]

Short summary.

Parameters:
  • transient (type) – Description of parameter transient.

  • cosmo (type) – Description of parameter cosmo.

  • timequery (type) – Description of parameter timequery.

  • verbose (type) – Description of parameter verbose.

Returns:

Description of returned object.

Return type:

type

class Transient(name, position, redshift=np.nan, spec_class='', phot_class='', n_samples=1000)[source]

Short summary.

Parameters:
  • name (type) – Description of parameter name.

  • position (type) – Description of parameter position.

  • redshift (type) – Description of parameter redshift.

  • spec_class (type) – Description of parameter spec_class.

  • phot_class (type) – Description of parameter phot_class.

  • n_samples (type) – Description of parameter n_samples.

best_host[source]

Description of attribute best_host.

Type:

type

second_best_host[source]

Description of attribute second_best_host.

Type:

type

redshift_std

Description of attribute redshift_std.

Type:

type

gen_z_samples[source]

Description of attribute gen_z_samples.

Type:

type

priors[source]

Description of attribute priors.

Type:

type

likes[source]

Description of attribute likes.

Type:

type

name[source]
position[source]
redshift[source]
spec_class[source]
phot_class[source]
n_samples[source]
name[source]
position[source]
redshift[source]
spec_class[source]
phot_class[source]
n_samples[source]
best_host[source]
second_best_host[source]
priors[source]
likes[source]
__str__()[source]
get_prior(type)[source]

Short summary.

Parameters:

type (type) – Description of parameter type.

Returns:

Description of returned object.

Return type:

type

get_likelihood(type)[source]

Short summary.

Parameters:

type (type) – Description of parameter type.

Returns:

Description of returned object.

Return type:

type

set_likelihood(type, func)[source]

Short summary.

Parameters:
  • type (type) – Description of parameter type.

  • func (type) – Description of parameter func.

Returns:

Description of returned object.

Return type:

type

set_prior(type, func)[source]

Short summary.

Parameters:
  • type (type) – Description of parameter type.

  • func (type) – Description of parameter func.

Returns:

Description of returned object.

Return type:

type

gen_z_samples(ret=False, n_samples=None)[source]

Short summary.

Parameters:
  • ret (type) – Description of parameter ret.

  • n_samples (type) – Description of parameter n_samples.

Returns:

Description of returned object.

Return type:

type

calc_prior_redshift(z_best_samples, reduce='mean')[source]

Short summary.

Parameters:
  • z_best_samples (type) – Description of parameter z_best_samples.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

calc_prior_offset(fractional_offset_samples, reduce='mean')[source]

Short summary.

Parameters:
  • fractional_offset_samples (type) – Description of parameter fractional_offset_samples.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

calc_prior_absmag(absmag_samples, reduce='mean')[source]

Short summary.

Parameters:
  • absmag_samples (type) – Description of parameter absmag_samples.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

calc_like_redshift(z_best_mean, z_best_std, reduce='mean')[source]

Short summary.

Parameters:
  • z_best_mean (type) – Description of parameter z_best_mean.

  • z_best_std (type) – Description of parameter z_best_std.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

calc_like_offset(fractional_offset_samples, reduce='mean')[source]

Short summary.

Parameters:
  • fractional_offset_samples (type) – Description of parameter fractional_offset_samples.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

calc_like_absmag(absmag_samples, reduce='mean')[source]

Short summary.

Parameters:
  • absmag_samples (type) – Description of parameter absmag_samples.

  • reduce (type) – Description of parameter reduce.

Returns:

Description of returned object.

Return type:

type

associate(galaxy_catalog, cosmo, verbose=False)[source]

Short summary.

Parameters:
  • galaxy_catalog (type) – Description of parameter galaxy_catalog.

  • cosmo (type) – Description of parameter cosmo.

  • verbose (type) – Description of parameter verbose.

Returns:

Description of returned object.

Return type:

type

probability_of_unobserved_host(search_rad, cosmo, m_lim=30, verbose=False, n_samples=1000)[source]

Short summary.

Parameters:
  • search_rad (type) – Description of parameter search_rad.

  • m_lim (type) – Description of parameter m_lim.

  • verbose (type) – Description of parameter verbose.

  • n_samples (type) – Description of parameter n_samples.

  • cosmo (type) – Description of parameter cosmo.

Returns:

Description of returned object.

Return type:

type

probability_host_outside_cone(cosmo, cutout_rad=60, verbose=False, n_samples=1000)[source]

Short summary.

Parameters:
  • cutout_rad (type) – Description of parameter cutout_rad.

  • verbose (type) – Description of parameter verbose.

  • n_samples (type) – Description of parameter n_samples.

  • cosmo (type) – Description of parameter cosmo.

Returns:

Description of returned object.

Return type:

type

class PriorzObservedTransients(cosmo, z_min=0, z_max=1, n_bins=100, mag_cutoff=22, absmag_mean=-19, absmag_min=-24, absmag_max=-17, r_sn=1e-05, t_obs=1.0, **kwargs)[source]

Bases: scipy.stats.rv_continuous

Short summary.

Parameters:
  • z_min (type) – Description of parameter z_min.

  • z_max (type) – Description of parameter z_max.

  • n_bins (type) – Description of parameter n_bins.

  • mag_cutoff (type) – Description of parameter mag_cutoff.

  • absmag_mean (type) – Description of parameter absmag_mean.

  • absmag_min (type) – Description of parameter absmag_min.

  • absmag_max (type) – Description of parameter absmag_max.

  • r_sn (type) – Description of parameter r_sn.

  • t_obs (type) – Description of parameter t_obs.

  • **kwargs (type) – Description of parameter **kwargs.

cosmo[source]

Description of attribute cosmo.

Type:

type

_generate_distribution[source]

Description of attribute _generate_distribution.

Type:

type

z_min[source]
z_max[source]
n_bins[source]
mag_cutoff[source]
absmag_mean[source]
absmag_min[source]
absmag_max[source]
r_sn[source]
t_obs[source]
z_min[source]
z_max[source]
n_bins[source]
mag_cutoff[source]
absmag_mean[source]
absmag_min[source]
absmag_max[source]
r_sn[source]
t_obs[source]
cosmo[source]
_generate_distribution()[source]

Short summary.

Returns:

Description of returned object.

Return type:

type

pdf(z)[source]

Return the PDF (KDE) based on observed redshifts. Handles 1D and 2D arrays.

rvs(size=None, random_state=None)[source]

Short summary.

Parameters:
  • size (type) – Description of parameter size.

  • random_state (type) – Description of parameter random_state.

Returns:

Description of returned object.

Return type:

type

plot()[source]

Short summary.

Returns:

Description of returned object.

Return type:

type

class SnRateAbsmag(a, b, **kwargs)[source]

Bases: scipy.stats.rv_continuous

Short summary.

Parameters:
  • a (type) – Description of parameter a.

  • b (type) – Description of parameter b.

  • **kwargs (type) – Description of parameter **kwargs.

normalization[source]

Description of attribute normalization.

Type:

type

_calculate_normalization[source]

Description of attribute _calculate_normalization.

Type:

type

normalization[source]
_calculate_normalization(a, b)[source]

Short summary.

Parameters:
  • a (type) – Description of parameter a.

  • b (type) – Description of parameter b.

Returns:

Description of returned object.

Return type:

type

_unnormalized_pdf(abs_mag_samples)[source]

Short summary.

Parameters:

abs_mag_samples (type) – Description of parameter abs_mag_samples.

Returns:

Description of returned object.

Return type:

type

_pdf(m_abs_samples)[source]

Short summary.

Parameters:

m_abs_samples (type) – Description of parameter m_abs_samples.

Returns:

Description of returned object.

Return type:

type

ps1cone(ra, dec, radius, table='stack', release='dr2', format='csv', columns=None, baseurl='https://catalogs.mast.stsci.edu/api/v0.1/panstarrs', verbose=False, **kw)[source]

Short summary.

Parameters:
  • ra (type) – Description of parameter ra.

  • dec (type) – Description of parameter dec.

  • radius (type) – Description of parameter radius.

  • table (type) – Description of parameter table.

  • release (type) – Description of parameter release.

  • format (type) – Description of parameter format.

  • columns (type) – Description of parameter columns.

  • baseurl (type) – Description of parameter baseurl.

  • verbose (type) – Description of parameter verbose.

  • **kw (type) – Description of parameter **kw.

Returns:

Description of returned object.

Return type:

type

ps1search(table='mean', release='dr1', format='csv', columns=None, baseurl='https://catalogs.mast.stsci.edu/api/v0.1/panstarrs', verbose=False, **kw)[source]

Short summary.

Parameters:
  • table (type) – Description of parameter table.

  • release (type) – Description of parameter release.

  • format (type) – Description of parameter format.

  • columns (type) – Description of parameter columns.

  • baseurl (type) – Description of parameter baseurl.

  • verbose (type) – Description of parameter verbose.

  • **kw (type) – Description of parameter **kw.

Returns:

Description of returned object.

Return type:

type

build_glade_candidates(transient_name, transient_pos, glade_catalog, search_rad, cosmo, n_samples=1000, verbose=False)[source]

Short summary.

Parameters:
  • transient_name (type) – Description of parameter transient_name.

  • transient_pos (type) – Description of parameter transient_pos.

  • glade_catalog (type) – Description of parameter glade_catalog.

  • search_rad (type) – Description of parameter search_rad.

  • cosmo (type) – Description of parameter cosmo.

  • n_samples (type) – Description of parameter n_samples.

  • verbose (type) – Description of parameter verbose.

Returns:

Description of returned object.

Return type:

type

build_decals_candidates(transient_name, transient_pos, search_rad, cosmo, n_samples=1000, verbose=False)[source]

Short summary.

Parameters:
  • transient_name (type) – Description of parameter transient_name.

  • transient_pos (type) – Description of parameter transient_pos.

  • search_rad (type) – Description of parameter search_rad.

  • cosmo (type) – Description of parameter cosmo.

  • n_samples (type) – Description of parameter n_samples.

  • verbose (type) – Description of parameter verbose.

Returns:

Description of returned object.

Return type:

type

build_panstarrs_candidates(transient_name, transient_pos, search_rad, cosmo, n_samples=1000, verbose=False, glade_catalog=None)[source]

Short summary.

Parameters:
  • transient_name (type) – Description of parameter transient_name.

  • transient_pos (type) – Description of parameter transient_pos.

  • search_rad (type) – Description of parameter search_rad.

  • cosmo (type) – Description of parameter cosmo.

  • n_samples (type) – Description of parameter n_samples.

  • verbose (type) – Description of parameter verbose.

  • glade_catalog (type) – Description of parameter glade_catalog.

Returns:

Description of returned object.

Return type:

type

calc_dlr(transient_pos, galaxies_pos, a, a_std, a_over_b, a_over_b_std, phi, phi_std, n_samples=1000)[source]

Short summary.

Parameters:
  • transient_pos (type) – Description of parameter transient_pos.

  • galaxies_pos (type) – Description of parameter galaxies_pos.

  • a (type) – Description of parameter a.

  • a_std (type) – Description of parameter a_std.

  • a_over_b (type) – Description of parameter a_over_b.

  • a_over_b_std (type) – Description of parameter a_over_b_std.

  • phi (type) – Description of parameter phi.

  • phi_std (type) – Description of parameter phi_std.

  • n_samples (type) – Description of parameter n_samples.

Returns:

Description of returned object.

Return type:

type

find_panstarrs_shreds(objids, ra_allgals, dec_allgals, size, size_std, a_over_b, a_over_b_std, phi, phi_std, appmag, verbose=False)[source]

Short summary.

Parameters:
  • objids (type) – Description of parameter objids.

  • ra_allgals (type) – Description of parameter ra_allgals.

  • dec_allgals (type) – Description of parameter dec_allgals.

  • size (type) – Description of parameter size.

  • size_std (type) – Description of parameter size_std.

  • a_over_b (type) – Description of parameter a_over_b.

  • a_over_b_std (type) – Description of parameter a_over_b_std.

  • phi (type) – Description of parameter phi.

  • phi_std (type) – Description of parameter phi_std.

  • appmag (type) – Description of parameter appmag.

  • verbose (type) – Description of parameter verbose.

Returns:

Description of returned object.

Return type:

type