InternalParameters#

class VSPEC.params.read.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

property atmosphere#: Get the atmosphere model.

property flux_correction: float#

The flux correction for the stellar radius and distance.

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

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

property generator#: Get the generator model.

property geometry#: Get the geometry model.

property noise#: Get the noise model.

property planet_total_images: int#

The number of epochs to simulate for the planet model.

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

property star_total_images: int#

The number of epochs to simulate for the stellar model.

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

property surface#: Get the surface model.

property target#: Get the target model.

property telescope#: Get the telescope model.

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