Blame view

src/ParamOutputImpl/Plot/StatusPlot/StatusBarDecorator.cc 12.3 KB
fbe3c2bb   Benjamin Renard   First commit
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
/*
 * StatusBarDecorator.cc
 *
 *  Created on: Jan 12, 2015
 *      Author: AKKA
 */

#include "StatusBarDecorator.hh"

#include <iosfwd>
#include <boost/format.hpp>
#include <tuple>

#include "log4cxx/logger.h"
#include "plplot/plplot.h"
#include "plplot/plplotP.h"

#include "boost/exception/all.hpp"

#include "PlotLogger.hh"
#include "TimeAxis.hh"
#include "Page.hh"
#include "Time/TimePlot.hh"
#include "StatusPlot.hh"
#include "ColormapManager.hh"
#include "ParamMgr.hh"
f6eaec4e   Benjamin Renard   Optimize plot ele...
27
#include "PlPlotUtil.hh"
5d98ca3d   Benjamin Renard   Draw intervals in...
28
#include "CommonNode.hh"
fbe3c2bb   Benjamin Renard   First commit
29
30
31
32
33
34
35
36
37

#define BAR_HEIGHT 0.02
#define BAR_SPACE  0.005

namespace plot {

log4cxx::LoggerPtr StatusBarDecorator::_logger(
		log4cxx::Logger::getLogger("AMDA-Kernel.Plot.Time.StatusBarDecorator"));

8c860e4f   Benjamin Renard   Rework for tickpl...
38
StatusBarDecorator::StatusBarDecorator (AMDA::Parameters::ParameterManager& manager, PanelPlotOutput* decoratorPlot) :
fbe3c2bb   Benjamin Renard   First commit
39
40
41
42
		DefaultTimeAxisDecorator(),
		_parameterManager(manager),
		_colorMapIndex(ColormapManager::getInstance()._defaultColorAxis),
		_barPosition(PlotCommon::Position::POS_TOP),
fbe3c2bb   Benjamin Renard   First commit
43
44
45
46
47
48
49
		_decoratorPlot(decoratorPlot){
}

StatusBarDecorator::StatusBarDecorator(const StatusBarDecorator& ref_) :
		DefaultTimeAxisDecorator(ref_), _parameterManager(
				ref_._parameterManager), _barInfoList(
				ref_._barInfoList), _colorMapIndex(ref_._colorMapIndex),
8c860e4f   Benjamin Renard   Rework for tickpl...
50
				_barPosition(ref_._barPosition),
fbe3c2bb   Benjamin Renard   First commit
51
52
53
54
55
56
57
58
				_decoratorPlot(ref_._decoratorPlot) {
}

StatusBarDecorator& StatusBarDecorator::operator=(const StatusBarDecorator& ref_) {
	_parameterManager = ref_._parameterManager;
	_barInfoList = ref_._barInfoList;
	_colorMapIndex = ref_._colorMapIndex;
	_barPosition = ref_._barPosition;
fbe3c2bb   Benjamin Renard   First commit
59
60
61
62
63
64
65
	_decoratorPlot = ref_._decoratorPlot;
	return *this;
}

StatusBarDecorator::~StatusBarDecorator() {
}

8c860e4f   Benjamin Renard   Rework for tickpl...
66
void StatusBarDecorator::updatePlotArea(PanelPlotOutput* pplot_, Axis* axis_, const Bounds& panelBounds_, Bounds& bounds_) {
fbe3c2bb   Benjamin Renard   First commit
67
	//Space for time axis
8c860e4f   Benjamin Renard   Rework for tickpl...
68
	DefaultTimeAxisDecorator::updatePlotArea(pplot_, axis_, panelBounds_, bounds_);
fbe3c2bb   Benjamin Renard   First commit
69
70
71
72
73
74

	LOG4CXX_DEBUG(_logger, "StatusBarDecorator Updating plot area : "<<bounds_.toString());

	TimeAxis* pAxis = (TimeAxis*) axis_;

	// calculate char size for labels:
f6eaec4e   Benjamin Renard   Optimize plot ele...
75
76
	Font legendFont(pAxis->_legend.getFont());
	Font panelFont(pplot_->_panel->getFont());
df45df5e   Benjamin Renard   Introduce AxisLeg...
77
	if (!legendFont.isSet()) {
fbe3c2bb   Benjamin Renard   First commit
78
79
80
		legendFont = panelFont;
	}

df45df5e   Benjamin Renard   Introduce AxisLeg...
81
	PlPlotUtil::setPlFont(legendFont);
f6eaec4e   Benjamin Renard   Optimize plot ele...
82
	CharSize legendSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
fbe3c2bb   Benjamin Renard   First commit
83
84
85
86
87
88
89
90
91
92
93
94
95

	double barSpace = 0;

	// reserve space for all series bar :
	barSpace += ((BAR_HEIGHT + BAR_SPACE + 1.5*legendSize.second) * _barInfoList.size());

	if ((_barPosition == pAxis->_position) && (_barPosition == PlotCommon::POS_BOTTOM))
		//one additional space to not draw the bar too close to the date
		barSpace += legendSize.second;

	// to take into account bar space.
	bounds_._height -= barSpace;

8c860e4f   Benjamin Renard   Rework for tickpl...
96
	if (_decoratorPlot->isStandalone())
fbe3c2bb   Benjamin Renard   First commit
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
		bounds_._height = BAR_SPACE;

	// specific case when axis labels are displayed at bottom of the graph. Needs to update y.
	if (_barPosition == PlotCommon::POS_BOTTOM)
	{
		bounds_._y += barSpace;
	}
}

double StatusBarDecorator::computeStartDateWidth(PanelPlotOutput* pplot_,
		TimeAxis* pAxis_) {
	// not very efficient ...
	long int lTime = static_cast<long int>(pAxis_->getRange().getMin());
	tm * lTimeTm = gmtime(&lTime);
	char lTimeChr[80];

	// Format date.
	size_t datelen =
			strftime(lTimeChr, 80,
					getPlStartTimeFormat(pAxis_->_timeFormat,
							pAxis_->getRange().getMin(),
							pAxis_->getRange().getMax()).c_str(), lTimeTm);
f6eaec4e   Benjamin Renard   Optimize plot ele...
119
120
	PlPlotUtil::setPlFont(pplot_->_panel->getFont());
	CharSize fontSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
fbe3c2bb   Benjamin Renard   First commit
121
122
123
124
125
126
127
128
	return fontSize.first * datelen;
}

void StatusBarDecorator::configure(PanelPlotOutput* pplot_, Axis* axis_, double start_,
		double stop_, std::map<std::string, ParameterData> *pParameterValues) {

	TimeAxis* pTimeAxis = (TimeAxis*) axis_;

8c860e4f   Benjamin Renard   Rework for tickpl...
129
	if (_decoratorPlot->isStandalone())
fbe3c2bb   Benjamin Renard   First commit
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
		pTimeAxis->setOnlyTickmarks(true);

	DefaultTimeAxisDecorator::configure(pplot_,axis_,start_,stop_,pParameterValues);

	LOG4CXX_DEBUG(_logger, "StatusBarDecorator::configure");
	buildBarList();
}

void StatusBarDecorator::draw(PanelPlotOutput* pplot_, Axis* axis_,
		std::shared_ptr<plstream> pls_) {
	DefaultTimeAxisDecorator::draw(pplot_,axis_,pls_);

	// draw a virtual axis for each entry // take into account plot orientation
	TimeAxis* pAxis = (TimeAxis*) axis_;

	// Get plot area viewport.
	Bounds vpBounds;
	PLFLT lXMin, lXMax, lYMin, lYMax;
	pls_->gvpd(lXMin, lXMax, lYMin, lYMax);
	vpBounds._x = lXMin;
	vpBounds._y = lYMin;
	vpBounds._width = lXMax - lXMin;
	vpBounds._height = lYMax - lYMin;

	// get windows
	Bounds winBounds;
	PLFLT xwmin, xwmax, ywmin, ywmax;
	pls_->gvpw(xwmin, xwmax, ywmin, ywmax);
	winBounds._x = xwmin;
	winBounds._y = ywmin;
	winBounds._width = xwmax - xwmin;
	winBounds._height = ywmax - ywmin;

	LOG4CXX_DEBUG(_logger, " viewport :"<<vpBounds.toString());
	LOG4CXX_DEBUG(_logger, " window :"<<winBounds.toString());

	// set color for drawing axis :
	Color lInitialColor = changeColor(pls_, pAxis->_color,
			pplot_->_panel->_page->_mode);

	// Set font to draw axes.
f6eaec4e   Benjamin Renard   Optimize plot ele...
171
172
	std::vector<Font::Style> panelStyles;
	Font panelFont(pplot_->_panel->getFont());
fbe3c2bb   Benjamin Renard   First commit
173

f6eaec4e   Benjamin Renard   Optimize plot ele...
174
	Font legendFont(pAxis->_legend.getFont());
df45df5e   Benjamin Renard   Introduce AxisLeg...
175
	if (!legendFont.isSet()) {
fbe3c2bb   Benjamin Renard   First commit
176
177
		// font has not been defined for that axis, used default panel font :
		legendFont = panelFont;
fbe3c2bb   Benjamin Renard   First commit
178
	}
f6eaec4e   Benjamin Renard   Optimize plot ele...
179

fbe3c2bb   Benjamin Renard   First commit
180
181

	// viewport translation only along y direction: we translate about n charHeight. So, gets panel character height.
f6eaec4e   Benjamin Renard   Optimize plot ele...
182
183
184
185
186
	PlPlotUtil::setPlFont(panelFont);
	CharSize panelCharSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);

	PlPlotUtil::setPlFont(legendFont);
	CharSize legendCharSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
fbe3c2bb   Benjamin Renard   First commit
187
188
189
190

	double delta = BAR_SPACE;

	//add space for tick if necessary
8c860e4f   Benjamin Renard   Rework for tickpl...
191
	if (pAxis->_visible && pAxis->_showTickMark && !_decoratorPlot->isStandalone() && (pAxis->_tick._position == Tick::TickPosition::OUTWARDS))
fbe3c2bb   Benjamin Renard   First commit
192
193
194
		delta += getVerticalTickLength(pAxis, panelCharSize.second);

	//add space for time axis
df45df5e   Benjamin Renard   Introduce AxisLeg...
195
	if (pAxis->_visible && (_barPosition == pAxis->_position) && pAxis->_showLegend && !pAxis->_legend.isEmpty())
fbe3c2bb   Benjamin Renard   First commit
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
	{
		delta += 3*panelCharSize.second;
	}

	//keep status bar order
	int first = 0;
	int end   = _barInfoList.size();
	int dir   = 1;
	if (_barPosition == PlotCommon::Position::POS_TOP)
	{
		first = _barInfoList.size()-1;
		end   = -1;
		dir   = -1;
	}

	//add status bar
	for (int i = first; i != end; i+=dir)
	{
		LOG4CXX_DEBUG(_logger, "statusbar["<<i<<"]");
		// no generate label
		pls_->slabelfunc(generateNoTimeLabel, NULL);
		// translate viewport :
		if (_barPosition == PlotCommon::Position::POS_BOTTOM)
		{
			pls_->vpor(vpBounds._x, vpBounds._x + vpBounds._width,
					vpBounds._y - delta - 1.5*legendCharSize.second - BAR_HEIGHT,
					vpBounds._y - delta - 1.5*legendCharSize.second);
		}
		else
		{
			pls_->vpor(vpBounds._x, vpBounds._x + vpBounds._width,
				vpBounds._y + vpBounds._height + delta ,
				vpBounds._y + vpBounds._height + delta + BAR_HEIGHT);
		}
		// sets windows for new viewport :
		pls_->wind(winBounds._x, winBounds._x + winBounds._width, 0,
				1);

		ParamInfoSPtr paramInfo = _barInfoList[i]._paramInfoSPtr;

		//Working list of pair used to build the legend
5d98ca3d   Benjamin Renard   Draw intervals in...
237
		std::vector<std::pair<Color,std::string>> legend;
fbe3c2bb   Benjamin Renard   First commit
238
239
240
241
242
243

		//legend configuration
		if ((paramInfo != nullptr) && !paramInfo->getStatusDef().empty())
		{
			for (int s = 0 ; s < (int)paramInfo->getStatusDef().size(); ++s)
			{
5d98ca3d   Benjamin Renard   Draw intervals in...
244
245
246
247
248
249
250
251
252
				std::string colorStr = paramInfo->getStatusDef()[s].getColor();
				Color color;
				if (!colorStr.empty()) {
					createColor(color, colorStr);
				}
				else {
					color = Color(_colorMapIndex, s);
				}
				legend.push_back(std::make_pair(color,paramInfo->getStatusDef()[s].getName()));
fbe3c2bb   Benjamin Renard   First commit
253
254
255
			}
		}

5d98ca3d   Benjamin Renard   Draw intervals in...
256
257
258
259
260
261
262
263

		//set color map
		pls_->spal1(
			ColormapManager::getInstance().getColorAxis(_colorMapIndex).c_str(), true);

		Color lInitialColor;
		pls_->gcol0(0, lInitialColor._red, lInitialColor._green, lInitialColor._blue);

fbe3c2bb   Benjamin Renard   First commit
264
		//Draw Status data
5d98ca3d   Benjamin Renard   Draw intervals in...
265
		PLFLT x[4], y[4];
fbe3c2bb   Benjamin Renard   First commit
266
267
		for (int t = 0; t < _barInfoList[i]._dataPtr->getSize() - 1;++t)
		{
5d98ca3d   Benjamin Renard   Draw intervals in...
268
269
270
271
272
273
274
275
			x[0] = _barInfoList[i]._dataPtr->getTimes()[t];
			x[1] = _barInfoList[i]._dataPtr->getTimes()[t];
			x[2] = _barInfoList[i]._dataPtr->getTimes()[t+1];
			x[3] = _barInfoList[i]._dataPtr->getTimes()[t+1];
			y[0] = 0.;
			y[1] = 1.;
			y[2] = 1.;
			y[3] = 0.;
fbe3c2bb   Benjamin Renard   First commit
276
277
278

			double paramValue = _barInfoList[i]._dataPtr->getValues(_barInfoList[i]._index)[t];

5d98ca3d   Benjamin Renard   Draw intervals in...
279
280
281
282
			if (isNAN(paramValue)) {
				continue;
			}
			if ((paramInfo != nullptr) && !paramInfo->getStatusDef().empty())
fbe3c2bb   Benjamin Renard   First commit
283
			{
5d98ca3d   Benjamin Renard   Draw intervals in...
284
				for (int s = 0 ; s < (int)paramInfo->getStatusDef().size(); ++s)
fbe3c2bb   Benjamin Renard   First commit
285
				{
5d98ca3d   Benjamin Renard   Draw intervals in...
286
287
					if ((paramValue >= paramInfo->getStatusDef()[s].getMinValue()) &&
						(paramValue <= paramInfo->getStatusDef()[s].getMaxValue()))
fbe3c2bb   Benjamin Renard   First commit
288
					{
5d98ca3d   Benjamin Renard   Draw intervals in...
289
290
291
292
293
294
295
296
297
298
299
300
301
						std::string colorStr = paramInfo->getStatusDef()[s].getColor();
						if (!colorStr.empty()) {
							Color dataValueColor;
							createColor(dataValueColor, colorStr);
							restoreColor(pls_, dataValueColor, pplot_->_panel->_page->_mode);
							pls_->fill(4, x, y);
							pls_->spal1(ColormapManager::getInstance().getColorAxis(_colorMapIndex).c_str(), true);
						}
						else {
							Color dataValueColor(_colorMapIndex, s);
							restoreColor(pls_, dataValueColor, pplot_->_panel->_page->_mode);
							pls_->fill(4, x, y);
							pls_->spal1(ColormapManager::getInstance().getColorAxis(_colorMapIndex).c_str(), true);
fbe3c2bb   Benjamin Renard   First commit
302
						}
5d98ca3d   Benjamin Renard   Draw intervals in...
303
						break;
fbe3c2bb   Benjamin Renard   First commit
304
					}
fbe3c2bb   Benjamin Renard   First commit
305
				}
fbe3c2bb   Benjamin Renard   First commit
306
			}
fbe3c2bb   Benjamin Renard   First commit
307
308
		}

5d98ca3d   Benjamin Renard   Draw intervals in...
309
310
311
312
313
314
315
		//restore to initial color context
		pls_->spal1(
				ColormapManager::getInstance().get(pplot_->_panel->_page->_mode,
				ColormapManager::DEFAULT_COLORMAP_1).c_str(), true);
		pls_->scol0(0, lInitialColor._red, lInitialColor._green, lInitialColor._blue);
		// Restore color.
		restoreColor(pls_, lInitialColor, pplot_->_panel->_page->_mode);
fbe3c2bb   Benjamin Renard   First commit
316
317
318
319
320

		//draw bar box
		pls_->box("bc", 0, 0, "bc", 0, 0);

		//draw legend
df45df5e   Benjamin Renard   Introduce AxisLeg...
321
		PlPlotUtil::setPlFont(legendFont);
fbe3c2bb   Benjamin Renard   First commit
322
323
324
325
326
		std::string legendText = _barInfoList[i]._name;
		legendText += ": ";
		//plot parameter name
		pls_->mtex("t",1,0,0,legendText.c_str());

5d98ca3d   Benjamin Renard   Draw intervals in...
327
328
		PLFLT xmin2,xmax2,ymin2,ymax2;
		pls_->gspa(xmin2,xmax2,ymin2,ymax2);
fbe3c2bb   Benjamin Renard   First commit
329

5d98ca3d   Benjamin Renard   Draw intervals in...
330
		double textFactor = (xmax2-xmin2) * vpBounds._width ;
fbe3c2bb   Benjamin Renard   First commit
331
332
333
334
335
336

		double legendPos = plstrl(legendText.c_str()) / textFactor;
		std::string separator = ", ";
		//plot each status name with the associated color
		for (int p = 0; p < (int)legend.size(); ++p)
		{
5d98ca3d   Benjamin Renard   Draw intervals in...
337
			Color initColor = changeColor(pls_, legend[p].first, pplot_->_panel->_page->_mode);
fbe3c2bb   Benjamin Renard   First commit
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
			pls_->mtex("t",1,legendPos,0,legend[p].second.c_str());
			legendPos += plstrl(legend[p].second.c_str()) / textFactor;
			restoreColor(pls_, initColor, pplot_->_panel->_page->_mode);
			if (p != (int)legend.size() - 1)
			{
				pls_->mtex("t",1,legendPos,0,separator.c_str());
				legendPos += plstrl(separator.c_str()) / textFactor;
			}
		}

		delta += (BAR_HEIGHT+BAR_SPACE+1.5*legendCharSize.second);
	}

	// restore viewport.
	pls_->vpor(vpBounds._x, vpBounds._x + vpBounds._width, vpBounds._y,
			vpBounds._y + vpBounds._height);

	// restore window
	pls_->wind(winBounds._x, winBounds._x + winBounds._width, winBounds._y,
			winBounds._y + winBounds._height);

	// Restore initial color.
	restoreColor(pls_, lInitialColor, pplot_->_panel->_page->_mode);

}

void StatusBarDecorator::buildBarList() {
	LOG4CXX_DEBUG(_logger, "StatusBarDecorator::buildBarList");

	// Retrieve ParamInfo Manager
	ParamMgr 		*piMgr =ParamMgr::getInstance();

	_barInfoList.clear();
	for (auto p : _decoratorPlot->_parameterAxesList)
	{
		ParameterSPtr param  = _parameterManager.getParameter(p._originalParamId);
		ParamInfoSPtr paramInfo = piMgr->getParamInfoFromId(param->getInfoId());

		std::string name;

		if ((paramInfo == nullptr) || (paramInfo->getShortName().empty()))
			name = p._originalParamId;
		else
			name = paramInfo->getShortName();

		LOG4CXX_DEBUG(_logger, " inspecting parameter : " << name);
		// list asked series :
2fc1f2f8   Benjamin Renard   Full rework for s...
385
386
387
388
389
390
391
392
393
394
395
396
397
398
		for(auto lSeriesProperties : p.getYSeriePropertiesList()) {
			for (auto index : lSeriesProperties.getIndexList(_pParameterValues)) {
				BarInfo barInfo;

				std::ostringstream osstr;
				osstr << name;
				// display index only if non scalar
				if(index.getDim1Index() != -1){
					osstr << "[" << index.getDim1Index() ;
					if (index.getDim2Index() != -1)
						osstr << "," << index.getDim2Index();
					osstr << "]";
				}
				LOG4CXX_DEBUG(_logger, " Display name : " << osstr.str());
fbe3c2bb   Benjamin Renard   First commit
399

2fc1f2f8   Benjamin Renard   Full rework for s...
400
401
402
403
404
405
				barInfo._name = osstr.str();
				barInfo._index = index;
				barInfo._dataPtr = &(*_pParameterValues)[lSeriesProperties.getParamId()];
				barInfo._paramInfoSPtr = paramInfo;
				_barInfoList.push_back(barInfo);
			}
fbe3c2bb   Benjamin Renard   First commit
406
407
408
409
410
		}
	}
}

} /* namespace plot */