FlareParameters

class VSPEC.params.FlareParameters(dist_teff_mean: astropy.units.Quantity, dist_teff_sigma: astropy.units.Quantity, dist_fwhm_mean: astropy.units.Quantity, dist_fwhm_logsigma: float, alpha: float, beta: float, min_energy: astropy.units.Quantity, cluster_size: int)

Bases: BaseParameters

Class to store stellar flare parameters

Parameters:

• dist_teff_mean (astropy.units.Quantity) – The mean of the temperature distribution.

• dist_teff_sigma (astropy.units.Quantity) – The standard deviation of the temperature distribution.

• dist_fwhm_mean (astropy.units.Quantity) – The mean of the FWHM distribution.

• dist_fwhm_logsigma (float) – The standard deviation of the logorithm of the FWHM distribution in dex.

• alpha (float) – The slope of the log frequency - log energy relationship.

• beta (float) – The y-intercept of the log frequency - log energy relationship.

• min_energy (astropy.units.Quantity) – The minimum energy to consider. Set to np.inf*u.erg to disable flares.

• cluster_size (int) – The typical size of flare clusters.

dist_teff_mean

The mean of the temperature distribution.

Type:

astropy.units.Quantity

dist_teff_sigma

The standard deviation of the temperature distribution.

Type:

astropy.units.Quantity

dist_fwhm_mean

The mean of the FWHM distribution.

Type:

astropy.units.Quantity

dist_fwhm_logsigma

The standard deviation of the logorithm of the FWHM distribution in dex.

Type:

float

alpha

The slope of the log frequency - log energy relationship.

Type:

float

beta

The y-intercept of the log frequency - log energy relationship.

Type:

float

min_energy

The minimum energy to consider. Set to np.inf*u.erg to disable flares.

Type:

astropy.units.Quantity

cluster_size

The typical size of flare clusters.

Type:

int

Methods Summary

from_preset(name)	Load a FlareParameters configuration from a preset.
none()	A configuration with no flares.
std()	A standard flare configuration for testing.
to_generator([rng])	Create a vspec_vsm.FlareGenerator instance from the class instance.

Methods Documentation

classmethod from_preset(name)

Load a FlareParameters configuration from a preset.

Parameters:

name (str) – The name of the preset to load.

Returns:

The class instance loaded from a preset.

Return type:

FlareParameters

classmethod none()

A configuration with no flares.

classmethod std()

A standard flare configuration for testing.

to_generator(rng: ~numpy.random._generator.Generator = Generator(PCG64) at 0x7FD432988D60) → FlareGenerator

Create a vspec_vsm.FlareGenerator instance from the class instance.

Parameters:

rng (np.random.Generator, optional) – The random number generator to use. Defaults to np.random.default_rng().

Returns:

The vspec_vsm.FlareGenerator instance.

Return type:

vspec_vsm.FlareGenerator