Granulation¶

class vspec_vsm.Granulation(mean_coverage: float, amplitude: float, period: astropy.units.Quantity, dteff: astropy.units.Quantity, seed: int = 0)¶

Class to contain the granulation model

Parameters:

mean_coverage (float) – The mean surface coverage of the low-Teff regions.
amplitude (float) – The amplitude of the low-Teff coverage oscillations.
period (astropy.units.Quantity) – The period of low-Teff coverage oscillations.
dteff (astropy.units.Quantity) – The temperature difference between the nominal photosphere and the low-Teff region.

params¶

Parameters for the gaussian process

dteff¶

The temperature difference between the nominal photosphere and the low-Teff region.

Methods

`get_coverage`(time)	Get low-Teff region coverage at each point in time.
`off`([seed])	An instance that does not generate any granulation

Methods Summary

`get_coverage`(time)	Get low-Teff region coverage at each point in time.
`off`([seed])	An instance that does not generate any granulation

Methods Documentation

Get low-Teff region coverage at each point in time.

Parameters:: time (astropy.units.Quantity) – The time axis to generate coverages of.
Returns:: The coverage corresponding to each point in time.
Return type:: np.ndarray

classmethod off(seed: int = 0)¶

An instance that does not generate any granulation