FaculaParameters#

class VSPEC.params.FaculaParameters(distribution: str, equillibrium_coverage: float, burn_in: astropy.units.Quantity, mean_radius: astropy.units.Quantity, logsigma_radius: float, depth: astropy.units.Quantity, mean_timescale: astropy.units.Quantity, logsigma_timescale: float, floor_teff_slope: astropy.units.Quantity, floor_teff_min_rad: astropy.units.Quantity, floor_teff_base_dteff: astropy.units.Quantity, wall_teff_slope: astropy.units.Quantity, wall_teff_intercept: astropy.units.Quantity)#

Bases: BaseParameters

Facula Parameters

Parameters:

  • distribution (str) – The distribution used to generate the faculae on the star. Currently only ‘iso’ is supported.

  • equillibrium_coverage (float) – The fraction of the star’s surface covered by the faculae at growth-decay equilibrium.

  • burn_in (astropy.units.Quantity) – The duration of the burn-in period, during which the facula coverage approaches equillibrium.

  • mean_radius (astropy.units.Quantity) – The mean radius of the faculae.

  • logsigma_radius (float) – The standard deviation of \(\log{r_{0}}\).

  • depth (astropy.units.Quantity) – The depth of the facula depression.

  • mean_timescale (astropy.units.Quantity) – The mean faculae lifetime.

  • logsigma_timescale (float) – The standard deviation of \(\log{\tau}\)

  • floor_teff_slope (astropy.units.Quantity) – The slope of the radius-Teff relationship

  • floor_teff_min_rad (astropy.units.Quantity) – The minimum radius at which the floor is visible. Otherwise the facula is a bright point – even near disk center.

  • floor_teff_base_dteff (astropy.units.Quantity) – The Teff of the floor at the minimum radius.

  • wall_teff_slope (astropy.units.Quantity) – The slope of the radius-Teff relationship

  • wall_teff_intercept (astropy.units.Quantity) – The Teff of the wall when \(R = 0\).

distribution#

The distribution used to generate the faculae on the star.

Type:

str

equillibrium_coverage#

The fraction of the star’s surface covered by the faculae at growth-decay equilibrium.

Type:

float

burn_in#

The duration of the burn-in period, during which the facula coverage approaches equillibrium.

Type:

astropy.units.Quantity

mean_radius#

The mean radius of the faculae.

Type:

astropy.units.Quantity

logsigma_radius#

The standard deviation of \(\log{r_{0}}\).

Type:

float

depth#

The depth of the facula depression.

Type:

astropy.units.Quantity

mean_timescale#

The mean faculae lifetime.

Type:

astropy.units.Quantity

logsigma_timescale#

The standard deviation of \(\log{\tau}\)

Type:

float

floor_teff_slope#

The slope of the radius-Teff relationship

Type:

astropy.units.Quantity

floor_teff_min_rad#

The minimum radius at which the floor is visible. Otherwise the facula is a bright point – even near disk center.

Type:

astropy.units.Quantity

floor_teff_base_dteff#

The Teff of the floor at the minimum radius.

Type:

astropy.units.Quantity

wall_teff_slope#

The slope of the radius-Teff relationship

Type:

astropy.units.Quantity

wall_teff_intercept#

The Teff of the wall when \(R = 0\).

Type:

astropy.units.Quantity

Methods Summary

from_preset(name)

Load a FaculaParameters instance from a preset file.

none()

Load a parameter set without faculae.

std()

Load a parameter preset with simple standard faculae for testing.

to_generator([grid_params, gridmaker, rng])

Construct a vspec_vsm.FaculaGenerator instance from the class.

Methods Documentation

classmethod from_preset(name)#

Load a FaculaParameters 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:

FaculaParameters

classmethod none()#

Load a parameter set without faculae.

classmethod std()#

Load a parameter preset with simple standard faculae for testing.

to_generator(grid_params: int | ~typing.Tuple[int, int] = (500, 1000), gridmaker: ~vspec_vsm.coordinate_grid.CoordinateGrid = None, rng: ~numpy.random._generator.Generator = Generator(PCG64) at 0x7FD432988C80) → FaculaGenerator#

Construct a vspec_vsm.FaculaGenerator instance from the class.

Parameters:

  • grid_params (Union[int,Tuple[int, int]]) – If tuple, the number of grid points in the latitude and longitude directions. If int, the number of total grid points for a sprial grid. Defaults to (vsm_config.NLAT, vsm_config.NLON).

  • gridmaker (CoordinateGrid) – An instance of vspec_vsm.CoordinateGrid to use for the grid. Defaults to None.

  • rng (np.random.Generator) – Random number generator. Defaults to np.random.default_rng().

Returns:

The vspec_vsm.FaculaGenerator instance.

Return type:

vspec_vsm.FaculaGenerator