Blame view

src/ParamOutputImpl/Plot/SpectroProperties.hh 5.87 KB
fbe3c2bb   Benjamin Renard   First commit
1
2
3
4
5
6
7
8
9
10
/*
 * SeriesProperties.hh
 *
 *  Created on: Jul 1, 2014
 *      Author: AKKA
 */

#ifndef SPECTROPROPERTIES_HH_
#define SPECTROPROPERTIES_HH_

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
11
12
13
14
15
16
#define BACKGROUND_SUB_TYPE "background_sub_type"
#define BACKGROUND_SUB_VALUE "background_sub_value"
#define BACKGROUND_SUB_DIM "background_sub_dim"
#define BACKGROUND_SUB_TYPE_BY_CHANNEL "bychannel"
#define BACKGROUND_SUB_TYPE_BY_FIXED_VALUE "fixedvalue"

fbe3c2bb   Benjamin Renard   First commit
17
#include <cmath>
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
18
#include <iostream>
fbe3c2bb   Benjamin Renard   First commit
19
20
21
22
#include <string>

#include "DrawingProperties.hh"

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
23
24
25
26
namespace plot
{

	/**
fbe3c2bb   Benjamin Renard   First commit
27
28
 * Drawing properties for a parameter spectro.
 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
29
30
31
32
33
	class SpectroProperties : public DrawingProperties
	{
	public:
		friend std::ostream &operator<<(std::ostream &out_,
										const SpectroProperties &lprop_);
fbe3c2bb   Benjamin Renard   First commit
34

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
35
		/*
fbe3c2bb   Benjamin Renard   First commit
36
37
	 * @brief Dumps properties for test.
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
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
		void dump(std::ostream &out_, std::string &prefix_);

		SpectroProperties() : DrawingProperties(), _paramId(""), _tableParamsId(),
							  _hasXAxis(true), _hasYAxis(true), _hasZAxis(true), _indexDef(""),
							  _relatedDim(0), _useLog0AsMin(false)
		{
		}

		SpectroProperties(const DrawingProperties &ref_) : DrawingProperties(ref_), _paramId(""), _tableParamsId(),
														   _hasXAxis(true), _hasYAxis(true), _hasZAxis(true), _indexDef(""),
														   _relatedDim(0), _useLog0AsMin(false)
		{
		}

		SpectroProperties(const SpectroProperties &pParamDrawingProperties_) : DrawingProperties(pParamDrawingProperties_), _paramId(""), _tableParamsId(), _hasXAxis(
																																								pParamDrawingProperties_._hasXAxis),
																			   _hasYAxis(
																				   pParamDrawingProperties_._hasYAxis),
																			   _hasZAxis(
																				   pParamDrawingProperties_._hasZAxis),
																			   _indexDef(
																				   pParamDrawingProperties_._indexDef),
																			   _indexList(
																				   pParamDrawingProperties_._indexList),
																			   _relatedDim(
																				   pParamDrawingProperties_._relatedDim),
																			   _useLog0AsMin(
																				   pParamDrawingProperties_._useLog0AsMin)
		{
		}

		SpectroProperties &operator=(const SpectroProperties &ref_)
		{
			DrawingProperties::operator=(ref_);
			_paramId = ref_._paramId;
			_tableParamsId = ref_._tableParamsId;
			_hasYAxis = ref_._hasYAxis;
			_hasXAxis = ref_._hasXAxis;
			_hasZAxis = ref_._hasZAxis;
			_indexDef = ref_._indexDef;
			_indexList = ref_._indexList;
			_relatedDim = ref_._relatedDim;
			_useLog0AsMin = ref_._useLog0AsMin;
			return *this;
		}

		virtual ~SpectroProperties()
		{
		}

		/**
		 * @brief the type of the background subtraction : By channel, Fixed value
		 * 
		 */
		std::string backgroundSubType;
		/**
		 * @brief the value of the background subtraction
		 * 
		 */
		double backgroundSubValue;
		/**
		 * @brief the selected dimension of background subtraction : dim1 or dim2
		 * 
		 */
		int backgroundSubDim;

		std::string getParamId()
		{
			return _paramId;
		}

		void setParamId(std::string paramId_)
		{
			_paramId = paramId_;
		}

		std::string getTableParamIdByName(std::string paramName)
		{
			return _tableParamsId[paramName];
		}

		std::map<std::string, std::string> &getTableParams()
		{
			return _tableParamsId;
		}

		void addTableParam(std::string paramName, std::string paramId)
		{
			_tableParamsId[paramName] = paramId;
		}

		bool hasXAxis() const
		{
			return _hasXAxis;
		}

		void setXAxis(bool hasXAxis)
		{
			_hasXAxis = hasXAxis;
		}

		bool hasYAxis() const
		{
			return _hasYAxis;
		}

		void setYAxis(bool hasYAxis)
		{
			_hasYAxis = hasYAxis;
		}

		bool hasZAxis() const
		{
			return _hasZAxis;
		}

		void setZAxis(bool hasZAxis)
		{
			_hasZAxis = hasZAxis;
		}

		std::string getIndexDef() const
		{
			return _indexDef;
		}

		void setIndexDef(std::string indexDef)
		{
			_indexDef = indexDef;
		}

		AMDA::Common::ParameterIndexComponentList &getIndexes()
		{
			return _indexList;
		}

		void setIndexes(AMDA::Common::ParameterIndexComponentList indexList)
		{
			_indexList = indexList;
		}

		int getRelatedDim() const
		{
			return _relatedDim;
		}

		void setRelatedDim(int relatedDim)
		{
			_relatedDim = relatedDim;
		}

		bool getUseLog0AsMin() const
		{
			return _useLog0AsMin;
		}

		void setUseLog0AsMin(bool useLog0AsMin)
		{
			_useLog0AsMin = useLog0AsMin;
		}

		std::string getNormalization()
		{
			return _normalization;
		}

		void setNormalization(std::string normalization)
		{
			_normalization = normalization;
		}

		void setBackgroundSubType(std::string backgroundSubType1)
		{
			backgroundSubType = backgroundSubType1;
		}

		std::string getBackgroundSubType()
		{
			return backgroundSubType;
		}

		void setBackgroundSubValue(double backgroundSubValue1)
		{
			backgroundSubValue = backgroundSubValue1;
		}

		double getBackgroundSubValue()
		{
			return backgroundSubValue;
		}

		void setBackgroundSubDim(int backgroundSubDim1)
		{
			backgroundSubDim = backgroundSubDim1;
		}

		int getBackgroundSubDim()
		{
			return backgroundSubDim;
		}

	private:
		/**
fbe3c2bb   Benjamin Renard   First commit
241
242
	 * @brief Calculated paramId (from resolution).
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
243
		std::string _paramId;
fbe3c2bb   Benjamin Renard   First commit
244

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
245
		/**
f2db3c16   Benjamin Renard   Support variable ...
246
247
	 * @brief Calculated tableParamsId (from resolution).
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
248
		std::map<std::string, std::string> _tableParamsId;
f2db3c16   Benjamin Renard   Support variable ...
249

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
250
		/**
fbe3c2bb   Benjamin Renard   First commit
251
252
	 * @brief Flag that indicates the serie has X Axis
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
253
		bool _hasXAxis;
fbe3c2bb   Benjamin Renard   First commit
254

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
255
		/**
fbe3c2bb   Benjamin Renard   First commit
256
257
	 * @brief Flag that indicates the serie has Y Axis (tickplot has no Y axis)
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
258
		bool _hasYAxis;
fbe3c2bb   Benjamin Renard   First commit
259

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
260
		/**
fbe3c2bb   Benjamin Renard   First commit
261
262
	 * @brief Flag that indicates the spectro has Z Axis (= colorAxis)
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
263
		bool _hasZAxis;
fbe3c2bb   Benjamin Renard   First commit
264

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
265
		/**
fbe3c2bb   Benjamin Renard   First commit
266
267
	 * @brief Index definition (give by the request)
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
268
		std::string _indexDef;
fbe3c2bb   Benjamin Renard   First commit
269

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
270
		/*
fbe3c2bb   Benjamin Renard   First commit
271
272
	 * @brief List of components used by the spectro
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
273
		AMDA::Common::ParameterIndexComponentList _indexList;
fbe3c2bb   Benjamin Renard   First commit
274

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
275
		/*
fbe3c2bb   Benjamin Renard   First commit
276
277
	 * @brief Related dimension
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
278
		int _relatedDim;
1003dcf4   Benjamin Renard   Add option to sho...
279

fe6b6521   Menouard AZIB   J'ai ajouté le tr...
280
		/*
1003dcf4   Benjamin Renard   Add option to sho...
281
282
	 * @brief Flag to know if 0 values must shown as Min Values in log. scale
	 */
fe6b6521   Menouard AZIB   J'ai ajouté le tr...
283
284
285
286
		bool _useLog0AsMin;

		std::string _normalization;
	};
fbe3c2bb   Benjamin Renard   First commit
287
288
289
290

} /* namespace plot */

#endif /* SPECTROPROPERTIES_HH_ */