Documentation, cleanup

This commit is contained in:
2024-01-17 20:53:18 +01:00
parent e1b464e36c
commit 17348f7acf
9 changed files with 165 additions and 75 deletions

View File

@@ -1,6 +1,8 @@
import math
class Time_Bar_Chart:
""" Class to handle the creation of the day time period bar
"""
def __init__(self) -> None:
self.image_code = []
@@ -21,9 +23,10 @@ class Time_Bar_Chart:
def create_bar_chart_with_polylines(self, save_location: str, image_width: int, image_height: int, times: list):
""" Create a time bar chart
""" Create a time bar chart WITH polylines
Args:
save_location (str): Absolute path to store
image_width (int): Width of the image in pixel
image_height (int): Height of the image in pixel
times (list): List of start times of the periods in minutes since midnight
@@ -45,6 +48,14 @@ class Time_Bar_Chart:
def create_bar_chart(self, save_location: str, image_width: int, image_height: int, times: list):
""" Create a time bar chart WITHOUT polylines
Args:
save_location (str): Absolute path to store
image_width (int): Width of the image in pixel
image_height (int): Height of the image in pixel
times (list): List of start times of the periods in minutes since midnight
"""
self.create_bar(image_width, image_height, times)
self.create_time_markers(image_width, image_height)