LCviz#

class lcviz.helper.LCviz(*args, **kwargs)[source]#

Bases: ConfigHelper

Attributes Summary

default_time_viewer

new_viewers

Access API objects for creating new viewers.

Methods Summary

get_data([data_label, cls, subset])

Returns data with name equal to data_label of type cls with subsets applied from subset_to_apply.

load_data(data[, data_label, extname])

Attributes Documentation

default_time_viewer#
new_viewers#

Methods Documentation

get_data(data_label=None, cls=<class 'lightkurve.lightcurve.LightCurve'>, subset=None)[source]#

Returns data with name equal to data_label of type cls with subsets applied from subset_to_apply.

Parameters:

  • data_label (str, optional) – Provide a label to retrieve a specific data set from data_collection.

  • cls (light curve class, optional) – The type that data will be returned as.

  • subset (str, optional) – Subset that is to be applied (as a mask) to the data before it is returned.

Returns:

data – Data is returned as type cls with subsets applied.

Return type:

cls

load_data(data, data_label=None, extname=None)[source]#

Deprecated since version 1.2: The load_data function is deprecated and may be removed in a future version. Use load instead.

Load data into LCviz.

Parameters:

  • data (obj or str) –

    File name or object to be loaded. Supported formats include:

    • 'filename.fits' (or any extension that astropy.io.fits supports)

    • LightCurve (extracts the default flux column)

  • data_label (str or None) – Data label to go with the given data. If not given, this is automatically determined from filename or randomly generated. The final label shown in LCviz may have additional information appended for clarity.

  • extname (str or None) – Used for DVT parsing if only a single TCE from a multi-TCE file should be loaded. Formatted as ‘TCE_1’, ‘TCE_2’, etc.