StarParameters#

class VSPEC.params.StarParameters(psg_star_template: str, teff: astropy.units.Quantity, mass: astropy.units.Quantity, radius: astropy.units.Quantity, period: astropy.units.Quantity, misalignment: astropy.units.Quantity, misalignment_dir: astropy.units.Quantity, ld: LimbDarkeningParameters, spots: SpotParameters, faculae: FaculaParameters, flares: FlareParameters, granulation: GranulationParameters, grid_params: tuple)#

Bases: BaseParameters

Parameters describing the VSPEC stellar model.

Parameters:

psg_star_template (str) – The template used for the stellar model.
teff (astropy.units.Quantity) – The effective temperature of the star.
mass (astropy.units.Quantity) – The mass of the star.
radius (astropy.units.Quantity) – The radius of the star.
period (astropy.units.Quantity) – The rotational period of the star.
misalignment (astropy.units.Quantity) – The misalignment between the stellar rotation axis and the orbital axis.
misalignment_dir (astropy.units.Quantity) – The direction of stellar rotation axis misalignment.
ld (LimbDarkeningParameters) – The limb darkening parameters of the star.
spots (SpotParameters) – The parameters of the spots on the star.
faculae (FaculaParameters) – The parameters of the faculae on the star.
flares (FlareParameters) – The parameters of the flares on the star.
granulation (GranulationParameters) – The parameters of the granulation on the star.
grid_params (tuple or int) – The parameters for the grid. If tuple, we use a rectangular grid (Nlat, Nlon). If int, we use a spiral grid with grid_params points evenly spaced.
spectral_grid (str) – The grid of stellar spectra to use. Currently only default and bb are supported. Use default in general, but if you want efficiency and only care about the absolute spectrum of the planet, bb is recommended as it can cut the runtime in half.

psg_star_template#

The template used for the stellar model.

Type:: str

teff#

The effective temperature of the star.

Type:: astropy.units.Quantity

mass#

The mass of the star.

Type:: astropy.units.Quantity

radius#

The radius of the star.

Type:: astropy.units.Quantity

period#

The rotational period of the star.

Type:: astropy.units.Quantity

misalignment#

The misalignment between the stellar rotation axis and the orbital axis.

Type:: astropy.units.Quantity

misalignment_dir#

The direction of stellar rotation axis misalignment.

Type:: astropy.units.Quantity

ld#

The limb darkening parameters of the star.

Type:: LimbDarkeningParameters

spots#

The parameters of the spots on the star.

Type:: SpotParameters

faculae#

The parameters of the faculae on the star.

Type:: FaculaParameters

flares#

The parameters of the flares on the star.

Type:: FlareParameters

granulation#

The parameters of the granulation on the star.

Type:: GranulationParameters

grid_params#

The parameters for the grid.

Type:: tuple or int

spectral_grid#

The grid of stellar spectra to use.

Type:: str

Methods Summary

`flaring_proxima`()	A Proxima Centauri-like star that flares.
`from_dict`(d)	Construct a `StarParameters` object from a dictionary.
`from_preset`(name)	Load a `BaseParameters` instance from a preset file.
`proxima`()	A Proxima Centauri-like star that has spots and flares.
`spotted_proxima`()	A Proxima Centauri-like star that has spots.
`static_proxima`()	A Proxima Centauri-like star that has no variability.
`to_star`([rng, seed])	Create a vspec_vsm.Star instance from the class instance.

Methods Documentation

classmethod flaring_proxima()#: A Proxima Centauri-like star that flares.

classmethod from_dict(d: dict)#

Construct a StarParameters object from a dictionary.

Parameters:: d (dict) – The dictionary representing the StarParameters object.

Notes

Available presets include static_proxima, spotted_proxima, flaring_proxima, and proxima.

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 proxima()#: A Proxima Centauri-like star that has spots and flares.

classmethod spotted_proxima()#: A Proxima Centauri-like star that has spots.

classmethod static_proxima()#: A Proxima Centauri-like star that has no variability.

to_star(rng: ~numpy.random._generator.Generator = Generator(PCG64) at 0x7FD432988E40, seed: int = 0) → Star#

Create a vspec_vsm.Star instance from the class instance.

Parameters:

rng (np.random.Generator, optional) – The random number generator to use. Defaults to np.random.default_rng().
seed (int, optional) – The seed for the random number generator. Defaults to 0.