simplified_radiosity_algorithm/helper/helper.py

"""
Helper class for SRA
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
"""

import pandas as pd
import numpy as np
import calendar as cal
import helpers.constants as cte


class Helper:
  def __init__(self):
    self._month_hour = None

  @property
  def month_hour(self):
    """
    returns a DataFrame that has x values of the month number (January = 1, February = 2...),
    being x the number of hours of the corresponding month
    :return: DataFrame(int)
    """
    array = []
    for i in range(0, 12):
      days_of_month = cal.monthrange(2015, i+1)
      total_hours = days_of_month * 24
      array = np.concatenate((array, np.full(total_hours, i + 1)))
    self._month_hour = pd.DataFrame(array, columns=cte.MONTH)
    return self._month_hour

  def get_mean_values(self, values):
    out = None
    if values is not None:
      if cte.MONTH not in values.columns:
        values = pd.concat([self.month_hour, pd.DataFrame(values)], axis=1)
      out = values.groupby(cte.MONTH, as_index=False).mean()
      del out[cte.MONTH]
    return out