hesmapy.rt package

Submodules

hesmapy.rt.lightcurves module

class hesmapy.rt.lightcurves.RTLightcurve(path)

Bases: HesmaBaseJSONFile

get_data(viewing_angle: float = None, model: str | int = None) → DataFrame

Get the data for a specific viewing angle

Parameters

viewing_anglefloat, optional

Viewing angle to get data for, by default None

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted

Returns

pd.DataFrame

get_derived_data(viewing_angle: float = None, model: str | int = None) → DataFrame

Get the derived data for a specific viewing angle

Parameters

viewing_anglefloat, optional

Viewing angle to get data for, by default None

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted

Returns

pd.DataFrame

get_unique_bands(model: str | int = None) → list

Get the unique bands

Parameters

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is accessed

Returns

list

get_unique_viewing_angles(model: str | int = None) → list

Get the unique viewing angles

Parameters

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is accessed

Returns

list

get_units(model: str | int = None) → dict

Get the units for a model

Parameters

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is accessed

Returns

dict

plot(model: str | int = None, show_plot: bool = False) → Figure

Plot the data

Parameters

modelstr | int, optional

Model to plot, by default None. Accepts either the model name or the index of the model in the list of models. If model is None, the first model is plotted

show_plotbool, optional

Show the plot, by default False

Returns

go.Figure

Module contents