astronomicAL.settings¶
- class astronomicAL.settings.active_learning.ActiveLearningSettings(close_button, mode)¶
params(name=String) The Active Learning Settings Stage used in the settings pipeline.
- Parameters
- close_buttonPanel Button
Close button widget from the parent settings dashboard to allow the button to be updated when all settings have been completed.
- Attributes
- dfDataFrame
The shared dataframe which holds all the data.
- label_selectorPanel CrossSelector
CrossSelector widget for choosing which of the dataset labels should have a classifier created.
- feature_selectorPanel CrossSelector
CrossSelector widget for choosing which of the data columns should be used during the machine learning steps.
- exclude_labels_checkboxPanel Checkbox
Checkbox widget for choosing whether the labels which do not have a classifier should be removed completely from the data used for the machine learning steps.
- scale_features_checkboxPanel Checkbox
Checkbox widget for choosing whether the chosen features should be normalised in the mahchine learning preprocessing.
- completedbool
Flag indicating all active learning settings have been chosen and assigned.
- [1;32mParameters of ‘ActiveLearningSettings’
- ======================================
- [0m
- Object has no parameters.
- get_df()¶
Return the active learning settings dataframe.
- Returns
df – Data collected up to and including the Active Learning settings panel.
- Return type
DataFrame
- is_complete()¶
Return whether the settings page has been completed.
- Returns
completed – Flag for whether the settings have been completed and assigned.
- Return type
bool
- panel()¶
Render the current settings view.
- Returns
column – The panel is housed in a column which can then be rendered by the settings Dashboard.
- Return type
Panel Column
- update_data(dataframe=None)¶
Update the classes local copy of the dataset.
- Parameters
dataframe (DataFrame, default = None) – An up to date version of the dataset.
- Returns
- Return type
None
- class astronomicAL.settings.data_selection.DataSelection(src, mode)¶
params(config_file=ObjectSelector, dataset=ObjectSelector, load_config_select=ObjectSelector, load_layout_check=Boolean, ready=Boolean, name=String) The Data Selection Stage used in the settings pipeline.
- Parameters
- srcColumnDataSource
The shared data source which holds the current selected source.
- Attributes
- datasetFileSelector
Dropdown list of .FITS files within data/ folder.
- memory_optimisation_checkPanel Checkbox
Flag for whether to memory optimise the loaded in DataFrame.
- readybool
Flag for whether the data has been loaded in and ready to progress to the next settings stage.
- [1;32mParameters of ‘DataSelection’
- =============================
- [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 Bounds Mode [0m
- dataset ‘’ ObjectSelector V RW
- config_file ‘’ ObjectSelector V RW
- load_config_select ‘’ ObjectSelector V RW
- load_layout_check False Boolean (0, 1) V RW
- ready False Boolean (0, 1) V RW
- [1;32mParameter docstrings:
- =====================[0m
- [1;34mdataset: < No docstring available >[0m
- [1;31mconfig_file: < No docstring available >[0m
- [1;34mload_config_select: < No docstring available >[0m
- [1;31mload_layout_check: < No docstring available >[0m
- [1;34mready: < No docstring available >[0m
- get_dataframe_from_fits_file(filename, optimise_data=None)¶
Load data from FITS file into dataframe.
- Parameters
filename (str) – Path of file to be loaded.
- Returns
df – DataFrame containing the loaded in data from filename.
- Return type
DataFrame
- get_df()¶
Return the dataframe that has been loaded in from a file.
- Returns
df – DataFrame containing the dataset loaded in by a file chosen by the user.
- Return type
DataFrame
- panel()¶
Render the current settings view.
- Returns
column – The panel is housed in a column which can then be rendered by the settings Dashboard.
- Return type
Panel Column
- class astronomicAL.settings.param_assignment.ParameterAssignment¶
params(completed=Boolean, id_column=ObjectSelector, label_column=ObjectSelector, ready=Boolean, name=String) The Parameter Assignment Stage used in the settings pipeline.
- Parameters
- dfDataFrame
The shared dataframe which holds all the data.
- Attributes
- dfDataFrame
The shared dataframe which holds all the data.
- label_columnPanel ObjectSelector
Dropdown for choosing which of the dataset columns is the label column.
- id_columnPanel ObjectSelector
Dropdown for choosing which of the dataset columns is the id column.
- completedbool
Flag indicating all active learning settings have been chosen and assigned.
- readybool
Flag for whether the data has been loaded in and ready to progress to the next settings stage.
- colours_paramdict
Dictionary holding the colours to render each of the labels.
- label_strings_paramdict
Dictionary holding the string aliases of the labels that are displayed throughout the ui.
- [1;32mParameters of ‘ParameterAssignment’
- ===================================
- [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 Bounds Mode [0m
- label_column ‘default’ ObjectSelector V RW
- id_column ‘default’ ObjectSelector V RW
- completed False Boolean (0, 1) V RW
- ready False Boolean (0, 1) V RW
- [1;32mParameter docstrings:
- =====================[0m
- [1;34mlabel_column: < No docstring available >[0m
- [1;31mid_column: < No docstring available >[0m
- [1;34mcompleted: < No docstring available >[0m
- [1;31mready: < No docstring available >[0m
- _update_labels_cb()¶
Update label settings when the user changes the label column.
- Returns
- Return type
None
- get_id_column()¶
Return the name of the id column.
- Returns
id_column – The column name of the id column of the data.
- Return type
str
- get_label_colours()¶
Return the colours chosen to represent labels in plots.
- Returns
colours – Dictionary containing the labels as keys and the corresponding colours as values.
- Return type
dict
- get_label_column()¶
Return the name of the column containing the labels in the data.
- Returns
label_column – The name of the column containing the labels in the data.
- Return type
str
- get_label_strings()¶
Return the string aliases and the corresponding conversions of the labels.
- Returns
labels_to_strings (dict) – Dictionary containing labels as keys and the corresponding aliases as values.
strings_to_labels (dict) – Dictionary containing aliases as keys and the corresponding labels as values.
- get_settings()¶
Return all the saved parameter assignment settings.
- Returns
updated_settings – Dictionary containing the setting saved throughout the parameter assignment stage.
- Return type
dict
- is_complete()¶
Check whether the parameter assignment stage is complete.
- Returns
completed – Flag whether parameter assignment settings have been assigned and saved.
- Return type
bool
- panel()¶
Render the current settings view.
- Returns
column – The panel is housed in a column which can then be rendered by the settings Dashboard.
- Return type
Panel Column
- update_colours()¶
Update the colours used for rendering.
- Returns
- Return type
None
- update_data(dataframe=None)¶
Update the local copy of the data and update widgets accordingly.
- Parameters
dataframe (DataFrame, default = None) – The updated data to be used.
- Returns
- Return type
None