Photometry

class rocky_worlds_data_challenge.Photometry(time: ArrayLike, raw_flux: ArrayLike, raw_flux_err: ArrayLike, astro_model: ArrayLike, noise_model: ArrayLike, full_model: ArrayLike, **extra_time_series: ArrayLike)[source]

Bases: object

Reduced light-curve arrays for one target.

All required and optional time-series arrays must share the same shape. Extra keyword arguments are preserved as additional HDF5 datasets when a submission archive is written.

Variables:
  • time (array-like) – Time values for the reduced light curve.

  • raw_flux (array-like) – Reduced flux values before applying the submitted model correction.

  • raw_flux_err (array-like) – Uncertainties on raw_flux.

  • astro_model (array-like) – Astrophysical model evaluated at each time.

  • noise_model (array-like) – Noise or systematics model evaluated at each time.

  • full_model (array-like) – Combined astrophysical and noise model evaluated at each time.

  • extra_time_series (array-like) – Optional additional arrays supplied as keyword arguments. These are attached as attributes and written to the photometry HDF5 group.

Store required and optional light-curve time series.

Parameters:
  • time (array-like) – Time values for the reduced light curve.

  • raw_flux (array-like) – Reduced flux values before applying the submitted model correction.

  • raw_flux_err (array-like) – Uncertainties on raw_flux.

  • astro_model (array-like) – Astrophysical model evaluated at each time.

  • noise_model (array-like) – Noise or systematics model evaluated at each time.

  • full_model (array-like) – Combined astrophysical and noise model evaluated at each time.

  • **extra_time_series (array-like) – Optional additional arrays to preserve in the photometry HDF5 file. Each array must have the same shape as the required arrays.

Attributes Summary

astro_model

Astrophysical model evaluated at each time.

full_model

Combined astrophysical and noise model evaluated at each time.

noise_model

Noise or systematics model evaluated at each time.

raw_flux

Reduced flux values before applying the submitted model correction.

raw_flux_err

Uncertainties on raw_flux.

required_fields

time

Time values for the reduced light curve.

Methods Summary

load([filepath, h5_filepath])

Load one photometry dataset from a submission ZIP archive.

validate()

Require every stored time-series array to have the same shape.

Attributes Documentation

astro_model: ArrayLike

Astrophysical model evaluated at each time.

full_model: ArrayLike

Combined astrophysical and noise model evaluated at each time.

noise_model: ArrayLike

Noise or systematics model evaluated at each time.

raw_flux: ArrayLike

Reduced flux values before applying the submitted model correction.

raw_flux_err: ArrayLike

Uncertainties on raw_flux.

required_fields
time: ArrayLike

Time values for the reduced light curve.

Methods Documentation

classmethod load(filepath='submission.zip', h5_filepath='lc_LHS1140b.h5')[source]

Load one photometry dataset from a submission ZIP archive.

Parameters:
  • filepath (path-like, optional) – Path to the submission ZIP archive.

  • h5_filepath (str, optional) – Name of the photometry HDF5 file inside filepath.

Returns:

Photometry object populated from the HDF5 file.

Return type:

Photometry

validate()[source]

Require every stored time-series array to have the same shape.

Raises:

ValueError – If any stored light-curve array has a different shape.