RAMjET

ramjet.analysis.viewer.light_curve_display

Code for displaying a light curve figure.

Module Contents

Classes

LightCurveDisplay A class for displaying a light curve figure.
class LightCurveDisplay[source]

A class for displaying a light curve figure.

__init__(self)[source]

Initialize self. See help(type(self)) for accurate signature.

classmethod for_columns(cls, time_column_name: str, flux_column_names: List[str], flux_axis_label: str = 'Flux')[source]

Creates a lightcurve display object with the specified columns prepared for display.

Parameters:
  • time_column_name – The name of the time column in the data.
  • flux_column_names – The names of the flux columns in the data.
  • flux_axis_label – The name to display on the flux axis.
Returns:

The light curve display.

initialize_figure(self, time_axis_label: str, flux_axis_label: str)[source]

Initializes the figure.

Parameters:
  • time_axis_label – The time axis label.
  • flux_axis_label – The flux axis label.
initialize_data_source(self, column_names: List[str])[source]

Creates a data source with the passed column names.

Parameters:column_names – The column names to include in the data source.
add_flux_data_source_line_to_figure(self, time_column_name: str, flux_column_name: str, color: Color)[source]

Add a flux data source time series line to the figure.

Parameters:
  • time_column_name – The name to use for the time column.
  • flux_column_name – The name to use for the flux column.
  • color – The color to use for the line.
update_from_light_curve(self, lightcurve: LightCurve)[source]

Update the data for the display based on a light curve.

Parameters:lightcurve – The light curve to display.
set_view_ranges(self, x_range: (float, float), y_range: (float, float))[source]

Sets the view range to a specified range.

Parameters:
  • x_range – The start and end of the x range.
  • y_range – The start and end of the y range.
enable_auto_range_selection(self)[source]

Enables selecting a specific auto range by creating a dummy invisible glyph and auto ranging to that.