Ephemeris

class lcviz.plugins.ephemeris.ephemeris.Ephemeris(*args, **kwargs)

Bases: PluginTemplateMixin, DatasetSelectMixin

See the Ephemeris Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• component (EditableSelectPluginComponent): Label of the component corresponding to the active ephemeris.

• t0 : float Zeropoint of the ephemeris.

• period : float Period of the ephemeris, defined at t0.

• dpdt : float First derivative of the period of the ephemeris.

• wrap_at : float Phase at which to wrap (phased data will encompass the range 1-wrap_at to wrap_at).

• ephemeris()

• ephemerides()

• update_ephemeris()

• create_phase_viewer()

• add_component()

• rename_component()

• times_to_phases()

• phases_to_times()

• get_data()

• dataset (DatasetSelect): Dataset to use for determining the period.

• method (SelectPluginComponent): Method/algorithm to determine the period.

• query_for_ephemeris() Query the NASA Exoplanet Archive’s Planetary System Composite Parameters table for the planet-hosting star identified by the observation’s header key “OBJECT”, or if that fails, by the observation’s header keys for RA and Dec.

• query_result (SelectPluginComponent): The name of a planet from a NASA Exoplanet Archive query, used for adopting literature values for the orbital period and mid-transit time.

• create_ephemeris_from_query() Create an ephemeris component with the period and epoch from the planet selected from the NASA Exoplanet Archive query in query_result.

Public constructor

Attributes Summary

component_edit_value	A trait for unicode strings.
component_items	An instance of a Python list.
component_mode	A trait for unicode strings.
component_selected	A trait for unicode strings.
default_phase_viewer
dpdt	Mixin to handle empty floating point field.
dpdt_step	A float trait.
ephemerides
ephemeris
method_err	A trait for unicode strings.
method_items	An instance of a Python list.
method_selected	A trait for unicode strings.
method_spinner	A boolean (True, False) trait.
nasa_exoplanet_archive
period	Mixin to handle empty floating point field.
period_at_max_power	A float trait.
period_from_catalog	Mixin to handle empty floating point field.
period_step	A float trait.
phase_comp_lbl
phase_viewer_exists	A boolean (True, False) trait.
query_dec	Mixin to handle empty floating point field.
query_name	A trait for unicode strings.
query_ra	Mixin to handle empty floating point field.
query_radius	Mixin to handle empty floating point field.
query_result_items	An instance of a Python list.
query_result_selected	A trait for unicode strings.
query_spinner	A boolean (True, False) trait.
ra_dec_step	A float trait.
reference_time
t0	Mixin to handle empty floating point field.
t0_from_catalog	Mixin to handle empty floating point field.
t0_step	A float trait.
template_file
user_api
wrap_at	Mixin to handle empty floating point field.

Methods Summary

add_component(lbl[, set_as_selected])
adopt_period_at_max_power()
create_ephemeris_from_query(*args)
create_phase_viewer([ephem_component])	Create a new phase viewer corresponding to component and populate the phase arrays with the current ephemeris, if necessary.
get_data(dataset[, ephem_component])
phases_to_times(phases[, ephem_component])
query_for_ephemeris()
remove_component(lbl)
rename_component(old_lbl, new_lbl)
times_to_phases(times[, ephem_component])
update_ephemeris([ephem_component, t0, ...])	Update the ephemeris for a given component.
vue_adopt_period_at_max_power(*args)
vue_create_ephemeris_from_query(*args)
vue_create_phase_viewer(*args)
vue_period_double(*args)
vue_period_halve(*args)
vue_query_for_ephemeris(*args)

Attributes Documentation

component_edit_value

A trait for unicode strings.

component_items

An instance of a Python list.

component_mode

A trait for unicode strings.

component_selected

A trait for unicode strings.

default_phase_viewer

dpdt

Mixin to handle empty floating point field.

dpdt_step

A float trait.

ephemerides

ephemeris

method_err

A trait for unicode strings.

method_items

An instance of a Python list.

method_selected

A trait for unicode strings.

method_spinner

A boolean (True, False) trait.

nasa_exoplanet_archive

period

Mixin to handle empty floating point field.

period_at_max_power

A float trait.

period_from_catalog

Mixin to handle empty floating point field.

period_step

A float trait.

phase_comp_lbl

phase_viewer_exists

A boolean (True, False) trait.

query_dec

Mixin to handle empty floating point field.

query_name

A trait for unicode strings.

query_ra

Mixin to handle empty floating point field.

query_radius

Mixin to handle empty floating point field.

query_result_items

An instance of a Python list.

query_result_selected

A trait for unicode strings.

query_spinner

A boolean (True, False) trait.

ra_dec_step

A float trait.

reference_time = None

t0

Mixin to handle empty floating point field.

t0_from_catalog

Mixin to handle empty floating point field.

t0_step

A float trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/lcviz/envs/v2.0.0/lib/python3.11/site-packages/lcviz/plugins/ephemeris/ephemeris.py', 'ephemeris.vue')

user_api

wrap_at

Mixin to handle empty floating point field.

Methods Documentation

add_component(lbl, set_as_selected=True)

adopt_period_at_max_power()

create_ephemeris_from_query(*args)

create_phase_viewer(ephem_component=None)

Create a new phase viewer corresponding to component and populate the phase arrays with the current ephemeris, if necessary.

Parameters:

ephem_component (str, optional) – label of the component. If not provided or None, will default to plugin value.

get_data(dataset, ephem_component=None)

phases_to_times(phases, ephem_component=None)

query_for_ephemeris()

remove_component(lbl)

rename_component(old_lbl, new_lbl)

times_to_phases(times, ephem_component=None)

update_ephemeris(ephem_component=None, t0=None, period=None, dpdt=None, wrap_at=None)

Update the ephemeris for a given component.

Parameters:

• ephem_component (str, optional) – label of the component. If not provided or None, will default to plugin value.

• t0 (float, optional) – value of t0 to replace

• period (float, optional) – value of period to replace

• dpdt (float, optional) – value of dpdt to replace

• wrap_at (float, optional) – value of wrap_at to replace

Return type:

dictionary of ephemeris corresponding to component

vue_adopt_period_at_max_power(*args)

vue_create_ephemeris_from_query(*args)

vue_create_phase_viewer(*args)

vue_period_double(*args)

vue_period_halve(*args)

vue_query_for_ephemeris(*args)