adler.utilities.plotting_utilities
Functions
|
Make an errorbar scatter plot of reduced magnitude against phase angle to show the phase curve of an Adler object. |
|
Display the possible range of model values for a PhaseCurve object with uncertainty. |
Module Contents
- plot_errorbar(planetoid, filt_list=[], x_plot='phaseAngle', y_plot='reduced_mag', yerr_plot='magErr', c_plot=None, fig=None, label_list=None, col_list=None, filename=None)[source]
Make an errorbar scatter plot of reduced magnitude against phase angle to show the phase curve of an Adler object.
- planetoid: AdlerPlanetoid
AdlerPlanetoid object containing the observational data to be plotted
- filt_list: list
List of filters to be plotted
- x_plot: str
Name of the AdlerPlanetoid attribute to be plotted on the x axis
- y_plot: str
Name of the AdlerPlanetoid attribute to be plotted on the y axis
- yerr_plot: str
Name of the AdlerPlanetoid attribute for the y axis uncertainties
- c_plot: str
Name of the AdlerPlanetoid attribute used for the colour scale
- fig: matplotlib.figure.Figure
Optional, pass an existing figure object to be added to
- label_list: list
Optional, labels for errorbar plot elements. The user can add the legend manually after the fact in case additional elements are added to the figure.
- col_list: list
Optional, colors for errorbar scatter points
- filename: str
Optional, if provided save the figure with this filename
- Returns:
fig – The figure object which can be manipulated further if required
- Return type:
matplotlib.figure.Figure
- plot_phasecurve(pc, x=np.radians(np.linspace(0, 30)), x_plot='phaseAngle', y_plot='reduced_mag', fig=None, label=None, col=None, alpha=None, filename=None, bounds_std=None)[source]
Display the possible range of model values for a PhaseCurve object with uncertainty.
- pc: PhaseCurve
PhaseCurve object containing the PhaseCurve model parameters
- filt_list: list
List of filters to be plotted
- xarray
Array of x values (phase angle) at which to evaluate the PhaseCurve model
- x_plot: str
x axis label
- y_plot: str
y axis label
- fig: matplotlib.figure.Figure
Optional, pass an existing figure object to be added to
- label: str
Optional, label for the plot element
- col: str
Optional, color for the plot element
- alpha: float
Optional, transparency for the plot element
- filename: str
Optional, if provided save the figure with this filename
- bounds_stdfloat
Optional, if included plot the bounds of the PhaseCurve function. Number of standard deviations we want to consider when determining the minimum/maximum parameter values, where we assume that the parameter uncertainty is representative of a 1 sigma std in a gaussian distribution.
- Returns:
fig – The figure object which can be manipulated further if required
- Return type:
matplotlib.figure.Figure