GranulationParameters

class VSPEC.params.GranulationParameters(mean: float, amp: float, period: astropy.units.Quantity, dteff: astropy.units.Quantity)

Bases: BaseParameters

Granulation Parameters

Parameters:

• mean (float) – The mean coverage of low-teff granulation.

• amp (float) – The amplitude of granulation oscillations.

• period (astropy.units.Quantity) – The period of granulation oscillations.

• dteff (astropy.units.Quantity) – The difference between the quiet photosphere and the low-teff granulation region.

mean

The mean coverage of low-teff granulation.

Type:

float

amp

The amplitude of granulation oscillations.

Type:

float

period

The period of granulation oscillations.

Type:

astropy.units.Quantity

dteff

The difference between the quiet photosphere and the low-teff granulation region.

Type:

astropy.units.Quantity

Methods Summary

from_preset(name)	Load a BaseParameters instance from a preset file.
none()
std()
to_generator([seed])	Create a vspec_vsm.Granulation instance from the class instance.
validate()

Methods Documentation

classmethod from_preset(name)

Load a BaseParameters instance from a preset file.

Parameters:

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

Returns:

The class instance loaded from a preset.

Return type:

BaseParameters

classmethod none()

classmethod std()

to_generator(seed: int = 0) → Granulation

Create a vspec_vsm.Granulation instance from the class instance.

Parameters:

seed (int, optional) – The seed for the random number generator. Defaults to 0.

Returns:

The vspec_vsm.Granulation instance.

Return type:

vspec_vsm.Granulation

validate()