Blame view

src/ParamOutputImpl/Statistic/StatisticOutput.cc 12.5 KB
fbe3c2bb   Benjamin Renard   First commit
1
2
3
4
5
6
7
8
9
10
11
12
/**
 * StatisticOutput.cc
 *
 *  Created on: 04 nov. 2014
 *      Author: AKKA
 */

#include "StatisticOutput.hh"

#include "ServicesServer.hh"
#include "TimeUtil.hh"

785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
13
14
15
16
17
18
#include "AMDA-Kernel_Config.hh"
#include "Parameter.hh"
#include "ParamMgr.hh"
#include "MissionMgr.hh"
#include "InstrumentMgr.hh"

fbe3c2bb   Benjamin Renard   First commit
19
20
21
#include <boost/filesystem/path.hpp>
#include <boost/filesystem.hpp>

785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
22

fbe3c2bb   Benjamin Renard   First commit
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
namespace AMDA {
namespace ParamOutputImpl {

/**
 * @brief Implementation of a ParamOutput to apply statistic processes on parameters.
 */
namespace Statistic {

StatisticOutput::StatisticOutput(AMDA::Parameters::ParameterManager& pParameterManager) :
			ParamOutput(pParameterManager),
			_statisticProperties(),
			_currentIntervalIndex(0)
{
}

StatisticOutput::~StatisticOutput()
{
}

/**
 * @overload DataClient::establishConnection()
 */
void StatisticOutput::establishConnection()
{
	LOG4CXX_DEBUG(_logger,"StatisticOutput::establishConnection");

	for (auto paramProp : _statisticProperties.getParamPropertiesList())
	{
		try {
			AMDA::Parameters::ParameterSPtr param = _parameterManager.getParameter(
									paramProp->getId());

			for (auto statisticFunc : paramProp->getFunctionPropertiesList())
			{
				ProcessDescription procDesc;
				procDesc._paramId = paramProp->getId();
				procDesc._functionName = statisticFunc->getName();
				procDesc._index = paramProp->getIndex();
				procDesc._statisticProcesSPtr.reset(AMDA::Parameters::ServicesServer::getInstance()->getStatisticProcess(statisticFunc->getName(), *param.get(), paramProp->getIndex()));
				procDesc._statisticProcesSPtr->setArguments(statisticFunc->getArgumentMap());
				_processDescriptionList.push_back(procDesc);
				procDesc._statisticProcesSPtr->establishConnection();
			}
		} catch (...) {
			LOG4CXX_ERROR(_logger, "StatisticOutput::establishConnection - It's impossible to create statistic process for parameter " << paramProp->getId());
			throw;
		}
	}
}

/**
 * @overload ParamOutput::init()
 */
void StatisticOutput::init()
{
	LOG4CXX_DEBUG(_logger,"StatisticOutput::init");

	//init all needed parameters
	for (auto procDesc : _processDescriptionList)
	{
		try {
			procDesc._statisticProcesSPtr->init(_timeIntervalList);
		} catch (...) {
			LOG4CXX_ERROR(_logger, "StatisticOutput::init - It's impossible to init a statistic process");
			throw;
		}
	}
}

/**
 * @overload ParamOutput::apply()
 */
void StatisticOutput::apply()
{
	LOG4CXX_DEBUG(_logger,"StatisticOutput::apply");

fbe3c2bb   Benjamin Renard   First commit
99
	try {
c6a67968   Benjamin Renard   Fix some violatio...
100
		bool isFirstInterval = true;
fbe3c2bb   Benjamin Renard   First commit
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
		//Intervals loop
		while (_currentTimeInterval != _timeIntervalList->end())
		{
			//select output structure
			switch (_statisticProperties.getOutputStructure())
			{
			case OutputStructure::ONE_FILE :
				applyOneFile(isFirstInterval);
				break;
			case OutputStructure::ONE_FILE_PER_PARAMETER :
				applyOneFilePerParameter(isFirstInterval);
				break;
			default :
				LOG4CXX_WARN(_logger, "StatisticOutput::apply - output structure not implemented => use ONE-FILE");
			}
			//go to next time interval
			++_currentTimeInterval;
			++_currentIntervalIndex;
			isFirstInterval = false;
		}

		//write catalog
		for (auto catalog : _statisticCatalogMap)
		{
			std::string filePath = catalog.second.write(_workPath, _statisticProperties.getFileFormatKey());
			if (!filePath.empty())
				_files.push_back(filePath);
		}
	} catch (...) {
		LOG4CXX_ERROR(_logger, "StatisticOutput::apply : Error to apply output");
		throw;
	}
}

void StatisticOutput::applyOneFile(bool isFirstInterval)
{
	//init catalog if need
	if (isFirstInterval)
		initCatalog("");
	//create catalog interval
	TimeTableCatalog::TimeInterval newInt(_currentTimeInterval->_startTime,_currentTimeInterval->_stopTime);
	//compute statistic result for current interval
	for (auto &procDesc : _processDescriptionList)
	{
		try {
			std::vector<std::string> crtResult;
			std::vector<std::string> crtCoverage;
			procDesc._statisticProcesSPtr->compute(crtResult,crtCoverage);
			if (isFirstInterval)
				addProcessDescriptionInCatalog(&_statisticCatalogMap[""], &procDesc);
			newInt.addParameterData(procDesc._dataKey, crtResult);
			newInt.addParameterData(procDesc._coverageKey, crtCoverage);
		} catch (...) {
			LOG4CXX_ERROR(_logger, "StatisticOutput::applyOneFile - It's impossible to apply a statistic process");
			throw;
		}
	}
	_statisticCatalogMap[""].addInterval(newInt);
}

void StatisticOutput::applyOneFilePerParameter(bool isFirstInterval)
{
	std::map<std::string,TimeTableCatalog::TimeInterval *> intMap;
	for (auto &procDesc : _processDescriptionList)
	{
		try {
			std::vector<std::string> crtResult;
			std::vector<std::string> crtCoverage;
			procDesc._statisticProcesSPtr->compute(crtResult,crtCoverage);
			//init catalog if need
			if (isFirstInterval)
				initCatalog(procDesc._paramId);
			//create new interval if need
			if (intMap[procDesc._paramId] == NULL)
			{
				//init new interval
				intMap[procDesc._paramId] = new TimeTableCatalog::TimeInterval(_currentTimeInterval->_startTime,_currentTimeInterval->_stopTime);
			}
			//add process description in catalog
			if (isFirstInterval)
				addProcessDescriptionInCatalog(&_statisticCatalogMap[procDesc._paramId], &procDesc);
			//add process data and coverage in catalog
			intMap[procDesc._paramId]->addParameterData(procDesc._dataKey, crtResult);
			intMap[procDesc._paramId]->addParameterData(procDesc._coverageKey, crtCoverage);
		} catch (...) {
			LOG4CXX_ERROR(_logger, "StatisticOutput::applyOneFilePerParameter - It's impossible to apply a statistic process");
			throw;
		}
	}

	//add intervals in corresponding catalog
	for (auto intervalDef : intMap)
	{
		_statisticCatalogMap[intervalDef.first].addInterval(*intervalDef.second);
		delete intervalDef.second;
	}
}

void StatisticOutput::initCatalog(std::string paramId)
{
	if (_statisticCatalogMap.find(paramId) != _statisticCatalogMap.end())
		//already exist => nothing to do
		return;

	_statisticCatalogMap[paramId]._timeFormat = _statisticProperties.getTimeFormat();

	_statisticCatalogMap[paramId]._name = getCatalogName(paramId);

c6a67968   Benjamin Renard   Fix some violatio...
209
	if(getenv("HIDE_AMDA_DATE") != NULL)
fbe3c2bb   Benjamin Renard   First commit
210
211
212
213
214
		_statisticCatalogMap[paramId]._creationDate = 0;
	else
		_statisticCatalogMap[paramId]._creationDate = std::time(0);

	_statisticCatalogMap[paramId]._description.push_back("Generated by CDPP/AMDA Statistic Module");
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
215
                    //adding other infomation
401c20f9   Hacene SI HADJ MOHAND   improving 4788
216
217
        
                   for (ProcessDescription  processDes: _processDescriptionList)
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
218
219
220
221
222
                   {
                       std::stringstream statInfo;
                       AMDA::Info::ParamInfoSPtr paramInfo = AMDA::Info::ParamMgr::getInstance()->getParamInfoFromId(processDes._paramId);
                       
                       //AMDA::Info::MissionInfoSPtr missionInfo = AMDA::Info::MissionMgr::getInstance()->getMissionInfoFromId(processDes._paramId);
401c20f9   Hacene SI HADJ MOHAND   improving 4788
223
224
                       if(processDes._index == _processDescriptionList.front()._index)
                            statInfo<<"by using params: \n";
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
225
226
227
228

                       if(paramInfo->getInstrumentId() !="")
                       {
                            AMDA::Info::InstrumentInfoSPtr instrumentInfo = AMDA::Info::InstrumentMgr::getInstance()->getInstrumentInfoFromId(paramInfo->getInstrumentId());
97bfee18   Benjamin Renard   Fix bug in statis...
229
230
231
232
233
234
235
236
                            if (instrumentInfo.get() != nullptr) {
                               if(instrumentInfo->getMissionId() != ""){
                                  AMDA::Info::MissionInfoSPtr missionInfo = AMDA::Info::MissionMgr::getInstance()->getMissionInfoFromId(instrumentInfo->getMissionId());
                                  if (missionInfo.get() != nullptr) {
                                     statInfo<< missionInfo->getName()<<"/";
                                  }
                               }
                               statInfo<<instrumentInfo->getName()<<"/";
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
237
                            }
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
238
239
240
241
242
243
                       }
                       statInfo<<processDes._paramId;
                       if(processDes._index != -1)
                          statInfo<<"["<<processDes._index<<"]";
                       statInfo<<"  with function ";
                       statInfo<<processDes._functionName;
c3402180   Hacene SI HADJ MOHAND   rm_4788 ok
244
245
246
                     // ading information about the origin 
                     if (_timeIntervalList->size() ==1 && _timeIntervalList->front()._ttPath.empty() && _timeIntervalList->front()._ttName.empty())
                     {
401c20f9   Hacene SI HADJ MOHAND   improving 4788
247
248
249
250
251
                         if(processDes._index == _processDescriptionList.back()._index){
                                     statInfo<<"\nwith interval : ";
                                     statInfo<<AMDA::TimeUtil::formatTimeDateInIso(_timeIntervalList->front()._startTime)<<" - ";
                                     statInfo<<AMDA::TimeUtil::formatTimeDateInIso(_timeIntervalList->front()._stopTime);
                         }
c3402180   Hacene SI HADJ MOHAND   rm_4788 ok
252
253
254
255
256
257
258
259
260
                     }else{
                         statInfo<<"\nfrom TimeTable/Catalog: ";
                         if(_currentTimeInterval->_ttName.empty())
                         {
                         statInfo<<_currentTimeInterval->_ttPath;
                         }else{
                             statInfo<< _currentTimeInterval->_ttName;
                     }   
                     }
785d4444   Hacene SI HADJ MOHAND   rm_4788 ok
261
262
                       _statisticCatalogMap[paramId]._description.push_back(statInfo.str());
                   }
fbe3c2bb   Benjamin Renard   First commit
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
}

void StatisticOutput::addProcessDescriptionInCatalog(TimeTableCatalog::Catalog* pCatalog, ProcessDescription* pProcDesc)
{
	//two parameters are created in a catalog for each process (for data and coverage).
	int indexOfDesc = pCatalog->getParameterDescriptions().size() / 2;

	//add catalog description for this process

	//data name
	std::stringstream dataName;

	dataName << pProcDesc->_functionName;
	dataName << "(";
	dataName << pProcDesc->_paramId;
	if (pProcDesc->_index >= 0)
	{
		dataName << "[";
		dataName << pProcDesc->_index;
		dataName << "]";
	}
	dataName << ")";

	//data key
	std::stringstream dataKey;
	dataKey << "stat_data_" << indexOfDesc;
	pProcDesc->_dataKey = dataKey.str();

	TimeTableCatalog::ParameterDescription desc(
		pProcDesc->_dataKey,
		dataName.str(),
		pProcDesc->_statisticProcesSPtr->getResultDimDefinition(),
		TimeTableCatalog::ParameterDescription::ParameterType::Double,
		"",
		"Statistic result computed by CDPP/AMDA",
		pProcDesc->_statisticProcesSPtr->getUCD(),
		""
	);
	pCatalog->addParameterDescription(desc);

	//coverage name
	std::stringstream covName;
	covName << "Coverage of ";
	covName << dataName.str();
	pProcDesc->_coverageKey = covName.str();

	//coverage key
	std::stringstream covKey;
	covKey << "stat_cov_" << indexOfDesc;
	pProcDesc->_coverageKey = covKey.str();


	TimeTableCatalog::ParameterDescription coverageDesc(
		pProcDesc->_coverageKey,
		covName.str(),
		pProcDesc->_statisticProcesSPtr->getResultDimDefinition(true),
		TimeTableCatalog::ParameterDescription::ParameterType::Double,
		"",
		"Coverage of the statistic result computed by CDPP/AMDA",
		"meta.code.qual",
		""
	);
	pCatalog->addParameterDescription(coverageDesc);
}

std::string StatisticOutput::getCatalogName(std::string paramId)
{
	std::stringstream fileName;

	if (_statisticProperties.getFileName().empty())
	{
907c4e59   Benjamin Renard   Limit filename si...
334
335
336
337
338
339
340
341
342
343
344
345
346
		std::stringstream fileNameSuffix;
		if (_currentTimeInterval->_ttName.empty()) {
			//add start time
			double lStartTime = _currentTimeInterval->_startTime;
			char buffer[TIMELENGTH];
			Double2DD_Time(buffer, lStartTime);
			fileNameSuffix << "-" << buffer;
		}
		else {
			//add TT name
			fileNameSuffix << "-" <<  _currentTimeInterval->_ttName;
		}

fbe3c2bb   Benjamin Renard   First commit
347
348
349
350
351
352
353
354
		fileName << "statistic-";

		if (_statisticProperties.getOutputStructure() == OutputStructure::ONE_FILE_PER_PARAMETER)
		{
			fileName << paramId;
		}
		else
		{
907c4e59   Benjamin Renard   Limit filename si...
355
			int crtFileNameSize = fileName.str().size() + fileNameSuffix.str().size();
fbe3c2bb   Benjamin Renard   First commit
356
357
358
			bool isFirst = true;
			for (auto paramProp : _statisticProperties.getParamPropertiesList())
			{
907c4e59   Benjamin Renard   Limit filename si...
359
360
361
362
				std::stringstream paramPart;
				if (!isFirst) {
					paramPart << "-" ;
				}
fbe3c2bb   Benjamin Renard   First commit
363
364
				isFirst = false;

907c4e59   Benjamin Renard   Limit filename si...
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
				for (auto statisticFunc : paramProp->getFunctionPropertiesList()) {
					paramPart << statisticFunc->getName() << "_";
				}
				paramPart << paramProp->getId();
				if (paramProp->getIndex() >= 0) {
					paramPart << "_" << paramProp->getIndex();
				}
				if (crtFileNameSize + paramPart.str().size() > 247) {
					//Filename is limited to 255 characters by Linux
					//+ we keep 4 characters for extension
					//+ we keep 3 characters for "etc"
					fileName << "_etc";
					break;

				}
				crtFileNameSize += paramPart.str().size();
				fileName << paramPart.str();
fbe3c2bb   Benjamin Renard   First commit
382
383
384
			}
		}

907c4e59   Benjamin Renard   Limit filename si...
385
		fileName << fileNameSuffix.str();
fbe3c2bb   Benjamin Renard   First commit
386
387
388
389
390
391
392
	}
	else
		fileName << _statisticProperties.getFileName();

	return fileName.str();
}

fbe3c2bb   Benjamin Renard   First commit
393
394
395
} /* namespace Statistic */
} /* namespace ParamOutputImpl */
} /* namespace AMDA */