AllSkyCam4OLEODL package

AllSkyCam4OLEODL.constants module

This module contains all the constants needed to allow the project to work correctly.

AllSkyCam4OLEODL.api module

This module contains the API of the Allied Vision Goldeye Camera.

It has been modified in order to allow both streaming and recording. It allows processing of the frames without the need of writting them first.

class AllSkyCam4OLEODL.api.CameraControlSlider(master: Tk, camera_control: Handler)

Bases: Toplevel

Handles the sliders of the GUI menu.

__init__()

Initializes the CameraControlSlider class.

setup_exposure_slider()

Creates the exposure slider.

setup_min_value_slider()

Creates the minimum spot size value slider.

setup_max_value_slider()

Creates the maximum spot size value slider

update_exposure()

Updates the exposure value.

update_min_value()

Updates the minimum spot size value.

update_max_value()

Updates the maximum spot size value.

update_from_exposure_entry()

Updates the exposure value parsed through the button.

update_from_min_entry()

Updates the minimum spot size value parsed through the button.

update_from_max_entry()

Updates the maximum spot size value parsed through the button.

set_initial_values()

Sets the intial values for all the varibales of the sliders.

Parameters:

tk (tk.Toplevel) – Window where the slider should be created.

set_initial_values(exposure: float, min_value: int, max_value: int) → None

Sets the intial values for all the varibales of the sliders.

1. Gets the maximum and minimum spot size and exposure values and converts them to a logarithmic scale.

2. Sets initial values of the sliders.

3. Calls the update fuctions to set an inicial value for the variables.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• exposure (float) – Initial exposure time.

• min_value (int) – Initial minimum spot size value.

• max_value (int) – Initial maximum spot size value.

setup_exposure_slider() → None

Creates the exposure slider:

1. Initializes all slider elements and converts the exposure to a logarithmic scale.

2. Sets up the displayed exposure value and its slider.

3. Configures the button to manually change the exposure value.

Parameters:

self (Instance) – Current instance, provides access to attributes and methods.

setup_max_value_slider() → None

Creates the maximum spot size value slider:

1. Initializes all slider elements and converts the maximum spot size value to a logarithmic scale.

2. Sets up the displayed maximum value and its slider.

3. Configures the button to manually change the maximum spot size value.

Parameters:

self (Instance) – Current instance, provides access to attributes and methods.

setup_min_value_slider() → None

Creates the minimum spot size value slider:

1. Initializes all slider elements and converts the minimum spot size value to a logarithmic scale.

2. Sets up the displayed minimum value and its slider.

3. Configures the button to manually change the minimum spot size value.

Parameters:

self (Instance) – Current instance, provides access to attributes and methods.

update_exposure(event=None) → None

Updates the exposure value parsed through the slider:

1. Gets the exposure from the slider and converts it to a logarithmic scale.

2. Sends the updated exposure value to the camera.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

update_from_exposure_entry(event=None) → None

Updates the exposure value parsed through the button:

1. Gets the exposure value and converts it to a logarithmic scale if it is in the correct range. If not, it raises an error.

2. Updates the exposure value calling the update_exposure() function.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

Raises:

• ValueError – Exposure time inputed in the text-box is either bigger than the

• maximum exposure time or smaller than the smallest exposure time. –

update_from_max_entry(event=None) → None

Updates the maximum spot size value parsed through the button:

1. Gets the maximum spot size value and converts it to a logarithmic scale if it is bigger or equal to the minimum spot size values and smaller or equal than the full image.

2. Updates the maximum spot size value calling the update_max_value() function.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

Raises:

• ValueError – Maximum spot size value is either bigger than the dimensions of

• the whole frame or smaller than the minimum spot size value. –

update_from_min_entry(event=None) → None

Updates the minimum spot size value parsed through the button:

1. Gets the minimum spot size value and converts it to a logarithmic scale if it is bigger than zero but smaller than the maximum value.

2. Updates the minimum spot size value calling the update_min_value() function.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

Raises:

• ValueError – Minimum spot size value is either smaller than zero or bigger

• than the maximum spot size value. –

update_max_value(event=None) → None

Updates the maximum spot size value parsed through the slider:

1. Gets the maximum spot size value from the slider and converts it to a logarithmic scale.

2. The maximum selected spot size value will be the maximum value between the minimum spot size value and the smaller value between the maximum spot size value selected from the slider and whole dimensions of the image.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

update_min_value(event=None) → None

Updates the minimum spot size value parsed through the slider:

1. Gets the minimum spot size value from the slider and converts it to a logarithmic scale.

2. If the miniumum sleected spot size value is bigger than the maximum spot size value, the maximum spot size value is selected as the minimum spot size value. If a negative value is selected, it will be converted to 0.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• event (_type_, optional) – Nothing, just compatibility purposes. Defaults to None.

class AllSkyCam4OLEODL.api.Handler(cam: Camera, exposure_time_value: int, check: StringVar, light: StringVar, gain: StringVar, iso: StringVar, payload: StringVar, elevation_in: StringVar, fig: figure, ax: axes, line: hlines, xdata: list, ydata: list, el_lb, int_lb)

Bases: object

Handles the mayority of the camera operation.

__init__()

Initializes the Handler class.

update()

Updates the live graph of the GUI.

save_plot()

Saves the plot stored in the instance.

create_camera_control_slider()

Creates an slider, saves it in the instance.

set_exposure()

Updates the exposure value.

set_min_max_value()

Updates the minimum or maximum spot size value.

__call__()

Between each frame, sends the frame for

processing, prepares for the next one, and checks if the program has stopped.

create_camera_control_slider(root: Tk) → None

Creates an slider, saves it in the current instance (self) and sets its initial values:

1. Creates a slider within the current instance using the CameraControlSlider class.

2. Sets the initial values of the minimum and maximum spot size and the exposure with set_initial_values().

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• root (tk.Tk) – Main window of the GUI menu.

No-index:

save_plot() → None

Saves the plot stored in the current instance (self):

1. If recording mode is selected, sets the plot size, data, title, and labels.

2. Adjust the format of the time as H:M:S.

3. If a payload is chosen, its name will be added to the plot’s title.

4. Saves the plot in the same directory as the recorded frames (stored in the instance).

Parameters:

self (Instance) – Current instance, provides access to attributes and methods.

No-index:

set_exposure(exposure_time: int) → None

Updates the exposure value stored in the current instance (self).

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• exposure_time (int) – Exposure time value.

No-index:

set_min_max_value(value: int, siz: int) → None

Updates the minimum or maximum spot size value stored in the current instance (self).

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• value (int) – Final minimum or maximum spot size value.

• siz (int) – Integer to differenciate if we want to change the minimum or the maximum spot size value,

• maximum (1 for the)

• minimum. (0 for)

No-index:

update_graph(frame: Frame) → hlines

Updates the live graph of the GUI with new data stored in the current instance (self):

1. If data is available, plots it on the graph.

2. Adjusts the graph’s horizontal and vertical limits, extends the x-axis by 60 seconds, and increase the y-axis limit by 10% of the maximum value.

3. Updates the graph’s format as needed.

4. Plots the new data on the graph.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• frame (Frame) – Frame object from the VMBPY API module.

Returns:

Updated graph instance.

Return type:

plt.hlines

No-index:

AllSkyCam4OLEODL.api.abort(reason: str, return_code: int = 1, usage: bool = False) → None

API propietary exiting fuction and indicate an error.

Parameters:

• reason (str) – Reason to abort operation.

• return_code (int, optional) – Error code raised. Defaults to 1.

• usage (bool, optional) – Bool to check if an argument has been parsed. Defaults to False.

AllSkyCam4OLEODL.api.feature_changed_handler(feature) → None

API propietary printing fuction to indicate a changed of value of a feature.

Parameters:

feature (_type_) – Feature to be changed.

AllSkyCam4OLEODL.api.get_camera(camera_id: str | None) → Camera

API propietary fuction to obtain the camera.

Parameters:

camera_id (Optional[str]) – Specific camera we want to connect to.

Returns:

Camera we have connected to.

Return type:

Camera

AllSkyCam4OLEODL.api.grab_frame(cam: Camera) → None

Captures a frame to be used as a temporal frame:

1. Grabs a frame from the camera.

2. Saves the frame in the specified directory.

Parameters:

cam (Camera) – Camera object from the VMBPY API module.

AllSkyCam4OLEODL.api.parse_args() → str | None

API propietary fuction to parse an argument.

Returns:

Parsed argument.

Return type:

Optional[str]

AllSkyCam4OLEODL.api.setup_camera(cam: Camera, gain: StringVar, exposure: StringVar, exposure_time_value: int, iso: StringVar) → None

Configures the camera based on user inputs:

1. Checks camera mode, if the own camera’s background is chosen, it needs be enabled.

2. Sets the gain mode, either 0dB or 18dB.

3. Selects the exposure mode, Auto or Manual. If Manual, sets the exposure value.

4. Enables white balancing if camera supports it.

5. Adjusts GeV packet size (just for PoE camera).

Parameters:

• cam (Camera) – Camera object from the VMBPY API module.

• gain (tk.StringVar) – Container of the gain mode (0 [0 dB] or 1 [18 dB]).

• exposure (tk.StringVar) – Container of the exposure mode (Manual or Auto).

• exposure_time_value (int) – Specified exposure value for Manual mode.

• iso (tk.StringVar) – Container of the camera mode: Normal, Hot-pixel substraction, Subtraction or Camera’s BC.

AllSkyCam4OLEODL.api.setup_pixel_format(cam: Camera) → None

Configures the camera’s pixel format:

1. Retrieves all the camera’s compatible color pixel formats.

2. Filters out formats not compatible with OpenCV.

3. Retrieves all the camera’s compatible monochrome pixel formats.

4. Filters out formats not compatible with OpenCV.

5. Selects the OpenCV-compatible color pixel format. If none exist, attempts to convert an incompatible format to be compatible. If conversion is not possible, selects an OpenCV-compatible monochrome pixel format.

Parameters:

cam (Camera) – Camera object from the VMBPY API module.

AllSkyCam4OLEODL.api.upload_lut(cam: Camera, lut_dataset_selector_index: int, gain: StringVar) → None

Uploads and enables the LUT:

1. Checks the gain to select the correct LUT path.

2. Opens the LUT file, loads it into the camera and runs it.

3. Prints the directory and selected LUT.

Parameters:

• cam (Camera) – Camera object from the VMBPY API module.

• lut_dataset_selector_index (int) – Index of the selected LUT.

• gain (tk.StringVar) – Container of the gain mode for choosing the LUT (0 [0 dB] or 1 [18 dB]).

AllSkyCam4OLEODL.gui module

This module manages the GUI settings menu that appears when the program is first run.

AllSkyCam4OLEODL.gui.create_graph(elevation_in, payload) → Tuple[figure, axes, hlines, list, list]

Creates the live graph displayed in the GUI:

1. Creates the plot with an specific size, position, title and labels.

2. If a payload with full elevation range has been chosen, the graph will be smaller to acomodate the link budget graph.

3. Initializes the data for the graph.

Parameters:

• elevation_in (tk.StringVar) – Container of the elevation mode (Individual or Full).

• payload (tk.StringVar) – Container of the payload used (None, KIODO, OsirisV1, Osiris4CubeSat, CubeCat).

Returns:

fig (plt.figure): Figure of the created plot.

ax (plt.axes): Axes of the created plot.

line (plt.hlines): Lines of the created plot.

xdata (list): X-axis data from the created plot.

ydata (list): Y-axis data from the created plot.

Return type:

tuple[plt.figure, plt.axes, plt.hlines, list, list]

AllSkyCam4OLEODL.gui.create_menu() → Tuple[StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, StringVar, Tk, Entry, Entry]

Creates the GUI menu to configure the initial settings:

1. Creates the variables windows with an specific size and position.

2. Creates varibales to store the inputs.

3. Creates dropdown menus with default values.

4. Defines a lambda function to parse the exposure and elevation varibales to update_time_entry().

Returns:

gain_var (tk.StringVar): Container of the gain mode (0 [0 dB] or 1 [18 dB]).

check_var (tk.StringVar): Container of the streaming mode (Stream or Record).

light_var (tk.StringVar): Container of the time of the day (Daytime or Nighttime).

payload_var (tk.StringVar): Container of the payload used (None, KIODO, OsirisV1, Osiris4CubeSat or CubeCat).

h_ogs_var (tk.StringVar): Container of the height of the OGS used (IKN-OP or GSOC-OP).

zenith_var (tk.StringVar): Container of the zenith attenuation (Bad 1550nm [0.891], Good 1550nm [0.986], Bad 850nm [0.705], Good 850nm [0.950] or CubeCat 20240822 [0.963])

elevation_var (tk.StringVar): Container of the elevation mode (Individual or Full).

elevation_angle_var (tk.StringVar): Container of the elevation angle (if manual).

exposure_var (tk.StringVar): Container of the exposure mode (Auto or Manual).

exposure_time_var (tk.StringVar): Container of the exposure value (if manual).

iso_var (tk.StringVar): Container of the main camera mode (Normal, Hot-pixel substraction, Subtraction ormCamera’s BC).

root (tk.Tk): Main window of the GUI menu.

exposure_time_entry (tk.ttk.Entry): Value of the exposure.

elevation_angle_entry (tk.ttk.Entry): Value of the elevation.

Return type:

tuple

AllSkyCam4OLEODL.gui.update_entry(variable: StringVar, entry: Entry) → None

Checks for the parsed state of a variable to enable or disable its text box.

Parameters:

• variable (tk.StringVar) – Container of the variable to check.

• entry (tk.ttk.Entry) – Container of the value and its state.

AllSkyCam4OLEODL.image_processing module

This module manages the processing of the frames taken by the camera.

AllSkyCam4OLEODL.image_processing.brightest_V2(self, frame: array, exposure: float) → Tuple[Tuple, float, float, float, float, float]

Calculates the brightest point of the frame based on an specified minimum and maximum spot size.

1. Setups the calibration factor.

2. Depending if the daylight or nighttime is selcted a different process will be applyed:

   In case of Daytime: Bilateral filter 3 200x200 -> OTSU Thresholding.

   In case of Nighttime: Gaussian blur 3x3 -> Threshold based on black values.

3. Finds the contours of the figure (zones of the fram with similar pixel values).

4. Bounds the contours and filters them based on the minimum and maximum spot sizes values.

5. Select the contour with the highest mean pixel value.

6. Obtains the brightest pixel and the sum of all the values from the brightest contour.

7. Converts pixel value to intensity using the correction factor.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• frame (np.array) – Frame from where the brightest point will be obtained.

• exposure (float) – Exposure time used for that particular frame.

Returns:

max_loc (tuple):Location of the brightest point: [0] = x-axis, [1] = y-axis.

max_val (float): Pixel value of the brightest point [0-255].

intensity_brightest (float): Intensity value of the brightest point.

max_mean_pixel_value (float): Mean pixel value of the whole brightest contour.

sum_max_mean_pixel_value[0] (float): Summed pixel value of the whole brightest contour.

intensity_brightest_grid (float): Summed intensity value of the whole brightest contour.

Return type:

tuple[tuple, float, float, float, float, float]

AllSkyCam4OLEODL.image_processing.calculate_el_azi(max_loc: Tuple) → Tuple[float, float, float, float]

Calculates the elevation and azimuth of the brightest point of the frame, making use of the fisheye projections. Equidistant, equisolid and stereographic can be selected.

1. Calculates the distance from the center of the image to the brightest point.

2. Applies the projection to obtain the fov of the lens in the brightest point.

3. Obtains the elevation based on the fov.

4. Calculates the azimuth based on the center of the lens.

Parameters:

max_loc (tuple) – Location of the brightest point: [0] = x-axis, [1] = y-axis.

Returns:

elevation (float): Elevation of the brightest point.

fov (float): Field Of View of the camera, in degrees, at the brightest point.

r (float): Radial position of the brightest point.

azimuth (float): Azimuth of the brightest point.

Return type:

tuple[float, float, float, float]

AllSkyCam4OLEODL.image_processing.dark_frame_setup(frame: array) → array

Prepares a frame for processing:

1. A threshold of 45 is applied to a previously recorded image of the camera’s hot pixels.

2. The resulting thresholded image is normalized, resulting in an image with values [0, 1].

3. Finally the normalized image is scaled, obtaining an image with values [0, 255].

Parameters:

frame (np.array) – Frame with the hot pixels present.

Returns:

Image after normalization, thresholding and scaling.

Return type:

np.array

AllSkyCam4OLEODL.image_processing.frame_draw(frame: array, time: str, exposure: float, rad: int, max_bright_loc: Tuple, max_bright_val: float, int_bright_val: float, mean_bright_grid_val: uint32, max_bright_grid_val: uint32, int_bright_grid_val: float64, min_size: int, max_size: int, elevation: float, azimuth: float) → None

Draws the overlays on top of the frame:

Parameters:

• frame (np.array) – Frame where the overlays will be drawn.

• time (str) – Actual time in that particular frame.

• exposure (float) – Exposure time used for that particular frame.

• rad (int) – Radius of the intensity grid.

• max_bright_loc (tuple) – Location of the brightest point: [0] = x-axis, [1] = y-axis.

• max_bright_val (float) – Pixel value of the brightest point [0-255].

• int_bright_val (float) – Intensity value of the brightest point.

• mean_bright_grid_val (np.uint32) – Mean pixel value of the whole brightest contour.

• max_bright_grid_val (np.uint32) – Summed pixel value of the whole brightest contour.

• int_bright_grid_val (np.float64) – Summed intensity value of the whole brightest contour.

• min_size (int) – Minimum spot size value used.

• max_size (int) – Maximum spot size value used.

• elevation (float) – Elevation of the brightest point.

• azimuth (float) – Azimuth of the brightest point.

AllSkyCam4OLEODL.image_processing.frame_processing(self, cam, frame) → None

Procceses the frame.

1. Grabs a temporal frame.

2. Depending on the selected mode by the user:

• Hot-pixel removal.

  A frame with the hot pixels will threshold and normalized by the dark_frame_setup() fuction and then subtracted to the the taken frame with the subtract_frames() function.

• Own background correction.

  Substracts the temporal frame to the next grabbed frame. The subtract_frames() fuction is applied for substracting the temporal frame, just grabbed, with the next frame.

• Normal operation.

  The temporal frame will be used directly.

• Camera’s own background correction.

  The temporal frame will be used directly.

3. Obtains the brightest point thanks to the brightest_V2() function.

4. Obtains the elevation and azimuth of the brightest pixel with the calculate_el_azi() fuction.

5. Draws all the desired values on top of the frame using the frame_draw() fuction.

6. Just in case the Record mode is being used, both the processed and unprocessed frames, besides the csv file, will all be saved.

7- Finally the frames will be display and the first temporal frame will be removed.

Parameters:

• self (Instance) – Current instance, provides access to attributes and methods.

• cam (Camera) – Camera object from the VMBPY API module.

• frame (Frame) – Frame object from the VMBPY API module.

AllSkyCam4OLEODL.image_processing.subtract_frames(frame: array, frame_substracted: array) → array

Subtracts one frame from another using OpenCV:

1. Checks if both frames have the same dimensions and format.

2. Substracts both of the frames.

Parameters:

• frame (np.array) – Original frame.

• frame_substracted (np.array) – Frame to substract.

Returns:

Image obtained after frame subtraction.

Return type:

np.array

AllSkyCam4OLEODL.image_processing.write_csv(self, frame_mean_pixel_value: int, frame_number: str, time: str, exposure: float, r: float, elevation: float, azimuth: float, fov: float, location: Tuple, pvalue: float, pvalue_grid: uint32, intensity: float, intensity_grid: float64) → None

Writes a csv file with all the parameters needed to perform the analysis of the final satellite pass:

1. Creates the dictionaries and fields.

2. Writes the csv file.

Parameters:

• self (Instance) – Parsed instance from Handler in the api module, provides access to attributes and methods.

• frame_mean_pixel_value (int) – Mean Pixel Value of the entire frame.

• frame_number (str) – Frame number.

• time (str) – Current time where the frame as been recorded.

• exposure (float) – Exposure time used for that particular frame.

• r (float) – Radial position of the brightest point.

• elevation (float) – Elevation of the brightest point

• azimuth (float) – Azimuth of the brightest point.

• fov (float) – Field Of View of the camera, in degrees, at the brightest point

• location (tuple) – Location of the brightest point: [0] = x-axis, [1] = y-axis.

• pvalue (float) – Pixel Value of the brightest point [0-255].

• pvalue_grid (np.uint32) – Pixel Value of the whole brightest contour.

• intensity (float) – Intensity value of the brightest point.

• intensity_grid (np.float64) – Intensity value of the whole brightest contour.

AllSkyCam4OLEODL.input_checks module

This modules manages the checking and validation of the user inputs.

AllSkyCam4OLEODL.input_checks.checks(elevation_in, elevation_angle_in, exposure_in, exposure_time_in, zenith, h_ogs) → Tuple[int, int, float, int]

Based on the selected values in the GUI it preapres the exposure, elevation and zenith attenuation we will finally use.

1. If manual exposure mode is selected, retrieves the exposure time, ensuring that the value is non-negative.

2. If individual elevation mode is selected, retrieves the elevation angle, ensuring that the selected value is between 0 and 90 degrees of elevation.

3. Selects the value of the atmospheric zenith attenuation.

Parameters:

• elevation_in (tk.StringVar) – Container of the chosen elevation mode.

• elevation_angle_in (tk.StringVar) – Container of the chosen elevation angle (if manual).

• exposure_in (tk.StringVar) – Container of the chosen exposure mode.

• exposure_time_in (tk.StringVar) – Container of the chosen exposure value (if manual).

• zenith (tk.StringVar) – Container of the atmospheric zenith attenuation.

• h_ogs (tk.StringVar) – Container of the height of the OGS used.

Raises:

• ValueError – Exposure time value is a lower than zero.

• ValueError – Elevation angle is lower than 0 or bigger than 90.

Returns:

elevation_angle (int): Final selected elevation angle (if individual).

exposure_time_value (int): Final selected exposure value (if manual).

zenith (float): Final selected zenith attenuation value.

h_ogs (int): Final height of the selected OGS.

Return type:

tuple[int, int, float, int]

AllSkyCam4OLEODL.input_checks.get_value_list(elevation, intensity, value)

If value is present in elevation it get the coorespondent value of intensity.

Parameters:

• elevation (np.ndarray) – Elevation of the satellite.

• intensity (np.ndarray) – Intensity onto OGS-apertue inc. losses.

• value (_type_) – _description_

Returns:

Intensity obtained from the link budget with value.

Return type:

numpy.float64

AllSkyCam4OLEODL.link_budget module

This modules manages the creation and display of the link budget.

AllSkyCam4OLEODL.link_budget.link_budget(elevation_mode, el: int, payload, zenith: float, h_ogs: int) → None

Performs the link budget based on the parameters from the GUI:

1. Selects specific parameters based on the payload chosen.

2. Specifies the losses.

3. Calculates antennas dimensions.

4. If the elevation mode is “Full”, the elevation angle will be converted to an array from 0 to 90 degrees.

5. The rest of the parameters dependent on the elevation are calculated based on if the elevation is just a point or the full range.

6. Computes the final received power at the receiver.

7. Calculates the intensity onto the receiver using its area.

Parameters:

• elevation_mode (tk.StringVar) – Container of the elevation mode.

• el (int) – Elevation angle.

• payload (tk.StringVar) – Container of the payload used.

• zenith (float) – Final selected zenith attenuation value.

• h_ogs (int) – Final height of the selected OGS.

Returns:

el (np.ndarray | int): Elevation of the satellite. int_ogs_lin_loss (np.ndarray | float): Intensity onto OGS-apertue inc. losses.

Return type:

tuple

AllSkyCam4OLEODL.link_budget.printer_lb(el: ndarray | int, elevation_mode, sat, a_tx: int, p_tx: int, ppb: int, teta_tx: float, a_rx: int, leng: ndarray | float, g_tx: float, a_fsl: ndarray | float, i_axial: ndarray | float, area_rx: float, a_atm: ndarray | float, a_bw: int, g_rx: float, p_rx: ndarray | float, int_ogs_lin: ndarray | float, int_ogs_lin_loss: ndarray | float, p_ogs_mean: ndarray | float, p_ogs_mean_loss: ndarray | float, p_rx_lin: ndarray | float, wl: float, p_rfe_lin: float, a_sci: int) → Tuple[ndarray | int, ndarray | float]

Prints the graph or the results and summary of the link budget.

1. If the elevation mode is “Full” it will just print the graph, if not it will print the result of the link budget.

Parameters:

• el (np.ndarray | int) – Elevation of the satellite

• elevation_mode (tk.StringVar) – Container of the elevation mode.

• sat (tk.StringVar) – Container of the payload used.

• a_tx (int) – Transmitter optical loss.

• p_tx (int) – Transmitter power.

• ppb (int) – Photons/bit.

• teta_tx (float) – Transmitter divergence.

• a_rx (int) – Receiver optical loss onto RFE.

• leng (np.ndarray | float) – Length of the link.

• g_tx (float) – Transmitter antenna gain.

• a_fsl (np.ndarray | float) – Free-space loss.

• i_axial (np.ndarray | float) – Axial intensity at OGS-distance.

• area_rx (float) – Receiver antenna area.

• a_atm (np.ndarray | float) – Atmospheric attenuation loss.

• a_bw (int) – Mean BeamWander loss.

• g_rx (float) – Reveiver antenna gain.

• p_rx (np.ndarray | float) – Received power.

• int_ogs_lin (np.ndarray | float) – Intensity onto OGS-apertue exc. losses.

• int_ogs_lin_loss (np.ndarray | float) – Intensity onto OGS-apertue inc. losses.

• p_ogs_mean (np.ndarray | float) – Power into the OGS-apertue - no additional RX-losses.

• p_ogs_mean_loss (np.ndarray | float) – Power into the OGS-apertue including RX-losses.

• p_rx_lin (np.ndarray | float) – RxPower onto RFE-detector incl all losses.

• wl (float) – Wavelength.

• p_rfe_lin (float) – RFE-sensitivity for an specific Photons/bit.

• a_sci (int) – Scintillation loss.

AllSkyCam4OLEODL.printer module

This script manages all the printing functions needed to display the results correctly.

AllSkyCam4OLEODL.printer.print_end_stream() → None

Printing fuction - prints the end of the stream.

AllSkyCam4OLEODL.printer.print_preamble() → None

Printing fuction - prints program preamble.

AllSkyCam4OLEODL.printer.print_preamble_settings() → None

Printing fuction - prints settings preamble.

AllSkyCam4OLEODL.printer.print_start_stream() → None

Printing fuction - prints the start of the stream.

AllSkyCam4OLEODL.printer.print_usage() → None

Printing fuction - prints the usage.

Main.py

Main fuction of the project where everything is called.

Python version: 3.12.2. Numpy version: 2.0.0. Scipy version: 1.14.0. Matplotlib version: 3.9.1. Mplcursors version: 0.5.3. Tkinter version: 0.1.0. Pytz version: 2024.1. OpenCV version: 4.10.0.84.

Author:

Iker Aldasoro - 19.04.2024

main.main()