cosmogrb.sampler package

Submodules

cosmogrb.sampler.background module

class cosmogrb.sampler.background.Background(tstart, tstop, average_rate=1000, background_spectrum_template=None)

Bases: cosmogrb.sampler.sampler.Sampler

sample_channel(size=None)

Sample the background template. Other options do not exist yet

Parameters:size – Returns: Return type:

sample_times()

sample the background times

Returns: Return type:

class cosmogrb.sampler.background.BackgroundSpectrumTemplate(counts, start_at_one=False)

Bases: object

classmethod from_file(file_name, start_at_one=False)

Read the counts from a HDF5 file that has a dataset in its top directory called counts

Parameters:

• cls –
• file_name –

Returns:

Return type:

sample_channel(size=None)

Sample from the background template

Parameters:size – Returns: Return type:

cosmogrb.sampler.background.background_poisson_generator

Parameters:

• tstop –
• rate –

Returns:

Return type:

Type:

param tstart

cosmogrb.sampler.constant_cpl module

class cosmogrb.sampler.constant_cpl.ConstantCPL(peak_flux=1e-06, ep=300.0, alpha=-1.0, emin=10.0, emax=10000.0, response=None)

Bases: cosmogrb.sampler.source_function.SourceFunction

energy_integrated_evolution(time)

return the integral over energy at a given time via Simpson’s rule

Parameters:time – the time of the pulse Returns: Return type:

evolution(energy, time)

must return a matrix (time.shape, energy.shape)

sample_energy(times)

sample_events(tstart, tstop, fmax)

time_integrated_spectrum(energy, tmin, tmax)

Parameters:

• energy –
• t1 –
• t2 –

Returns:

Return type:

cosmogrb.sampler.cpl_source module

class cosmogrb.sampler.cpl_source.CPLSourceFunction(peak_flux=1e-06, ep_start=300.0, ep_tau=1.0, alpha=-1.0, trise=1.0, tdecay=2, emin=10.0, emax=10000.0, response=None)

Bases: cosmogrb.sampler.source_function.SourceFunction

energy_integrated_evolution(time)

return the integral over energy at a given time via Simpson’s rule

Parameters:time – the time of the pulse Returns: Return type:

evolution(energy, time)

must return a matrix (time.shape, energy.shape)

sample_energy(times)

sample_events(tstart, tstop, fmax)

time_integrated_spectrum(energy, tmin, tmax)

Parameters:

• energy –
• t1 –
• t2 –

Returns:

Return type:

cosmogrb.sampler.sampler module

class cosmogrb.sampler.sampler.Sampler(tstart, tstop)

Bases: object

sample_channel(size=None)

sample_times()

times

tstart

tstop

cosmogrb.sampler.source module

class cosmogrb.sampler.source.Source(tstart, tstop, source_function, z, use_plaw_sample=False)

Bases: cosmogrb.sampler.sampler.Sampler

display_energy_dependent_light_curve(time, energy, ax=None, cmap='viridis', **kwargs)

FIXME! briefly describe function

Parameters:

• time –
• energy –
• ax –
• cmap –

Returns:

Return type:

display_energy_integrated_light_curve(time, ax=None, **kwargs)

FIXME! briefly describe function

Parameters:

• time –
• ax –

Returns:

Return type:

sample_channel(photons, response)

sample_photons(times)

sample_times()

sample the evolution function INTEGRATED over energy

Returns: Return type:

set_response(response)

called if there is no response upon creation

z

Module contents

class cosmogrb.sampler.SourceFunction(emin=10.0, emax=10000.0, index=None, response=None)

Bases: object

display_energy_dependent_light_curve(time, energy, ax=None, cmap='viridis', **kwargs)

plot the latent light curve integrated over energy

Parameters:

• time –
• ax –

Returns:

Return type:

display_energy_integrated_light_curve(time, ax=None, **kwargs)

plot the latent light curve integrated over energy

Parameters:

• time –
• ax –

Returns:

Return type:

emax

emin

energy_integrated_evolution(time)

return the integral over energy at a given time via Simpson’s rule

Parameters:time – the time of the pulse Returns: Return type:

evolution(energy, time)

must return a matrix (time.shape, energy.shape)

index

response

sample_energy(times)

sample_events(tstart, tstop, fmax)

set_response(response)

set_source(source)

classmethod time_integrated_spectrum(energy, t1, t2)

Parameters:

• energy –
• t1 –
• t2 –

Returns:

Return type:

class cosmogrb.sampler.Source(tstart, tstop, source_function, z, use_plaw_sample=False)

Bases: cosmogrb.sampler.sampler.Sampler

display_energy_dependent_light_curve(time, energy, ax=None, cmap='viridis', **kwargs)

FIXME! briefly describe function

Parameters:

• time –
• energy –
• ax –
• cmap –

Returns:

Return type:

display_energy_integrated_light_curve(time, ax=None, **kwargs)

FIXME! briefly describe function

Parameters:

• time –
• ax –

Returns:

Return type:

sample_channel(photons, response)

sample_photons(times)

sample_times()

sample the evolution function INTEGRATED over energy

Returns: Return type:

set_response(response)

called if there is no response upon creation

z

class cosmogrb.sampler.Background(tstart, tstop, average_rate=1000, background_spectrum_template=None)

Bases: cosmogrb.sampler.sampler.Sampler

sample_channel(size=None)

Sample the background template. Other options do not exist yet

Parameters:size – Returns: Return type:

sample_times()

sample the background times

Returns: Return type:

class cosmogrb.sampler.CPLSourceFunction(peak_flux=1e-06, ep_start=300.0, ep_tau=1.0, alpha=-1.0, trise=1.0, tdecay=2, emin=10.0, emax=10000.0, response=None)

Bases: cosmogrb.sampler.source_function.SourceFunction

energy_integrated_evolution(time)

return the integral over energy at a given time via Simpson’s rule

Parameters:time – the time of the pulse Returns: Return type:

evolution(energy, time)

must return a matrix (time.shape, energy.shape)

sample_energy(times)

sample_events(tstart, tstop, fmax)

time_integrated_spectrum(energy, tmin, tmax)

Parameters:

• energy –
• t1 –
• t2 –

Returns:

Return type: