Consider-none-equivalent-value-for-missing-data-pints-in-weather

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Instantiation of Heat Pump Agents [#253](https://github.com/ie3-institute/simona/issues/253)
 - Output of accompanying thermal result models
 - Added JDK installation, Scala Plugin + SDK in usersguide [#324](https://github.com/ie3-institute/simona/issues/324)
+- Added an interpolation for missing weather data [#188](https://github.com/ie3-institute/simona/issues/188)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)

src/main/scala/edu/ie3/simona/ontology/messages/services/WeatherMessage.scala

@@ -6,6 +6,7 @@
 
 package edu.ie3.simona.ontology.messages.services
 
+import edu.ie3.datamodel.models.value.WeatherValue
 import edu.ie3.simona.agent.participant.data.Data.SecondaryData
 import edu.ie3.simona.ontology.messages.services.ServiceMessage.{
   ProvisionMessage,
@@ -75,4 +76,17 @@ object WeatherMessage {
       windVel: Velocity
   ) extends SecondaryData
 
+  /** Container class for a weather value with a weight. It is primarily used
+    * for interpolation.
+    * @param value
+    *   weather value
+    * @param weight
+    *   of the value
+    * @tparam V
+    *   type of value
+    */
+  final case class ValueWithWeight[V](
+      value: V,
+      weight: Long
+  )
 }

src/main/scala/edu/ie3/simona/service/weather/WeatherSource.scala

@@ -6,7 +6,9 @@
 
 package edu.ie3.simona.service.weather
 
+import edu.ie3.datamodel.io.connectors.SqlConnector
+import com.typesafe.scalalogging.LazyLogging
 import edu.ie3.datamodel.io.connectors.SqlConnector
 import edu.ie3.datamodel.io.factory.timeseries.{
   CosmoIdCoordinateFactory,
   IconIdCoordinateFactory,
@@ -17,6 +19,7 @@
 import edu.ie3.datamodel.io.source.IdCoordinateSource
 import edu.ie3.datamodel.io.source.csv.{CsvDataSource, CsvIdCoordinateSource}
 import edu.ie3.datamodel.io.source.sql.SqlIdCoordinateSource
+import edu.ie3.datamodel.models.timeseries.individual.IndividualTimeSeries
 import edu.ie3.datamodel.models.value.WeatherValue
 import edu.ie3.simona.config.SimonaConfig
 import edu.ie3.simona.config.SimonaConfig.BaseCsvParams
@@ -30,6 +33,7 @@
   AgentCoordinates,
   WeightedCoordinates
 }
+import edu.ie3.simona.service.weather.WeatherValueInterpolation.interpolate
 import edu.ie3.simona.util.ConfigUtil.CsvConfigUtil.checkBaseCsvParams
 import edu.ie3.simona.util.ConfigUtil.DatabaseConfigUtil.{
   checkCouchbaseParams,
@@ -41,9 +45,14 @@
 import edu.ie3.util.quantities.PowerSystemUnits
 import edu.ie3.util.scala.quantities.WattsPerSquareMeter
 import org.locationtech.jts.geom.{Coordinate, Point}
+import edu.ie3.util.scala.quantities.QuantitySquantsConversions._
+import edu.ie3.util.scala.quantities.{Irradiance, WattsPerSquareMeter}
+import org.locationtech.jts.geom.{Coordinate, Point}
 import squants.motion.MetersPerSecond
 import squants.thermal.Kelvin
 import tech.units.indriya.ComparableQuantity
+import squants.{Temperature, Velocity}
+import tech.units.indriya.ComparableQuantity
 import tech.units.indriya.quantity.Quantities
 import tech.units.indriya.unit.Units
 
@@ -290,7 +299,7 @@
   ): Array[Long]
 }
 
-object WeatherSource {
+object WeatherSource extends LazyLogging {
 
   def apply(
       dataSourceConfig: SimonaConfig.Simona.Input.Weather.Datasource,
@@ -550,52 +559,66 @@
     MetersPerSecond(0d)
   )
 
-  def toWeatherData(
-      weatherValue: WeatherValue
+  /** Methode to get weather data from a time series. This method automatically
+    * interpolates missing values.
+    *
+    * @param timeSeries
+    *   with weather values
+    * @param dateTime
+    *   timestamp in question
+    * @return
+    *   weather data object
+    */
+  def getWeatherData(
+      timeSeries: IndividualTimeSeries[WeatherValue],
+      dateTime: ZonedDateTime
   ): WeatherData = {
+    // gets a value option
+    val valueOption = timeSeries.getValue(dateTime).toScala
+
+    // check which data is missing
+    val (diffIrr, dirIrr, temp, windVel) = getOptions(valueOption)
+
     WeatherData(
-      weatherValue.getSolarIrradiance.getDiffuseIrradiance.toScala match {
-        case Some(irradiance) =>
-          WattsPerSquareMeter(
-            irradiance
-              .to(PowerSystemUnits.WATT_PER_SQUAREMETRE)
-              .getValue
-              .doubleValue()
-          )
-        case None => EMPTY_WEATHER_DATA.diffIrr
-      },
-      weatherValue.getSolarIrradiance.getDirectIrradiance.toScala match {
-        case Some(irradiance) =>
-          WattsPerSquareMeter(
-            irradiance
-              .to(PowerSystemUnits.WATT_PER_SQUAREMETRE)
-              .getValue
-              .doubleValue()
-          )
-        case None => EMPTY_WEATHER_DATA.dirIrr
-      },
-      weatherValue.getTemperature.getTemperature.toScala match {
-        case Some(temperature) =>
-          Kelvin(
-            temperature
-              .to(Units.KELVIN)
-              .getValue
-              .doubleValue()
-          )
-        case None => EMPTY_WEATHER_DATA.temp
-      },
-      weatherValue.getWind.getVelocity.toScala match {
-        case Some(windVel) =>
-          MetersPerSecond(
-            windVel
-              .to(Units.METRE_PER_SECOND)
-              .getValue
-              .doubleValue()
-          )
-        case None => EMPTY_WEATHER_DATA.windVel
-      }
+      diffIrr.getOrElse(
+        interpolate(timeSeries, dateTime, "diffIrr", EMPTY_WEATHER_DATA.diffIrr)
+      ),
+      dirIrr.getOrElse(
+        interpolate(timeSeries, dateTime, "dirIrr", EMPTY_WEATHER_DATA.dirIrr)
+      ),
+      temp.getOrElse(
+        interpolate(timeSeries, dateTime, "temp", EMPTY_WEATHER_DATA.temp)
+      ),
+      windVel.getOrElse(
+        interpolate(timeSeries, dateTime, "windVel", EMPTY_WEATHER_DATA.windVel)
+      )
     )
+  }
 
+  /** Method to get the data of a [[WeatherValue]].
+    *
+    * @param valueOption
+    *   value with data
+    * @return
+    *   a tuple of options
+    */
+  def getOptions(valueOption: Option[WeatherValue]): (
+      Option[Irradiance],
+      Option[Irradiance],
+      Option[Temperature],
+      Option[Velocity]
+  ) = {
+    valueOption match {
+      case Some(value) =>
+        val solar = value.getSolarIrradiance
+        (
+          solar.getDiffuseIrradiance.toScala.map(v => v.toSquants),
+          solar.getDirectIrradiance.toScala.map(v => v.toSquants),
+          value.getTemperature.getTemperature.toScala.map(v => v.toSquants),
+          value.getWind.getVelocity.toScala.map(v => v.toSquants)
+        )
+      case None => (None, None, None, None)
+    }
   }
 
   /** Weather package private case class to combine the provided agent

src/main/scala/edu/ie3/simona/service/weather/WeatherSourceWrapper.scala

@@ -36,7 +36,7 @@ import edu.ie3.simona.ontology.messages.services.WeatherMessage.WeatherData
 import edu.ie3.simona.service.weather.WeatherSource.{
   EMPTY_WEATHER_DATA,
   WeatherScheme,
-  toWeatherData
+  getWeatherData
 }
 import edu.ie3.simona.service.weather.WeatherSourceWrapper.WeightSum
 import edu.ie3.simona.service.weather.{WeatherSource => SimonaWeatherSource}
@@ -49,9 +49,7 @@ import tech.units.indriya.ComparableQuantity
 import java.nio.file.Path
 import java.time.ZonedDateTime
 import javax.measure.quantity.Length
-
 import scala.jdk.CollectionConverters.{IterableHasAsJava, MapHasAsScala}
-import scala.jdk.OptionConverters.RichOptional
 import scala.util.{Failure, Success, Try}
 
 /** This class provides an implementation of the SIMONA trait
@@ -102,12 +100,10 @@ private[weather] final case class WeatherSourceWrapper private (
       )
       .asScala
       .toMap
-    val weatherDataMap = results.flatMap { case (point, timeSeries) =>
+    val weatherDataMap = results.map { case (point, timeSeries) =>
       // change temperature scale for the upcoming calculations
-      timeSeries
-        .getValue(dateTime)
-        .toScala
-        .map(weatherValue => point -> toWeatherData(weatherValue))
+
+      point -> getWeatherData(timeSeries, dateTime)
     }
 
     weatherDataMap.foldLeft((EMPTY_WEATHER_DATA, WeightSum.EMPTY_WEIGHT_SUM)) {