opihiexarata.gui.manual module

The manual GUI window.

class opihiexarata.gui.manual.OpihiManualWindow[source]

Bases: QMainWindow

__configuration_draw_busy_image(progress_index: int = None) → None

Exactly the same as draw_busy_image, but we use the settings as per the configuration. This function is just a connivent wrapper.

Parameters:: progress_index (int, default = None) – If provided, and between 1-4 inclusive, the busy image with progress text is output, otherwise, the default image without any text is used.
Return type:: None

__connect_button_group_primary_working_file() → None

On any click of the primary working file radio buttons, we find and apply the primary file index.

Parameters:: None –
Return type:: None

__connect_push_button_astrometry_custom_solve() → None

The button which uses an astrometric solution to solve for a custom pixel location or RA DEC location depending on entry.

This prioritizes solving RA DEC from pixel location. The OpihiSolution which is used is the primary solution based on the primary index.

Parameters:: None –
Return type:: None

__connect_push_button_change_target_name() → None

Change the target name of the GUI, and by extension, all of the OpihiSolution instances as well.

Parameters:: None –
Return type:: None

__connect_push_button_ephemeris_forward_solve() → None

Solving for the location of the target through the ephemeris based on the time and date provided by the user.

Parameters:: None –
Return type:: None

__connect_push_button_ephemeris_results_update_tcs_rates() → None

A routine to update the non-sidereal rates of the TCS as provided by the ephemeritic solution.

Parameters:: None –
Return type:: None

__connect_push_button_force_reset() → None

This resets the entire GUI, removing all of the information solved or unsolved. Nothing is saved at all.

Parameters:: None –
Return type:: None

__connect_push_button_load_filename(index: int) → None

The method for loading in a new file(name) for a file based on the index.

Parameters:: index (int) – The file index of which this loading should be for.
Return type:: None

__connect_push_button_orbit_solve_orbit() → None

A routine to use the current observation and historical observations to derive the orbit solution.

Parameters:: None –
Return type:: None

__connect_push_button_propagate_forward_solve() → None

Solving for the location of the target through propagation based on the time and date provided by the user.

Parameters:: None –
Return type:: None

__connect_push_button_propagate_results_update_tcs_rates() → None

A routine to update the non-sidereal rates of the TCS as provided by the propagation solution.

Parameters:: None –
Return type:: None

__connect_push_button_relocate_target_location(index: int) → None

The method for re-determining the location of the asteroid for file/image of the given index.

Parameters:: index (int) – The file index of which the target location is being changed for.
Return type:: None

__connect_push_button_save_and_reset() → None

This resets the entire GUI, removing all of the information solved or unsolved. However, it saves anything it can.

Parameters:: None –
Return type:: None

__connect_push_button_send_target_to_tcs() → None

The button which extracts the parameters of the primary image and sends it to the TCS.

Parameters:: None –
Return type:: None

__connect_push_button_solve_astrometry() → None

The button to instruct on the solving of the astrometric solution.

Parameters:: None –
Return type:: None

__connect_push_button_solve_ephemeris() → None

A routine to use the current observation and historical observations to derive the orbit solution.

Parameters:: None –
Return type:: None

__connect_push_button_solve_photometry() → None

The button to instruct on the solving of the photometric solution.

Parameters:: None –
Return type:: None

__connect_push_button_solve_propagation() → None

A routine to use the current observation and historical observations to derive the propagation solution.

Parameters:: None –
Return type:: None

__init__() → None[source]

The manual GUI window for OpihiExarata. This interacts directly with the total solution object of Opihi.

Parameters:: None –
Return type:: None

__init_gui_connections() → None

Assign the action bindings for the buttons which get new file(names).

Parameters:: None –
Return type:: None

__init_opihi_image() → None

Create the image area which will display what Opihi took from the sky. This takes advantage of a reserved image vertical layout in the design of the window.

Parameters:: None –
Return type:: None

__init_preprocess_solution()

Initialize the preprocessing solution. The preprocessing files should be specified in the configuration file.

Parameters:: None –
Return type:: None

__init_zero_point_database() → None

This function initializes the zero point database as specified by the configuration file.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_astrometry() → None

Refresh all of the dynamic label text for astrometry. This fills out the information based on the current solutions available and solved.

An astrometric solution must exist.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_ephemeris() → None

Refresh all of the dynamic label text for ephemerides. This fills out the information based on the current primary solution available and solved.

An ephemeritic solution must exist.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_file_selector() → None

Refresh all of the dynamic label text for the file selector.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_orbit() → None

Refresh all of the dynamic label text for orbit. This fills out the information based on the current primary solution available and solved.

An orbital solution must exist.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_photometry() → None

Refresh all of the dynamic label text for photometry. This fills out the information based on the current solutions available and solved.

A photometric solution must exist.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_propagate() → None

Refresh all of the dynamic label text for propagate. This fills out the information based on the current solutions available and solved.

A propagative solution must exist.

Parameters:: None –
Return type:: None

__refresh_dynamic_label_text_summary() → None

Refresh all of the dynamic label text for the summary.

Parameters:: None –
Return type:: None

__write_zero_point_record_to_database(opihi_solution: OpihiSolution) → None

This function writes the zero point information assuming a solved photometric solution. This function is so that threading this process away is a lot easier.

Parameters:: opihi_solution (OpihiSolution) – The solution class of the image.
Return type:: None

_get_mpcrecord_archive_filename() → str[source]

This is a function which gets the MPC record archive filename from naming conventions and the current fits file name.

Parameters:: None –
Returns:: mpc_record_filename – The filename of the MPC record for this object/image.
Return type:: str

_get_primary_fits_filename() → str[source]

This function gets the FITS filename of the primary file as determined by the GUI radio buttons.

Parameters:: None –
Returns:: primary_fits_filename – The primary fits filename. If the selected primary FITS file does not exist, this is None.
Return type:: str

_get_target_selector_reference_filename(current_filename: int) → str[source]

This function gets what the reference filename ought to be based on the current filename provided.

This function prioritizes using the first image, then the last image as the reference images, cycling through until something is found. If none of said images exist, then None is returned.

Parameters:: current_filename (str) – The “current filename” of which is the filename which is used to determine the location of the target for the target selector. The reference filename cannot be the same file as this filename.
Returns:: reference_filename – The reference filename to send to the target selector.
Return type:: str

_get_target_set_name_guess() → str[source]

This function attempts to guess the target name from multiple sources in the order of authority.

The primary file index is preferred, then the order of the files in progressive order. The chain of priority (within each file) goes as: GUI input, OpihiExarata solution, FITS object, Filename.

Parameters:: None –
Returns:: guess_target_set_name – The target set name that this function has found to be the best guess based on the hierarchy.
Return type:: str

_parse_custom_orbital_elements() → dict[source]

This function takes the textual form of the orbital elements as entered and tries to parse it into a set of orbital elements and errors.

Parameters:: None –
Returns:: orbital_elements – A dictionary of the orbital elements and their errors, if they exist.
Return type:: dictionary

draw_busy_image(progress_index: int = None, replace: bool = True, transparency: float = 1) → None[source]

This draws the busy image.

We draw the busy image on top of the Opihi image to signify that the software is going to be doing something and will be busy for a short time. As the window will be frozen for a period of time, the plot will not be intractable so it does not matter that we use that space. It also means that a separate window won’t be needed and the user would not get confused or miss it.

Parameters:

progress_index (int, default = None) – If provided, and between 1-4 inclusive, the busy image with progress text is output, otherwise, the default image without any text is used.
replace (bool, default = True) – If True, we replace the Opihi image with the busy image instead of over-plotting it. This does not affect the Opihi image in general and it can be restored with a redraw.
transparency (float, default = 1) – If replace is False, the image is instead over-plotted with the transparency provided here.

Return type:

None

draw_nothing() → None[source]

This function clears the plot completely and assigns no data to it.

Parameters:: None –
Return type:: None

draw_opihi_image() → None[source]

Redraw the Opihi image given that new results may have been added because some solutions were completed. This modifies the GUI in-place.

Parameters:: None –
Return type:: None

get_target_history_current() → list[str][source]

This function gets the current entries for the target history from the OpihiSolutions and the current data loaded into the GUI.

Parameters:: None –
Returns:: target_history_current – The current history, based off of the results from the solutions provided.
Return type:: list

load_fits_file(fits_filename: str) → OpihiSolution[source]

This loads a FITS file and returns an OpihiSolution class.

Parameters:: fits_filename (str) – The fits filename which will be loaded.
Returns:: opihi_solution – The solution wrapper class for the provided FITS filename.
Return type:: OpihiSolution

load_target_history_archive(archive_filename: str = None) → list[str][source]

This loads the target/asteroid history archive file and allows it to be used by the solution classes of all of the other solutions.

Parameters:: archive_filename (str, default = None) – The filename of the archive to load. If it is None, the default one is derived from the target name.
Returns:: target_history – The target history in a 80-column MPC format.
Return type:: list

refresh_dynamic_label_text() → None[source]

Refresh all of the dynamic label text, this fills out the information based on the current solutions available and solved.

Parameters:: None –
Return type:: None

reset_all() → None[source]

This function completely resets the GUI into its initial state.

Parameters:: None –
Return type:: None

reset_dynamic_label_text(complete: bool = False) → None[source]

Reset all of the dynamic label text and other related fields, this is traditionally done just before a new image is going to be introduced.

This resets the text back to their defaults as per the GUI builder.

The selections on the engines do not need to be reset as they are just a selection criteria and do not actually provide any information.

Parameters:: complete (bool, default = False) – Some entries are not cleared because this function is intended for refreshing the GUI for a new image, but, sometimes a more complete reset of the text is needed.
Return type:: None

save_all_fits_files() → None[source]

This function saves all of the FITS files into their respective default locations and configurations.

Parameters:: None –
Return type:: None

save_index_fits_file(index) → None[source]

This function executes the saving of the FITS file based on the provided index.

Parameters:: index (int) – The file index of the OpihiSolution to be saved to a FITS file.
Return type:: None

save_target_history_archive(archive_filename: str = None) → None[source]

This saves the target history archive into a file which contains all of the history of the asteroid/target observations, both past and the present ones solved for.

Parameters:: archive_filename (str, default = None) – The filename of the archive to load. If it is None, the default one is derived from the target name.
Return type:: None

staticMetaObject = PySide6.QtCore.QMetaObject("OpihiManualWindow" inherits "QMainWindow": )

opihiexarata.gui.manual.start_manual_window() → None[source]

This is the function to create the manual window for usage.

Parameters:: None –
Return type:: None