Module:Weather/sandbox: Difference between revisions

Browse history interactively

← Previous edit Next edit →

Content deleted Content added

Inline

Revision as of 02:51, 21 September 2016

This is the module sandbox page for Module:Weather (diff).

Module documentation[view] [edit] [history] [purge]

This module can be used to display temperatures in a table. It is under development and is intended to be efficient so a page can hold many tables.

Input numbers must use a hyphen if negative (Unicode minus "−" would give an error).
All displayed numbers (including inputs) use Unicode minus if negative.
The input consists of 13 values, separated by any number of spaces.
Each of the 13 values must be a number. Any invalid value results in the corresponding cell being blank with no error message or tracking category.

The following functions are available:

Function	Input	Output
`CtoF`	°C	°C (°F)
`FfromC`	°C	°F (°C)
`CfromF`	°F	°C (°F)
`FtoC`	°F	°F (°C)

The following templates use the module:

An example using the above templates and the module is at:

sandbox permalink

The output can be examined by entering the following example at Special:ExpandTemplates. The output from each of the following lines is identical.

{{#invoke:weather|CtoF|-10 -5 0 5 10 15 20 25 30 35 40 45 50}}
----
{{#invoke:weather|CfromF|14 23 32 41 50 59 68 77 86 95 104 113 122}}

Optional parameter

|palette=name
Where name is the built-in name of a palette:
cool (default)

cool2 (modified)

cool2avg (modified and intended for average temperatures)

Testing

The function show provides a way to test the color schemes. It generates a graph of how the red, green, and blue portions of the color vary with temperature, and a table of the full range of temperatures in °C.

Optional parameters

Two unnamed parameters may be entered to specify the first and last Celsius temperatures (|-90|59 by default).
The palette can be specified with |palette=name as above.

The following codes produce the same result:

{{#invoke:weather|show}}
{{#invoke:weather|show|palette=cool}}

−90	−89	−88	−87	−86	−85	−84	−83	−82	−81
−80	−79	−78	−77	−76	−75	−74	−73	−72	−71
−70	−69	−68	−67	−66	−65	−64	−63	−62	−61
−60	−59	−58	−57	−56	−55	−54	−53	−52	−51
−50	−49	−48	−47	−46	−45	−44	−43	−42	−41
−40	−39	−38	−37	−36	−35	−34	−33	−32	−31
−30	−29	−28	−27	−26	−25	−24	−23	−22	−21
−20	−19	−18	−17	−16	−15	−14	−13	−12	−11
−10	−9	−8	−7	−6	−5	−4	−3	−2	−1
0	1	2	3	4	5	6	7	8	9
10	11	12	13	14	15	16	17	18	19
20	21	22	23	24	25	26	27	28	29
30	31	32	33	34	35	36	37	38	39
40	41	42	43	44	45	46	47	48	49
50	51	52	53	54	55	56	57	58	59

Modified palette:

{{#invoke:weather|show|palette=cool2}}

−90	−89	−88	−87	−86	−85	−84	−83	−82	−81
−80	−79	−78	−77	−76	−75	−74	−73	−72	−71
−70	−69	−68	−67	−66	−65	−64	−63	−62	−61
−60	−59	−58	−57	−56	−55	−54	−53	−52	−51
−50	−49	−48	−47	−46	−45	−44	−43	−42	−41
−40	−39	−38	−37	−36	−35	−34	−33	−32	−31
−30	−29	−28	−27	−26	−25	−24	−23	−22	−21
−20	−19	−18	−17	−16	−15	−14	−13	−12	−11
−10	−9	−8	−7	−6	−5	−4	−3	−2	−1
0	1	2	3	4	5	6	7	8	9
10	11	12	13	14	15	16	17	18	19
20	21	22	23	24	25	26	27	28	29
30	31	32	33	34	35	36	37	38	39
40	41	42	43	44	45	46	47	48	49
50	51	52	53	54	55	56	57	58	59

This modified palette is intended for average temperatures. It results in good colors between the extreme highest average monthly temperature of +39 °C (102 °F) in Death Valley, California, and −68 °C (−90 °F), the extreme lowest average monthly temperature at Vostok Station, at a high elevation on the Antarctic ice sheet. These are the highest and lowest known average temperatures recorded on Earth, not to be confused with the highest and lowest records, which are quite a bit hotter and colder.

{{#invoke:weather|show|palette=cool2avg}}

−90	−89	−88	−87	−86	−85	−84	−83	−82	−81
−80	−79	−78	−77	−76	−75	−74	−73	−72	−71
−70	−69	−68	−67	−66	−65	−64	−63	−62	−61
−60	−59	−58	−57	−56	−55	−54	−53	−52	−51
−50	−49	−48	−47	−46	−45	−44	−43	−42	−41
−40	−39	−38	−37	−36	−35	−34	−33	−32	−31
−30	−29	−28	−27	−26	−25	−24	−23	−22	−21
−20	−19	−18	−17	−16	−15	−14	−13	−12	−11
−10	−9	−8	−7	−6	−5	−4	−3	−2	−1
0	1	2	3	4	5	6	7	8	9
10	11	12	13	14	15	16	17	18	19
20	21	22	23	24	25	26	27	28	29
30	31	32	33	34	35	36	37	38	39
40	41	42	43	44	45	46	47	48	49
50	51	52	53	54	55	56	57	58	59

The above documentation is transcluded from Module:Weather/sandbox/doc.
Editors can experiment in this module's sandbox and testcases pages.
Subpages of this module.

-- Efficient (fast) functions to implement cells in tables of weather data.
-- Temperature conversion is built-in, but for simplicity, temperatures
-- are assumed to be for habitable locations (from -100 to 100 °C).

local MINUS = '−'  -- Unicode U+2212 MINUS SIGN

local function temperature_color(palette, value, out_rgb)
	-- Return style for a table cell based on the given value which
	-- should be a temperature in °C.
    
	if type(value) ~= 'number' then
		local background_color, text_color = 'FFF', '000'
	else
	    local min, max = unpack(palette.white or { -23, 35 })
	    if value < min or value >= max then
		    text_color = 'FFF'
	    else
		    text_color = '' -- This should display as black; that will likely be the default for most people.
	    end
	    
	    local background_rgb = out_rgb or {}
	    for i, v in ipairs(palette) do
		    local a, b, c, d = unpack(v)
		    if value <= a then
			    background_rgb[i] = 0
		    elseif value < b then
			    background_rgb[i] = (value - a) * 255 / (b - a)
		    elseif value <= c then
			    background_rgb[i] = 255
		    elseif value < d then
			    background_rgb[i] = 255 - ( (value - c) * 255 / (d - c) )
		    else
			    background_rgb[i] = 0
		    end
	    end
	    background_color = string.format('%02X%02X%02X', background_rgb[1], background_rgb[2], background_rgb[3])
	    
	end
	if text_color ~= "" then
	    return background_color, text_color
	else
	    return background_color
	end
end


local function color_CSS(background_color, text_color)
    if background_color and text_color then
        return 'background: #' .. background_color .. '; color: #' .. text_color .. ';'
    elseif background_color then
        return 'background: #' .. background_color .. ';'
    else
        return ''
    end
end

local function temperature_color_CSS(palette, value, out_rgb)
    return color_CSS(temperature_color(palette, value, out_rgb))
end

local function style_attribute(palette, value, out_rgb)
    local font_size = "font-size: 85%;"
    local color = temperature_color_CSS(palette, value, out_rgb)
    return 'style=\"' .. color .. ' ' .. font_size .. '\"'
end

local function temperature_style (frame)
    local palette = palettes[frame.args.palette] or palettes.cool
    local unit = frame.args.unit or 'C'
    local value
    if unit == 'C' then
        value = tonumber(frame.args[1])
    elseif unit == 'F' then
        value = (tonumber(frame.args[1]) - 32) * (5/9)
    else
        error('Unit ' .. unit .. ' not recognized. Please choose C for Celsius or F for Fahrenheit.')
    end
    
    return style_attribute(palette, value)
end

local function format_cell(palette, value, intext, outtext)
	-- Return one line of wikitext to make a cell in a table.
	if not value then
		return '|\n'
	end
	local text
	if outtext then
		text = intext .. '<br>(' .. outtext .. ')'
	else
		text = intext
	end
	
	return '| ' .. style_attribute(palette, value) .. ' | ' .. text .. '\n'
end

local function process_temperature(intext, inunit, swap)
	-- Convert °C to °F or vice versa, assuming the temperature is for a
	-- habitable location, well inside the range -100 to 100 °C.
	-- That simplifies determining precision and formatting (no commas are needed).
	-- Return (celsius_value, intext, outtext) if valid; otherwise return nil.
	-- The returned input and output are swapped if requested.
	-- Each returned string has a Unicode MINUS as sign, if negative.
	local invalue = tonumber(intext)
	if not invalue then return nil end
	local integer, dot, decimals = intext:match('^%s*%-?(%d+)(%.?)(%d*)%s*$')
	if not integer then return nil end
	if invalue < 0 then
		intext = MINUS .. integer .. dot .. decimals
	end
	local outtext
	if inunit == 'C' or inunit == 'F' then
		local celsius_value, outvalue
		if inunit == 'C' then
			outvalue = invalue * (9/5) + 32
			celsius_value = invalue
		else
			outvalue = (invalue - 32) * (5/9)
			celsius_value = outvalue
		end
		local precision = dot == '' and 0 or #decimals
		outtext = string.format('%.' .. precision .. 'f', math.abs(outvalue) + 2e-14)
		if outvalue < 0 and tonumber(outtext) ~= 0 then
			-- Don't show minus if result is negative but rounds to zero.
			outtext = MINUS .. outtext
		end
		if swap then
			return celsius_value, outtext, intext
		end
		return celsius_value, intext, outtext
	end
	-- LATER Think about whether a no-conversion option would be useful.
	return invalue, intext, outtext
end

local function temperature_row(palette, row, inunit, swap)
	-- Return 13 lines specifying the style/content of 13 table cells.
	-- Input is 13 space-separated words, each a number (°C or °F).
	-- Any word that is not a number gives a blank cell ("M" for a missing cell).
	-- Any excess words are ignored.
	--
	-- Function  Input   Output
	-- ------------------------
	-- CtoF        C       C/F
	-- FfromC      C       F/C
	-- CfromF      F       C/F
	-- FtoC        F       F/C
	local nrcol = 13
	local results, n = {}, 0
	for word in row:gmatch('%S+') do
		n = n + 1
		if n > nrcol then
			break
		end
		results[n] = format_cell(palette, process_temperature(word, inunit, swap))
	end
	for i = n + 1, nrcol do
		results[i] = format_cell()
	end
	return table.concat(results)
end

palettes = {
	-- A background color entry in a palette is a table of four numbers,
	-- say { 11, 22, 33, 44 } (values in °C).
	-- That means the color is 0 below 11 and above 44, and is 255 from 22 to 33.
	-- The color rises from 0 to 255 between 11 and 22, and falls between 33 and 44.
	cool = {
		{ -42.75,   4.47, 41.5, 60   },
		{ -42.75,   4.47,  4.5, 41.5 },
		{ -90   , -42.78,  4.5, 23   },
		white = { -23.3, 37.8 },
	},
	cool2 = {
		{ -42.75,   4.5 , 41.5, 56   },
		{ -42.75,   4.5 ,  4.5, 41.5 },
		{ -90   , -42.78,  4.5, 23   },
		white = { -23.3, 35 },
	},
	cool2avg = {
		{ -38,   4.5, 25  , 45   },
		{ -38,   4.5,  4.5, 30   },
		{ -70, -38  ,  4.5, 23   },
		white = { -23.3, 25 },
	},
}

local function temperatures(frame, inunit, swap)
	local palette = palettes[frame.args.palette] or palettes.cool
	return temperature_row(palette, frame.args[1], inunit, swap)
end

local function CtoF(frame)
	return temperatures(frame, 'C')
end

local function CfromF(frame)
	return temperatures(frame, 'F', true)
end

local function FtoC(frame)
	return temperatures(frame, 'F')
end

local function FfromC(frame)
	return temperatures(frame, 'C', true)
end

local chart = [[
{{Graph:Chart
|width=600
|height=180
|xAxisTitle=Celsius
|yAxisTitle=__COLOR
|type=line
|x=__XVALUES
|y=__YVALUES
|colors=__COLOR
}}
]]

local function show(frame)
	-- For testing, return wikitext to show graphs of how the red/green/blue colors
	-- vary with temperature, and a table of the resulting colors.
	local function collection()
		-- Return a table to hold items.
		return {
			n = 0,
			add = function (self, item)
				self.n = self.n + 1
				self[self.n] = item
			end,
			join = function (self, sep)
				return table.concat(self, sep)
			end,
		}
	end
	local function make_chart(result, color, xvalues, yvalues)
		result:add('\n')
		result:add(frame:preprocess((chart:gsub('__[A-Z]+', {
			__COLOR = color,
			__XVALUES = xvalues:join(','),
			__YVALUES = yvalues:join(','),
		}))))
	end
	local function with_minus(value)
		if value < 0 then
			return MINUS .. tostring(-value)
		end
		return tostring(value)
	end
	local args = frame.args
	local first = args[1] or -90
	local last = args[2] or 59
	local palette = palettes[args.palette] or palettes.cool
	local xvals, reds, greens, blues = collection(), collection(), collection(), collection()
	local wikitext = collection()
	wikitext:add('{| class="wikitable"\n|-\n')
	local columns = 0
	for celsius = first, last do
		local background_rgb = {}
		local style = style_attribute(palette, celsius, background_rgb)
		local R = math.floor(background_rgb[1])
		local G = math.floor(background_rgb[2])
		local B = math.floor(background_rgb[3])
		xvals:add(celsius)
		reds:add(R)
		greens:add(G)
		blues:add(B)
		wikitext:add('| ' .. style .. ' | ' .. with_minus(celsius) .. '\n')
		columns = columns + 1
		if columns >= 10 then
			columns = 0
			wikitext:add('|-\n')
		end
	end
	wikitext:add('|}\n')
	make_chart(wikitext, 'Red', xvals, reds)
	make_chart(wikitext, 'Green', xvals, greens)
	make_chart(wikitext, 'Blue', xvals, blues)
	return wikitext:join()
end

return {
	CtoF = CtoF,
	CfromF = CfromF,
	FtoC = FtoC,
	FfromC = FfromC,
	show = show,
	temperature_style = temperature_style
}