Flatten

class lcviz.plugins.flatten.flatten.Flatten(*args, **kwargs)

Bases: PluginTemplateMixin, FluxColumnSelectMixin, DatasetSelectMixin

See the Flatten 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()

• show_live_previewbool

  Whether to show the live-preview of the (unnormalized) flattened light curve

• show_trend_previewbool

  Whether to show the live-preview of the trend curve used to flatten the light curve

• dataset (DatasetSelect): Dataset to flatten.

• window_length : int

• polyorder : int

• break_tolerance : int

• niters : int

• sigma : float

• unnormalize : bool

• flux_label (AutoTextField): Label for the resulting flux column added to dataset and automatically selected as the new flux column (origin).

• flatten()

Public constructor

Attributes Summary

break_tolerance	Mixin to handle empty integer field.
flatten_err	A trait for unicode strings.
flux_label_auto	A boolean (True, False) trait.
flux_label_default	A trait for unicode strings.
flux_label_invalid_msg	A trait for unicode strings.
flux_label_label	A trait for unicode strings.
flux_label_overwrite	A boolean (True, False) trait.
marks
niters	Mixin to handle empty integer field.
polyorder	Mixin to handle empty integer field.
show_live_preview	A boolean (True, False) trait.
show_trend_preview	A boolean (True, False) trait.
sigma	Mixin to handle empty floating point field.
template_file
unnormalize	A boolean (True, False) trait.
user_api
uses_active_status	A boolean (True, False) trait.
window_length	Mixin to handle empty integer field.

Methods Summary

flatten([add_data])	Flatten the input light curve (dataset) using lightkurve.flatten.
vue_apply(*args, **kwargs)

Attributes Documentation

break_tolerance

Mixin to handle empty integer field.

flatten_err

A trait for unicode strings.

flux_label_auto

A boolean (True, False) trait.

flux_label_default

A trait for unicode strings.

flux_label_invalid_msg

A trait for unicode strings.

flux_label_label

A trait for unicode strings.

flux_label_overwrite

A boolean (True, False) trait.

marks

niters

Mixin to handle empty integer field.

polyorder

Mixin to handle empty integer field.

show_live_preview

A boolean (True, False) trait.

show_trend_preview

A boolean (True, False) trait.

sigma

Mixin to handle empty floating point field.

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

unnormalize

A boolean (True, False) trait.

user_api

uses_active_status

A boolean (True, False) trait.

window_length

Mixin to handle empty integer field.

Methods Documentation

flatten(add_data=True)

Flatten the input light curve (dataset) using lightkurve.flatten.

Parameters:

add_data (bool) – Whether to add the resulting light curve as a flux column and select that as the new flux column (origin) for that data entry.

Returns:

• output_lc (LightCurve) – The flattened light curve.

• trend_lc (LightCurve) – The trend used to flatten the light curve.

vue_apply(*args, **kwargs)