Blame view

help/plotHelp 8.57 KB
1d0f5b90   Elena.Budnik   new Plot
1
2
3
4
<h2><img src="js/resources/images/16x16/plot.png" style="margin: 0px 10px 0px 0px;"/>Plot Intro (DRAFT)</h2>
<h3>NEW DESIGN OF PLOT REQUEST</h3>
<hr>
       As a lot of new plot options is added the plot request form has been completely redesigned. It is organised as multi-level tree<br/>
5294dce6   Elena.Budnik   help
5
	To see/redefine the default plot options for an element click it in the tree hierachy on the left panel <br/>
1d0f5b90   Elena.Budnik   new Plot
6
7
	Current selection is shown next to the corresponding element.<br/><br/>
	Note that at any moment you can modify any option at any level.
9f74d746   Elena.Budnik   work
8
9
	<br/><br/>  
		<img class="left" src="help/images/plot1.png"/>
9f74d746   Elena.Budnik   work
10
	<br/>
1d0f5b90   Elena.Budnik   new Plot
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
<hr>
<h3>ELEMENTS HIERARCHY</h3>
<hr>
<ol>		
	<li><h3>Page : self-explanatory</h3> 
		<i>Epoch Superposed Mode</i> : if activated  all time intervals        
		(in a case of time table / catalog input) are plotted on the same page<br/> 
		<i>Font</i> : all axis tickmarks; axis titles; copyright;
		<br/><br/>  
			<img class="left" src="help/images/plot2.png"/>
		<br/><br/>
		An example of IMF magnitude plot with checked <i>Epoch Superposed Mode</i> and Time Table with 5 intervals as time input. 
		<br/><br/>  
			<img class="left" src="help/images/image3.png"/>
		<br/>
	<hr>		
	<li><h3>Layout :  position of the panels on the page</h3>
		Two generic panel types : 'Time/Epoch' and 'XY (Scatter/Instant)';     
		<br/><br/>  
				<img class="left" src="help/images/plot3.png"/>
		<br/><br/>
		<ol><b><i>Implemented Layouts</i></b>
		
			<li> <i>Vertical</i> : vertical stack of panels;<br/>
				all time panels are of the same width;<br/>
				one XY panel in the line;<br/>
				generic panel height (for Time and XY panel)<br/>
				and width (for XY panel) can be defined at this level
			
			<li><i>Auto</i> : automatic layout - if possible combines<br/>
				several XY panels at the same level;
				only panel height can be defined (XY panel is 'square')
				
			<li><i>Manual</i> : everything is to be defined by user
		</ol>
	<hr>           
	<li><h3>Panel</h3>		 
			<img class="left" src="help/images/plot4.png"/>
		<br/><br/>
		With <i>Prefered Dimensions</i> and <i>Font</i> options you may 
		redefine generic settings for this particular panel.<br/>
		<i>Background color</i> TBD to be defined for plot area only
		<br/><br/>
9f74d746   Elena.Budnik   work
54
	
1d0f5b90   Elena.Budnik   new Plot
55
56
		<b>Plot types:</b> defines plot type associated with the corresponding panel (panel type).<br/> 
		Note that at the parameter level you specify parameter <i>Drawing Type</i>.<br/> 
d4d93e9b   Elena.Budnik   new Plot
57
		For example on one <i>Time Plot</i> panel you may plot several parameters 
a8a535e3   Elena.Budnik   work
58
		with different drawing types (Serie, TickBar, StatusBar) of TimePlot type. 
1d0f5b90   Elena.Budnik   new Plot
59
60
61
		<hr>
		<ol>
			<li><b><i>Panel : Time Plot</i></b><br/>
a8a535e3   Elena.Budnik   work
62
				allows use/combine different drawing types on the same panel :
1d0f5b90   Elena.Budnik   new Plot
63
				Serie, Spectro, Tick Bar, Status Bar  <br/>
5294dce6   Elena.Budnik   help
64
65
				Note that <i>Tick Bar</i> and <i>Status Bar</i>  cannot be plotted on the TimePlot panel
				if alone -  
a8a535e3   Elena.Budnik   work
66
67
				you <b>should always plot also</b> another parameter of <i>Serie</i> or <i>Spectro</i> drawing type, 
				otherwise you will get an empty panel.
1d0f5b90   Elena.Budnik   new Plot
68
69
70
71
72
				<br/><br/>  
					<img class="left" src="help/images/plot7.png"/>
				<br/>
	 	        <hr>
			<li><b><i>Panel : Scatter (XY) Plot</i></b><br/>
1b53fa73   Elena.Budnik   new Plot
73
74
				Y = Y(X) plot - allows Serie and Orbit Serie drawing types.				
				A parameter used as x is defined at parameter level by drag/drop from parameter tree.
1d0f5b90   Elena.Budnik   new Plot
75
76
77
				<br/><br/>  
					<img class="left" src="help/images/plot6.png"/>
				<br/>
1b53fa73   Elena.Budnik   new Plot
78
				<i>Orbit Serie</i> is a special type of XY Plot developed for orbits 2D presentations (XR; YZ ... etc).
1d0f5b90   Elena.Budnik   new Plot
79
80
			<hr>
			<li><b><i>Panel : Epoch Plot</i></b><br/>
d4d93e9b   Elena.Budnik   new Plot
81
			'Epoch'-type panel defines time axe in 'relative' time units using <i>Center Time</i> defined in the input catalog.			
1d0f5b90   Elena.Budnik   new Plot
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
			<br/>An example of Catalog suitable as input for EpochPlot :
			<pre>
			&lt;?xml version="1.0"?&gt;
			&lt;timetable xml:id="cat_0">
				&lt;name>epoch_test&lt;/name>
				&lt;created>2015-09-24T13:49:15&lt;/created>
				&lt;description>test catalog&lt;/description>
				&lt;nbIntervals>5&lt;/nbIntervals>
				&lt;parameters>
					&lt;parameter id="center" name="CenterTime" size="1" .../>
				&lt;/parameters> 
				&lt;intervals>
					&lt;start>2004-11-16T00:00:00&lt;/start>
					&lt;stop>2004-11-28T00:00:00&lt;/stop> 
					&lt;param>2004-11-20T00:00:00&lt;/param>
				&lt;/intervals>   
				&lt;intervals>
					&lt;start>2004-12-16T22:53:50&lt;/start>
					&lt;stop>2004-12-27T22:54:20&lt;/stop> 
					&lt;param>2004-12-25T10:00:00&lt;/param>
				&lt;/intervals>		 
			....
			</pre>
			If you use as input catalog the catalog above you should set  <i>Epoch Center Time Id = center</i> (parameter id="center")
			<br/><br/>  
				<img class="left" src="help/images/plot10.png"/>
			<br/><br/>
			and get the following plot (of course if you have selected <i>Epoch Superposed Mode</i> at Page Level):
			<br/>  
				<img class="left" src="help/images/image4.png"/>
			<br/>
			
			To scale time intervals select the <i>Normalized</i> option at <i>Axes/EpochAxis</i> level:
			<br/><br/>  
				<img class="left" src="help/images/plot9.png"/>
			<br/>
			<br/><br/>  
				<img class="left" src="help/images/image5.png"/>
			<br/>
			
5294dce6   Elena.Budnik   help
122
			<font color="red">CU: As for the moment catalog uploading is not implemented (as well as 'dateTime' parameter type
1d0f5b90   Elena.Budnik   new Plot
123
			in Catalog Editor) we supply CU with special 'Epoch Plot test' catalog (above) with the name <i>epoch_test</i>.
5294dce6   Elena.Budnik   help
124
			You will find this catalog in the Catalogs/My Catalogs section of your WorkSpace Explorer</font>
1d0f5b90   Elena.Budnik   new Plot
125
126
127
128
129
130
131
			<hr>
			<li><b><i>Panel : Instant Plot</i></b><br/>
				'instant spectrum' - 1D[2D] cut for 2D[3D] objects;<br/>
				TBD : add option for interchange axis : Y => X; X => Y <br/>
				Note: instant cut may be get also directly by right mouse click on spectrogram plot
			 <hr>
			<li><b><i>Panel : Status Plot</i></b><br/> permits  only one drawing type - Status Bar.<br/>
5294dce6   Elena.Budnik   help
132
133
				<font color="red">CU : For the moment <i>Status Bar</i> drawng type is implemented for the 
				STEREO SWEA quality parameters only.</font>
1d0f5b90   Elena.Budnik   new Plot
134
135
136
137
	 
			<hr>
			<li><b><i>Panel : Tick Plot</i></b> permits  only one  drawing type - Tick Bar.<br/>
				Outputs parameter as tick values for major time ticks. <br/>
5294dce6   Elena.Budnik   help
138
139
				<font color="red">CU : Known bug: for some time intervals <i>NaN</i> is output. 
				Will be fixed.</font>
1d0f5b90   Elena.Budnik   new Plot
140
141
142
143
144
145
146
		</ol>
	<br/>
	<b>Note :</b> you can plot/save <i>Plot Template</i> : plot with empty panels 
		(add and configure panels without parameters).<br/>
		
<hr>      
	<li><h3>Axes</h3>
9f74d746   Elena.Budnik   work
147
148
       <ol>
       
1d0f5b90   Elena.Budnik   new Plot
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
		<li><b><i>Time Axis</i> : self-explanatory</b><br/>
		In order not to plot time axe tickmarks and X-title on the panel uncheck
		<i>Legend</i> and <i>Show tick marks</i> checkboxes.
		<br/><br/>  
			<img class="left" src="help/images/plot5.png"/>
		<br/>
		<br/><br/>  
			<img class="left" src="help/images/image1.png"/>
		<br/>
		<hr>
		<li><b><i>Y Left [Right] Axis</i> : self-explanatory</b><br/>
		Y-title is constructed automatically.<br/>
		You may define Y-title yourself in the <i>Legend</i> block.<br/>
		Selection of <i>Left / Right</i> Y-axe (associated with parameter!!)<br/>
		is made at the <i>parameter</i> level.
9f74d746   Elena.Budnik   work
164
     </ol>
5294dce6   Elena.Budnik   help
165
     <hr>  
1d0f5b90   Elena.Budnik   new Plot
166
167
168
	<li><h3>Parameter : self-explanatory</h3>

       <ol> 
5294dce6   Elena.Budnik   help
169
170
		<li><b>Note :</b>Some fields in the form of parameter level are 'editable'.
		Introdicing of math expressions in those fields has no sense.
1d0f5b90   Elena.Budnik   new Plot
171
		May be later on... 
5294dce6   Elena.Budnik   help
172
		<hr>
1d0f5b90   Elena.Budnik   new Plot
173
		<li><i>Arguments :</i><br>	
5294dce6   Elena.Budnik   help
174
175
176
		Two possibilities to select vector components 
		- directly from parameter tree or by <i>Arguments</i> block.<br/>
		<b>Direct component selection from the tree doesn't work for the moment</b>
1d0f5b90   Elena.Budnik   new Plot
177
178
179
		<br/><br/>  
			<img class="left" src="help/images/plot8.png"/>
		<br/>
5294dce6   Elena.Budnik   help
180
181
		<hr>
		<li> You may colorize plotted parameter with the value of another parameter 
1d0f5b90   Elena.Budnik   new Plot
182
183
184
185
		by using <i>Colored Parameter</i> option (drag/drop parameter)
		<br/><br/>  
			<img class="left" src="help/images/image2.png"/>
		<br/>
5294dce6   Elena.Budnik   help
186
187
188
189
190
		<hr>
		<li><font color="red">CU : Sometimes you may get empty panel without any error. 
		Check out please if </font><i>Symbols</i> <font color="red">selection will plot the parameter. Note such cases.</font> 
		<hr>
		<li><i>Interval ticks</i> can be useful when one produces plot for time table input 
1d0f5b90   Elena.Budnik   new Plot
191
		in Epoch Superposed page mode.
5294dce6   Elena.Budnik   help
192
193
		<hr>
		<li><i>Error Bar</i>. To plot error bars you should define one (in case of <i>Delta</i>) 
1d0f5b90   Elena.Budnik   new Plot
194
195
		or two (in case of <i>Min/Max</i>) parameters used as 'error values'.<br/> You may create those
		parameters yourself using for example <i>sqrt</i> of the existing parameter.
5294dce6   Elena.Budnik   help
196
197
198
		<hr>
		<li><i>Drawing Types</i> are predefined for some parameters -
		f.i. - vex_xyz, mex_xyz - Orbit Serie; e_mgs_er - Spectro.<br/>
1d0f5b90   Elena.Budnik   new Plot
199
200
		When you drag/drop such a parameter its drawing type is set automatically.
		Will be extended for all parameters when there is sense.
9f74d746   Elena.Budnik   work
201
202
203
     </ol>
</ol>