TickMarkDecorator.cc
16.5 KB
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/*
* TickMarkDecorator.cc
*
* Created on: Dec 18, 2013
* Author: amdadev
*/
#include "TickMarkDecorator.hh"
#include <iosfwd>
#include <boost/format.hpp>
#include <tuple>
#include "log4cxx/logger.h"
#include "plplot/plplot.h"
#include "boost/exception/all.hpp"
#include "PlotLogger.hh"
#include "TimeAxis.hh"
#include "Page.hh"
#include "Time/TimePlot.hh"
#include "TickPlot.hh"
#include "PlPlotUtil.hh"
#include "ParamMgr.hh"
using boost::tuples::get;
namespace plot {
log4cxx::LoggerPtr TickMarkDecorator::_logger(
log4cxx::Logger::getLogger("AMDA-Kernel.Plot.Time.TickMarkDecorator"));
TickMarkDecorator::TickMarkDecorator (PanelPlotOutput* decoratorPlot) :
TimeAxisDecorator(),
_valuesFormat("% -4.4G"),
_decoratorPlot(decoratorPlot) {
_pTimeInfo = TimeInfoPtr(new TimeInfo());
}
TickMarkDecorator::TickMarkDecorator(const TickMarkDecorator& ref_) :
TimeAxisDecorator(ref_), _tickInfoList(ref_._tickInfoList), _valuesFormat(ref_._valuesFormat),
_decoratorPlot( ref_._decoratorPlot) {
_pTimeInfo = TimeInfoPtr(new TimeInfo(*(ref_._pTimeInfo)));
}
TickMarkDecorator& TickMarkDecorator::operator=(const TickMarkDecorator& ref_) {
if (_pTimeInfo == nullptr) {
_pTimeInfo = boost::shared_ptr<TimeInfo>(
new TimeInfo(*(ref_._pTimeInfo)));
} else {
_pTimeInfo->_timeFormat = ref_._pTimeInfo->_timeFormat;
_pTimeInfo->_timeTitle = ref_._pTimeInfo->_timeTitle;
}
_tickInfoList = ref_._tickInfoList;
_valuesFormat = ref_._valuesFormat;
_decoratorPlot = ref_._decoratorPlot;
return *this;
}
TickMarkDecorator::~TickMarkDecorator() {
}
void TickMarkDecorator::updatePlotArea(PanelPlotOutput* pplot_, Axis* axis_, const Bounds& panelBounds_, Bounds& bounds_) {
LOG4CXX_DEBUG(_logger, "TickMarkDecorator Updating plot area : "<<bounds_.toString());
TimeAxis* pAxis = (TimeAxis*) axis_;
// calculate char size for labels:
Font legendFont(axis_->getLegendFont(pplot_->_panel.get()));
PlPlotUtil::setPlFont(legendFont);
CharSize legendSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
// update top and bottom space
if (_decoratorPlot->isStandalone()) {
bounds_._y += (bounds_._height + legendSize.second * 1.2) ;
bounds_._height = legendSize.second * 1.2;
}
else {
int tickLines = 0;
for (TickParamInfoList::iterator it = _tickInfoList.begin(); it != _tickInfoList.end(); ++it) {
tickLines += it->_indexesInfo.size();
bool isScalar = (it->_indexesInfo.size() == 1) && (it->_indexesInfo[0]._index.getDim1Index() == -1) && (it->_indexesInfo[0]._index.getDim2Index() == -1);
std::string description = getTickParamDescription(it->_paramId, isScalar);
if (!description.empty()) {
++tickLines;
}
}
double tickLinesHeight = tickLines * legendSize.second * 1.2;
if (pAxis->_position == PlotCommon::POS_BOTTOM) {
bounds_._y += tickLinesHeight;
}
bounds_._height -= tickLinesHeight;
}
double maxWidth = 0;
for (TickParamInfoList::iterator it = _tickInfoList.begin(); it != _tickInfoList.end(); ++it) {
bool isScalar = (it->_indexesInfo.size() == 1) && (it->_indexesInfo[0]._index.getDim1Index() == -1) && (it->_indexesInfo[0]._index.getDim2Index() == -1);
std::string description = getTickParamDescription(it->_paramId, isScalar);
if (!description.empty()) {
double descWidth = PlPlotUtil::getTextWidthInPlPage(pplot_->_panel->_page, description.c_str());
maxWidth = std::max(maxWidth, descWidth);
}
for (std::vector<TickParamIndexInfo>::iterator itIndex = it->_indexesInfo.begin(); itIndex != it->_indexesInfo.end(); ++itIndex) {
std::string label = getTickParamLabel(it->_paramId, (*itIndex)._index);
double labelWidth = PlPlotUtil::getTextWidthInPlPage(pplot_->_panel->_page, label.c_str());
maxWidth = std::max(maxWidth, labelWidth);
}
}
if (_pTimeInfo->_pAxis->_showTickMark) {
double width = PlPlotUtil::getTextWidthInPlPage(pplot_->_panel->_page, _pTimeInfo->_timeTitle.c_str());
maxWidth = std::max(maxWidth, width);
}
PLFLT lDefaultCharHeight, lCurrentCharHeight;
plgchr(&lDefaultCharHeight, &lCurrentCharHeight);
maxWidth += 6 * lCurrentCharHeight / (std::get < 0 > (pplot_->_panel->_page->getSizeInMm()) * (pplot_->_panel->_page->_dpi / 90.));
if (_decoratorPlot->isStandalone()) {
bounds_._x += maxWidth;
bounds_._width -= maxWidth;
}
else if (bounds_._x - panelBounds_._x < maxWidth) {
bounds_._width -= (maxWidth - bounds_._x + panelBounds_._x);
bounds_._x += (maxWidth - bounds_._x + panelBounds_._x);
}
LOG4CXX_DEBUG(_logger, "Updated plot area : "<<bounds_.toString());
}
double TickMarkDecorator::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);
PlPlotUtil::setPlFont(pplot_->_panel->getFont());
CharSize fontSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
return fontSize.first * datelen;
}
void TickMarkDecorator::configure(PanelPlotOutput* pplot_, Axis* axis_, double start_,
double stop_, std::map<std::string, ParameterData> *pParameterValues) {
LOG4CXX_DEBUG(_logger, "TickMarkDecorator::configure");
_pParameterValues = pParameterValues;
// retrieve time axis
TimeAxis* pTimeAxis = (TimeAxis*) axis_;
// configure x axis range
pTimeAxis->setRange(start_, stop_);
// show xAxis or not
pTimeAxis->setOnlyTickmarks(_decoratorPlot->isStandalone());
setPlFormat(
getPlTimeFormat(pTimeAxis->_timeFormat,
pTimeAxis->getRange().getMin(),
pTimeAxis->getRange().getMax(),
getMajorTickNumber(pTimeAxis,
pTimeAxis->getRange().getMin(),
pTimeAxis->getRange().getMax())));
// install label generator
installLabelGenerator(pplot_, pTimeAxis);
}
void TickMarkDecorator::draw(PanelPlotOutput* pplot_, Axis* axis_,
std::shared_ptr<plstream> pls_) {
// draw a virtual axis for each entry // take into account plot orientation
TimeAxis* pAxis = (TimeAxis*) axis_;
// tick configuration for this axis :
double xtick = getMajorTickSpace(pAxis, pAxis->getRange().getMin(),
pAxis->getRange().getMax());
int nxsub = getMinorTickNumber(pAxis, pAxis->getRange().getMin(),
pAxis->getRange().getMax(), xtick);
// set color for drawing axis :
Color lInitialColor = changeColor(pls_, pAxis->_color,
pplot_->_panel->_page->_mode);
// Set tick (major and minor) length factor
PLFLT lTickLenFact = PanelPlotOutput::DEFAULT_TICK_LENGTH_FACTOR;
if (!isnan(pAxis->_tick._lengthFactor)) {
lTickLenFact = pAxis->_tick._lengthFactor;
}
// 0 => keep tick height in millimeters.
pls_->smaj(0, lTickLenFact);
pls_->smin(0, lTickLenFact);
// Set font to draw axes.
Font legendFont(axis_->getLegendFont(pplot_->_panel.get()));
PlPlotUtil::setPlFont(legendFont);
CharSize legendCharSize = PlPlotUtil::getCharacterSizeInPlPage(pplot_->_panel->_page);
double yInc = legendCharSize.second * 1.2;
std::string options = "";
int start;
int end;
int dir;
bool top = (pAxis->_position == PlotCommon::POS_TOP);
if (top) {
options = "mxo"; // options means : m=display above axe, x=do not plot ticks, o=user label function provided.
start = _tickInfoList.size() - 1;
end = -1;
dir = -1;
} else {
options = "nxo";// options means : n=display below axe, x=do not plot ticks, o=user label function provided.
start = 0;
end = _tickInfoList.size();
dir = 1;
}
// Get plot area viewport
PLFLT lXMin, lXMax, lYMin, lYMax;
pls_->gvpd(lXMin, lXMax, lYMin, lYMax);
// Get window
PLFLT xwmin, xwmax, ywmin, ywmax;
pls_->gvpw(xwmin, xwmax, ywmin, ywmax);
double position = top ? lYMax - yInc : lYMin;
for (int i = start; i != end; i += dir) {
if ((i == start) && _pTimeInfo->_pAxis->_showTickMark) {
//Draw time axis legend
pls_->vpor(lXMin, lXMax, position, position + yInc);
pls_->wind(xwmin, xwmax, 0, 1);
pls_->mtex("lv", 4, top ? 2 : -1, 1, _pTimeInfo->_timeTitle.c_str());
position -= dir*yInc;
}
bool isScalar = (_tickInfoList[i]._indexesInfo.size() == 1) && (_tickInfoList[i]._indexesInfo[0]._index.getDim1Index() == -1) && (_tickInfoList[i]._indexesInfo[0]._index.getDim2Index() == -1);
std::string description = getTickParamDescription(_tickInfoList[i]._paramId, isScalar);
int startIndex = 0;
int endIndex = _tickInfoList[i]._indexesInfo.size();
if (top) {
startIndex = _tickInfoList[i]._indexesInfo.size()-1;
endIndex = -1;
}
for (int j = startIndex; j != endIndex; j += dir) {
if ((j == 0) && !description.empty()) {
// Draw description
pls_->vpor(lXMin, lXMax, top ? position + yInc : position, top ? position + 2*yInc : position + yInc);
pls_->wind(xwmin, xwmax, 0, 1);
pls_->mtex("lv", 4, top ? 2 : -1, 1, description.c_str());
if (!top) {
position -= dir*yInc;
}
}
pls_->vpor(lXMin, lXMax, position, position + yInc);
pls_->wind(xwmin, xwmax, 0, 1);
// install label generator specific for that virtual axis
pls_->slabelfunc(generateTickSerieLabel, &_tickInfoList[i]._indexesInfo[j]);
// draw virtual axis
pls_->box(options.c_str(), xtick, nxsub, "", 0, 0);
// draw legend
std::string label = getTickParamLabel(_tickInfoList[i]._paramId, _tickInfoList[i]._indexesInfo[j]._index);
pls_->mtex("lv", 4, top ? 2 : -1, 1, label.c_str());
// restore viewport
pls_->vpor(lXMin, lXMax, lYMin, lYMax);
// restore window
pls_->wind(xwmin, xwmax, ywmin, ywmax);
// increment offset
position -= dir*yInc;
if (top && (j == 0) && !description.empty()) {
position -= dir*yInc;
}
}
}
// Restore initial color.
restoreColor(pls_, lInitialColor, pplot_->_panel->_page->_mode);
}
void TickMarkDecorator::installLabelGenerator(PanelPlotOutput* /*pplot_*/, TimeAxis* timeAxis_) {
LOG4CXX_TRACE(_logger, "installing LabelGenerator function");
// axis label :
LOG4CXX_TRACE(_logger, "processing axis : "<< timeAxis_->_legend.getText());
// install time format
_pTimeInfo->_timeFormat = getPlFormat();
_pTimeInfo->_timeTitle = timeAxis_->_legend.getText();
_pTimeInfo->_pAxis = timeAxis_;
// init maximum value len with formatted time :
if (TimePlot::qsasconfig == NULL) {
configqsas(1. / 86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.,
&TimePlot::qsasconfig);
}
// build all series names :
_tickInfoList.clear();
for (auto p : _decoratorPlot->_parameterAxesList) {
LOG4CXX_DEBUG(_logger, " inspecting parameter : " << p._originalParamId);
for(auto lSeriesProperties : p.getYSeriePropertiesList()) {
TickParamInfo* paramInfoPtr = NULL;
for (TickParamInfoList::iterator it = _tickInfoList.begin(); it != _tickInfoList.end(); ++it) {
if (it->_paramId.compare(lSeriesProperties.getParamId()) == 0) {
paramInfoPtr = &(*it);
break;
}
}
if (paramInfoPtr == NULL) {
TickParamInfo paramInfo;
paramInfo._paramId = lSeriesProperties.getParamId();
_tickInfoList.push_back(paramInfo);
paramInfoPtr = &(_tickInfoList[_tickInfoList.size()-1]);
}
for (auto index : lSeriesProperties.getIndexList(_pParameterValues)) {
TickParamIndexInfo* paramIndexInfoPtr = NULL;
for (std::vector<TickParamIndexInfo>::iterator indexIt = paramInfoPtr->_indexesInfo.begin(); indexIt != paramInfoPtr->_indexesInfo.end(); ++indexIt) {
if (indexIt->_index == index) {
paramIndexInfoPtr = &(*indexIt);
}
}
if (paramIndexInfoPtr == NULL) {
TickParamIndexInfo indexInfo;
indexInfo._valuesFormat = getValuesFormat();
indexInfo._parameterData = &((*_pParameterValues)[lSeriesProperties.getParamId()]);
indexInfo._index = AMDA::Common::ParameterIndexComponent(index.getDim1Index(),index.getDim2Index());
paramInfoPtr->_indexesInfo.push_back(indexInfo);
}
}
}
}
// no legend for this axe since it is displayed at axis origin:
timeAxis_->_legend.clearLabels();
// install label generator for main axe (the one that is displayed)
timeAxis_->_labelGenerator->_data = _pTimeInfo.get();
timeAxis_->_labelGenerator->_function = generateTickTimeLabel;
}
std::string TickMarkDecorator::getTickParamLabel(const std::string& paramId, const AMDA::Common::ParameterIndexComponent& index) {
AMDA::Parameters::ParameterSPtr param = _decoratorPlot->_parameterManager.getParameter(paramId);
AMDA::Info::ParamMgr* piMgr = AMDA::Info::ParamMgr::getInstance();
AMDA::Info::ParamInfoSPtr paramInfo = piMgr->getParamInfoFromId(param->getInfoId());
std::ostringstream osstr;
bool skipIndex = false;
if (paramInfo != nullptr) {
if (paramInfo->getComponents(index).empty() == false) {
osstr << paramInfo->getComponents(index);
skipIndex = true;
}
else {
osstr << paramInfo->getShortName();
}
}
else {
osstr << paramId;
}
if (!skipIndex) {
if(index.getDim1Index() != -1){
osstr << "[" << index.getDim1Index() ;
if (index.getDim2Index() != -1)
osstr << "," << index.getDim2Index();
osstr << "]";
}
else if (index.getDim2Index() != -1) {
osstr << "[" << index.getDim2Index() << "]";
}
}
if ((paramInfo != nullptr) && (paramInfo->getUnits().empty() == false)) {
osstr << ", " << paramInfo->getUnits();
}
return osstr.str();
}
std::string TickMarkDecorator::getTickParamDescription(const std::string& paramId, bool isScalar) {
AMDA::Parameters::ParameterSPtr param = _decoratorPlot->_parameterManager.getParameter(paramId);
AMDA::Info::ParamMgr* piMgr = AMDA::Info::ParamMgr::getInstance();
AMDA::Info::ParamInfoSPtr paramInfo = piMgr->getParamInfoFromId(param->getInfoId());
std::string description;
if (paramInfo != nullptr) {
description = paramInfo->getInstrumentId();
if (!description.empty()) {
if (description.find('_') != std::string::npos) {
description = description.substr(0, description.find('_'));
}
std::transform(description.begin(), description.end(), description.begin(), ::toupper);
}
}
if (description.empty() && !isScalar) {
if (paramInfo != nullptr) {
description = paramInfo->getShortName();
}
if (description.empty()) {
description = paramId;
}
}
if ((paramInfo != nullptr) && (paramInfo->getCoordinatesSystem().empty() == false)) {
description += ", ";
description += paramInfo->getCoordinatesSystem();
}
return description;
}
/***************************** EXTERNAL METHODS ********************************/
void generateTickSerieLabel(PLINT axis, PLFLT value, char *label, PLINT length,
PLPointer data) {
if (axis == PL_X_AXIS) {
if (data == NULL) {
std::cout
<< "WARNING !!!! NO DATA FOUND FOR generateTickSerieLabel FUNCTION !!!"
<< std::endl << std::endl;
LOG4CXX_WARN(gLogger,
"WARNING !!!! NO DATA FOUND FOR generateTickSerieLabel FUNCTION !!");
return;
}
TickParamIndexInfo* pInfo = static_cast<TickParamIndexInfo*> (data);
// display formatted value
std::ostringstream labels;
//get nearest value
double crtTime = (double) value;
int crtIndex = pInfo->_parameterData->indexOf(crtTime);
if (crtIndex == -1 && (crtTime - (pInfo->_parameterData->getTimes()[pInfo->_parameterData->getSize()-1]) < pInfo->_parameterData->getParamGapSize()))
//Fix last value
crtIndex = pInfo->_parameterData->getSize()-1;
else if ((crtTime - (pInfo->_parameterData->getTimes()[crtIndex])) > pInfo->_parameterData->getParamGapSize())
//Be sure that we are not in a data gap
crtIndex = -1;
if (crtIndex == -1) {
labels << "NaN" << std::endl;
}
else {
labels << boost::format(pInfo->_valuesFormat) % (*pInfo->_parameterData->getValues(pInfo->_index, crtIndex));
}
snprintf(label, length, "%s", labels.str().c_str());
}
}
void generateTickTimeLabel(PLINT axis, PLFLT value, char *label, PLINT length,
PLPointer data) {
if (axis == PL_X_AXIS) {
if (data == NULL) {
std::cout
<< "WARNING !!!! NO DATA FOUND FOR generateOrbitTimeLabel FUNCTION !!!"
<< std::endl << std::endl;
LOG4CXX_WARN(gLogger,
"WARNING !!!! NO DATA FOUND FOR generateOrbitTimeLabel FUNCTION !!");
return;
}
TimeInfo* pInfo = static_cast<TimeInfo*> (data);
if (!pInfo->_pAxis->_showTickMark) {
label [0] = 0;
return;
}
// display formatted time
std::string timeFormatstr = pInfo->_timeFormat.c_str();
char *timeFormat = new char[timeFormatstr.length() + 1];
strcpy(timeFormat, timeFormatstr.c_str());
if (TimePlot::qsasconfig == NULL) {
configqsas(1. / 86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.,
&TimePlot::qsasconfig);
}
char formattedTime[40];
strfqsas(formattedTime, 40, timeFormat, (double) value,
TimePlot::qsasconfig);
delete[] timeFormat;
snprintf(label, length, "%s", formattedTime);
}
}
} /* namespace plot */