Editing SimTX API v24/Packets/WeatherMapResponse

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = WeatherMapResponse
| id = 14
| hex = 0x0E
| direction = s2c
| session = [[SimTX API v24/Control session|Control]]
| size = Variable
| permission = None
| answers = [[SimTX API v24/Packets/WeatherMapRequest|WeatherMapRequest]]
| group = control
}}
'''WeatherMapResponse''' returns the raster requested by a [[SimTX API v24/Packets/WeatherMapRequest|WeatherMapRequest]], together with a summary of the weather at the centre of the area.

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>14</code>.
|-
| <code>validTimeEpochMillis</code> || <code>i64</code> || Simulated time the data is valid for, Unix milliseconds.
|-
| <code>type</code> || <code>UTF</code> || Map type, as requested.
|-
| <code>southLatitudeDeg</code> || <code>f64</code> || Southern edge.
|-
| <code>northLatitudeDeg</code> || <code>f64</code> || Northern edge.
|-
| <code>westLongitudeDeg</code> || <code>f64</code> || Western edge, normalised to (−180, 180].
|-
| <code>eastLongitudeDeg</code> || <code>f64</code> || Eastern edge, normalised to (−180, 180].
|-
| <code>width</code> || <code>i32</code> || Raster columns.
|-
| <code>height</code> || <code>i32</code> || Raster rows.
|-
| <code>valueCount</code> || <code>i32</code> || Always <code>width × height</code>.
|-
| <code>values</code> || <code>valueCount × f32</code> || Values in the unit of the map type, row by row.
|-
| <code>surfaceTemperatureCelsius</code> || <code>f32</code> || At the centre: surface temperature.
|-
| <code>surfacePressureHpa</code> || <code>f32</code> || At the centre: surface pressure.
|-
| <code>surfaceRelativeHumidityPercent</code> || <code>f32</code> || At the centre: relative humidity.
|-
| <code>surfaceWindMetersPerSecond</code> || <code>f32</code> || At the centre: wind speed.
|-
| <code>maximumRainRateMillimetersPerHour</code> || <code>f32</code> || At the centre: highest rain rate in the column.
|-
| <code>maximumCloudWaterGramsPerCubicMeter</code> || <code>f32</code> || At the centre: highest cloud water content in the column.
|-
| <code>capeJoulesPerKilogram</code> || <code>f32</code> || At the centre: convective available potential energy.
|-
| <code>lightningFlashesPerMinute</code> || <code>f32</code> || At the centre: lightning rate.
|-
| <code>ductType</code> || <code>UTF</code> || Type of the strongest duct at the centre, or <code>NONE</code>.
|-
| <code>ductBaseMeters</code> || <code>f32</code> || Duct base height. NaN when there is no duct.
|-
| <code>ductTopMeters</code> || <code>f32</code> || Duct top height. NaN when there is no duct.
|-
| <code>ductStrengthMUnits</code> || <code>f32</code> || Duct strength. 0 when there is no duct.
|-
| <code>ductGradientMUnitsPerKilometer</code> || <code>f32</code> || Steepest modified-refractivity gradient in the duct. NaN when there is no duct.
|}

== Raster layout ==
Values are stored row-major (<code>index = row × width + column</code>). Unlike the coverage map, they are sampled at grid '''nodes''' that include the edges of the area:

<syntaxhighlight lang="text">
latitude  = north − (north − south) × row    / (height − 1)
longitude = west  + (east  − west ) × column / (width  − 1)
</syntaxhighlight>

Row 0 is the northern edge and the last row the southern edge; columns run west to east. North and south are clamped to ±90°. When the area crosses the antimeridian, <code>westLongitudeDeg</code> is greater than <code>eastLongitudeDeg</code>; add 360° to the eastern edge before interpolating. For a 360° span the two edges are equal.

Raster values are always finite. The summary fields may contain NaN as described above.

{{SimTX API v24 navbox}}
[[Category:SimTX API v24]]