StellarFlare

class vspec_vsm.StellarFlare(fwhm: astropy.units.Quantity, energy: astropy.units.Quantity, lat: astropy.units.Quantity, lon: astropy.units.Quantity, Teff: astropy.units.Quantity, tpeak: astropy.units.Quantity)

Bases: object

Class to store and control stellar flare information

Parameters:
fwhm

Full-width-half-maximum of the flare

Type:

astropy.units.Quantity

energy

Time-integrated bolometric energy

Type:

astropy.units.Quantity

lat

Latitude of flare on star

Type:

astropy.units.Quantity

lon

Longitude of flare on star

Type:

astropy.units.Quantity

Teff

Blackbody temperature

Type:

astropy.units.Quantity

tpeak

Time of the flare peak

Type:

astropy.units.Quantity

Notes

Flare lightcurve profiles are calculated using the xoflares package [1]. In order to keep the multiwavenlength model self-consistent, we model a flare as a constant temperature surface that emits blackbody radiation. The lightcurve is created as the surface area grows, then decays.

References

Methods

areacurve(time)

Compute the flare area as a function of time

calc_peak_area()

Calculate the flare area at its peak

get_timearea(time)

Calcualte the integrated time*area of the flare.

Methods Summary

areacurve(time)

Compute the flare area as a function of time

calc_peak_area()

Calculate the flare area at its peak

get_timearea(time)

Calcualte the integrated time*area of the flare.

Methods Documentation

areacurve(time: astropy.units.Quantity)

Compute the flare area as a function of time

Parameters:

time (astropy.units.Quantity) – The times at which to sample the area

Returns:

Area at each time

Return type:

astropy.units.Quantity

calc_peak_area() astropy.units.Quantity

Calculate the flare area at its peak

Returns:

Peak flare area

Return type:

astropy.units.Quantity

get_timearea(time: astropy.units.Quantity)

Calcualte the integrated time*area of the flare.

Parameters:

time (astropy.units.Quantity) – the times at which to sample the area.

Returns:

The integrated time-area of the flare.

Return type:

astropy.units.Quantity