Hyperparameters#

class gadfly.Hyperparameters(hyperparameters, name=None, magnitude=None)[source]#

Bases: list

Gaussian process hyperparameters for approximating the total stellar irradiance power spectrum.

Parameters

  • hyperparameters (list of dict) – List of dictionaries containing hyperparameters. Each dict has two entries. "hyperparameters" contains a dictionary with the keyword arguments that must be passed to the celerite2 SHOTerm constructor. "metadata" is a dictionary describing which hyperparameters were fixed in the fit.

  • name (str) – Label or name for the hyperparameter set.

  • magnitude (float) – Magnitude of the target in the observational band.

Methods Summary

append(object, /)

Append object to the end of the list.

clear(/)

Remove all items from list.

copy(/)

Return a shallow copy of the list.

count(value, /)

Return number of occurrences of value.

extend(iterable, /)

Extend list by appending elements from the iterable.

for_star(mass, radius, temperature, luminosity)

Applying scaling relations to the SOHO VIRGO/PMO6 total solar irradiance hyperparameters for given stellar properties.

from_soho_virgo([path, name])

Load the SOHO VIRGO/PMO6 total solar irradiance hyperparameters.

index(value[, start, stop])

Return first index of value.

insert(index, object, /)

Insert object before index.

pop([index])

Remove and return item at index (default last).

remove(value, /)

Remove first occurrence of value.

reverse(/)

Reverse IN PLACE.

sort(*[, key, reverse])

Sort the list in ascending order and return None.

Methods Documentation

append(object, /)#

Append object to the end of the list.

clear(/)#

Remove all items from list.

copy(/)#

Return a shallow copy of the list.

count(value, /)#

Return number of occurrences of value.

extend(iterable, /)#

Extend list by appending elements from the iterable.

classmethod for_star(mass, radius, temperature, luminosity, bandpass=None, name=None, quiet=False, magnitude=None)[source]#

Applying scaling relations to the SOHO VIRGO/PMO6 total solar irradiance hyperparameters for given stellar properties.

Parameters

  • mass (Quantity) – Stellar mass

  • radius (Quantity) – Stellar radius

  • temperature (Quantity) – Effective temperature

  • luminosity (Quantity) – Stellar luminosity

  • bandpass (str) – Name of the observing bandpass.

  • name (str) – Name for the star or set of hyperparameters

  • quiet (bool) – Turn off warning for invalid input parameters to scaling relations when quiet=True.

  • magnitude (float) – Magnitude of the target star in the observing band

classmethod from_soho_virgo(path=None, name='SOHO VIRGO/PMO6')[source]#

Load the SOHO VIRGO/PMO6 total solar irradiance hyperparameters.

See [1] for more information on SOHO VIRGO/PMO6.

Parameters

  • path (str or None) – Path to the solar hyperparameter JSON file. If None, loads the default gadfly solar hyperparameter list.

  • name (str) – Name of the hyperparameter set

References

1

VIRGO Data Products Archive

index(value, start=0, stop=sys.maxsize, /)#

Return first index of value.

Raises ValueError if the value is not present.

insert(index, object, /)#

Insert object before index.

pop(index=- 1, /)#

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value, /)#

Remove first occurrence of value.

Raises ValueError if the value is not present.

reverse(/)#

Reverse IN PLACE.

sort(*, key=None, reverse=False)#

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.