InternalParameters#

class VSPEC.params.InternalParameters(header: Header, star: StarParameters, planet: PlanetParameters, system: SystemParameters, obs: ObservationParameters, psg: psgParameters, inst: InstrumentParameters, gcm: gcmParameters)#

Bases: BaseParameters

Class to store parameters for a VSPEC simulation.

Parameters:

header (Header) – The VSPEC simulation header.
star (StarParameters) – The parameters related to the star.
planet (PlanetParameters) – The parameters related to the planet.
system (SystemParameters) – The parameters related to the system.
obs (ObservationParameters) – The parameters related to the observation.
psg (psgParameters) – The PSG parameters.
inst (InstrumentParameters) – The instrument parameters.
gcm (gcmParameters) – The GCM parameters.

header#

The VSPEC simulation header.

Type:: Header

star#

The parameters related to the star.

Type:: StarParameters

planet#

The parameters related to the planet.

Type:: PlanetParameters

system#

The parameters related to the system.

Type:: SystemParameters

obs#

The parameters related to the observation.

Type:: ObservationParameters

psg#

The PSG parameters.

Type:: psgParameters

inst#

The instrument parameters.

Type:: InstrumentParameters

gcm#

The GCM parameters.

Type:: gcmParameters

Attributes Summary

`atmosphere`	Get the atmosphere model.
`flux_correction`	The flux correction for the stellar radius and distance.
`generator`	Get the generator model.
`geometry`	Get the geometry model.
`noise`	Get the noise model.
`planet_total_images`	The number of epochs to simulate for the planet model.
`star_total_images`	The number of epochs to simulate for the stellar model.
`surface`	Get the surface model.
`target`	Get the target model.
`telescope`	Get the telescope model.

Methods Summary

`from_dict`(d)	Create and InternalParameters instance from a dictionary.
`from_yaml`(path)	Create an InternalParameters instance from a YAML file.
`to_pyconfig`()	Write VSPEC parameters into a libpypsg PyConfig object.

Attributes Documentation

atmosphere#: Get the atmosphere model.

flux_correction#

The flux correction for the stellar radius and distance.

Returns:: Correction for the solid angle of the star.
Return type:: float

generator#: Get the generator model.

geometry#: Get the geometry model.

noise#: Get the noise model.

planet_total_images#

The number of epochs to simulate for the planet model.

Returns:: The total number of epochs to simulate the planet.
Return type:: int

star_total_images#

The number of epochs to simulate for the stellar model.

Returns:: The total number of epochs to simulate the star.
Return type:: int

surface#: Get the surface model.

target#: Get the target model.

telescope#: Get the telescope model.

Methods Documentation

classmethod from_dict(d: dict) → InternalParameters#

Create and InternalParameters instance from a dictionary.

Parameters:: d (dict) – The dictionary to construct the class from.
Returns:: An instance of InternalParameters.
Return type:: InternalParameters

classmethod from_yaml(path: Path) → InternalParameters#

Create an InternalParameters instance from a YAML file.

Parameters:: path (Path) – The path to the YAML file.
Returns:: An instance of the InternalParameters class.
Return type:: InternalParameters

to_pyconfig()#: Write VSPEC parameters into a libpypsg PyConfig object.