redback.simulate_transients.TransientPopulation

class redback.simulate_transients.TransientPopulation(parameters, metadata=None, light_curves=None)

Bases: object

Container class for transient populations with analysis capabilities

__init__(parameters, metadata=None, light_curves=None)

Initialize a TransientPopulation container

Parameters:

• parameters – DataFrame of transient parameters

• metadata – dict, Optional metadata about the population (rate, cosmology, etc.)

• light_curves – list, Optional list of light curve data for each transient

__call__(**kwargs)

Call self as a function.

Methods

__init__(parameters[, metadata, light_curves])	Initialize a TransientPopulation container
filter_by_redshift([z_min, z_max])	Filter population by redshift range
get_parameter_distribution(param_name[, bins])	Get distribution of any parameter
get_redshift_distribution([bins])	Get redshift distribution
load([filename])	Load population from file
save([filename, save_metadata])	Save population to file
summary_stats()	Get summary statistics for the population

Attributes

detected	Get subset of detected transients
detection_fraction	Calculate detection fraction
redshifts	Get redshift array
sky_positions	Get sky positions (RA, DEC) tuple

property detected

Get subset of detected transients

property detection_fraction

Calculate detection fraction

filter_by_redshift(z_min=None, z_max=None)

Filter population by redshift range

Parameters:

• z_min – Minimum redshift (default: no minimum)

• z_max – Maximum redshift (default: no maximum)

Returns:

New TransientPopulation with filtered parameters

get_parameter_distribution(param_name, bins=20)

Get distribution of any parameter

Parameters:

• param_name – Name of parameter

• bins – Number of bins

Returns:

tuple of (bin_edges, counts, bin_centers)

get_redshift_distribution(bins=20)

Get redshift distribution

Parameters:

bins – Number of bins for histogram

Returns:

tuple of (bin_edges, counts, bin_centers)

classmethod load(filename='population.csv')

Load population from file

Parameters:

filename – Input filename

Returns:

TransientPopulation object

property redshifts

Get redshift array

save(filename='population.csv', save_metadata=True)

Save population to file

Parameters:

• filename – Output filename

• save_metadata – Whether to save metadata as well

property sky_positions

Get sky positions (RA, DEC) tuple

summary_stats()

Get summary statistics for the population

Returns:

Dictionary of summary statistics