astronomicAL.dashboard¶

class astronomicAL.dashboard.active_learning.ActiveLearningDashboard(src, df)¶

A dashboard for initialising and rendering panels for Active Learning.

Parameters

src (ColumnDataSource) – The shared data source which holds the current selected source.
df (DataFrame) – The shared dataframe which holds all the data.
active_learning (list of ActiveLearningModel) – List of all classifier tab views.

row¶

The layout of the dashboard is housed in this row.

Type: Panel Row

add_active_learning()¶

Initialise all required ActiveLearningModel classifiers and views.

Returns
Return type: None

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row

class astronomicAL.dashboard.dashboard.Dashboard(src, contents='Menu')¶

params(contents=String, name=String) Top-level Dashboard which holds an instance of any other Dashboard.

This will initialize and render any of the other instances of the dashboards and handles the interactions of switching from one dashboard view to another.

Parameters

srcColumnDataSource

The shared data source which holds the current selected source.

contentsparam.String, default = “Menu”: The identifier for which of the dashboard views should be initialised and rendered.

Attributes

rowPanel Row

The panel is housed in a row which can then be rendered by the Panel layout.

dfDataFrame: The shared dataframe which holds all the data.

[1;32mParameters of ‘Dashboard’

=========================

[0m

[1;31mParameters changed from their default values are marked in red.[0m

[1;36mSoft bound values are marked in cyan.[0m

C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None

[1;34mName Value Type Mode [0m

contents ‘’ String V RW

[1;32mParameter docstrings:

=====================[0m

[1;34mcontents: < No docstring available >[0m

panel()¶

Render the current view.

Returns: row – The panel contents is housed in a row which can then be rendered by the Panel layout.
Return type: Panel Row

set_contents(updated)¶

Update the current dashboard by setting a new contents.

Parameters: updated (str) – The new contents view required.
Returns
Return type: None

class astronomicAL.dashboard.dashboard.LabellingDashboard(src, df)¶

params(X_variable=Selector, Y_variable=Selector, name=String) A dashboard for .

Attributes

[1;32mParameters of ‘LabellingDashboard’
==================================
[0m
[1;31mParameters changed from their default values are marked in red.[0m
[1;36mSoft bound values are marked in cyan.[0m
C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None
[1;34mName Value Type Mode [0m
X_variable ‘0’ Selector V RW
Y_variable ‘1’ Selector V RW
[1;32mParameter docstrings:
=====================[0m
[1;34mX_variable: Selection box for the X axis of the plot.[0m
[1;31mY_variable: Selection box for the Y axis of the plot.[0m

_update_variable_lists()¶

Update the list of options used inside X_variable and Y_variable.

This method retrieves an up-to-date list of columns inside df and assigns them to both Selector objects.

Returns
Return type: None

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row

plot(x_var=None, y_var=None)¶

Create a basic scatter plot of the data with the selected axis.

The data is represented as a Holoviews Datashader object allowing for large numbers of points to be rendered at once. Plotted using a Bokeh renderer, the user has full manuverabilty of the data in the plot.

Returns: plot – A Holoviews plot
Return type: Holoviews Object

class astronomicAL.dashboard.menu.MenuDashboard(main)¶

A Dashboard used to dynamically choose which view to display.

Parameters: main (Dashboard) – The parent Dashboard view required for updating which dashboard is rendered.

row¶

The panel is housed in a row which can then be rendered by the parent Dashboard.

Type: Panel Row

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row

class astronomicAL.dashboard.plot.PlotDashboard(src, close_button)¶

params(X_variable=Selector, Y_variable=Selector, name=String) A Dashboard used for rendering dynamic plots of the data.

Parameters

srcColumnDataSource: The shared data source which holds the current selected source.

Attributes

X_variableparam.Selector

A Dropdown list of columns the user can use for the x-axis of the plot.

Y_variableDataFrame: A Dropdown list of columns the user can use for the x-axis of the plot.
rowPanel Row: The panel is housed in a row which can then be rendered by the parent Dashboard.
dfDataFrame: The shared dataframe which holds all the data.

[1;32mParameters of ‘PlotDashboard’

=============================

[0m

[1;31mParameters changed from their default values are marked in red.[0m

[1;36mSoft bound values are marked in cyan.[0m

C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None

[1;34mName Value Type Mode [0m

X_variable ‘0’ Selector V RW

Y_variable ‘1’ Selector V RW

[1;32mParameter docstrings:

=====================[0m

[1;34mX_variable: Selection box for the X axis of the plot.[0m

[1;31mY_variable: Selection box for the Y axis of the plot.[0m

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row

plot(x_var=None, y_var=None)¶

Create a basic scatter plot of the data with the selected axis.

The data is represented as a Holoviews Datashader object allowing for large numbers of points to be rendered at once. Plotted using a Bokeh renderer, the user has full manuverabilty of the data in the plot.

Returns: plot – A Holoviews plot
Return type: Holoviews Object

update_variable_lists()¶

Update the list of options used inside X_variable and Y_variable.

This method retrieves an up-to-date list of columns inside df and assigns them to both Selector objects.

Returns
Return type: None

class astronomicAL.dashboard.selected_source.SelectedSourceDashboard(src, close_button)¶

A Dashboard used for showing detailed information about a source.

Optical and Radio images of the source are provided free when the user has Right Ascension (RA) and Declination (Dec) information. The user can specify what extra information they want to display when a source is selected.

Parameters: src (ColumnDataSource) – The shared data source which holds the current selected source.

df¶

The shared dataframe which holds all the data.

Type: DataFrame

row¶

The panel is housed in a row which can then be rendered by the parent Dashboard.

Type: Panel Row

selected_history¶

List of source ids that have been selected.

Type: List of str

optical_image¶

Widget for holding the JPG image of the selected source based its RADEC. The image is pulled from the SDSS SkyServer DR16 site.

Type: Panel Pane JPG

radio_image¶

Widget for holding the GIF image of the selected source based its RADEC. The image is pulled from the FIRST cutout server.

Type: Panel Pane GIF

_image_zoom¶

A float containing the current zoom level of the optical_image. The zoom is controlled by the zoom in and out buttons on the dashboard

Type: float

src¶

The shared data source which holds the current selected source.

Type: ColumnDataSource

check_required_column(column)¶

Check df has the required column.

Parameters: column (str) – Check whether this column is in df
Returns: has_required – Whether the column is in df.
Return type: bool

empty_selected()¶

Deselect sources by emptying src.data.

Returns
Return type: None

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row

class astronomicAL.dashboard.settings_dashboard.SettingsDashboard(main, src)¶

A Dashboard used to display configuration settings for the user.

Parameters

main (Dashboard) – The parent Dashboard view required for updating which dashboard is rendered.
src (ColumnDataSource) – The shared data source which holds the current selected source.

row¶

The panel is housed in a row which can then be rendered by the Panel layout.

Type: Panel Row

pipeline¶

A pipeline of stages for the user to assign key parameters.

Type: Panel Pipeline

create_pipeline(mode)¶

Create the pipeline of setting stages.

Returns
Return type: None

get_settings()¶

Get the settings assigned during the pipeline stages.

Returns: updated_settings – A dictionary of assigned parameters.
Return type: dict

panel()¶

Render the current view.

Returns: row – The panel is housed in a row which can then be rendered by the parent Dashboard.
Return type: Panel Row