help second commit

Elena.Budnik
1 parent 6586e8e0
Showing 16 changed files with 124 additions and 37 deletions Show diff stats
help/ABC
help/content.json
help/dataminingHelp
help/images/panelOptions.png
help/images/panelScatter.png
help/images/panelTypes.png
help/images/paramElem.png
help/images/paramOptions.png
help/images/plot_pdf.png
help/images/plot_png.png
help/images/scatterParam.png
help/images/simplified.png
help/interSession
help/plotSettings
help/plotSimplifiedView
help/plotStart
@@ -14,7 +14,7 @@ Define &lt;b&gt;&lt;i&gt;time interval&lt;/i&gt;&lt;/b&gt; in &lt;img src=&quot;help/images/time_selector.png&quot;&gt; 
 <br/>
 <hr><p>
 <h2>B. How to Work with Time Tables / Catalogs</h2>
- ...  you may use Time Table / Catalog as <b><i>input times</i></b>  for AMDA modules. <br/> Switch  
+ ...  you may use Time Table / Catalog as <b><i>input times</i></b> in AMDA modules. <br/> Switch  
  time selector  to <b><i>TimeTable or Catalog</i></b> mode by clicking corresponding tab
  and <b><i>drag-and-drop</i></b> TimeTable / Catalog from the WorkSpace Explorer Tree on the <b><i>time selection</i></b> panel.
 <br/>
@@ -16,7 +16,7 @@ children: [
         id: 'parametersTree',        
         leaf:true
     },{
-        text:'Resources: Filtering',
+        text:'Resources: Filtering (TBU)',
         id: 'filters',        
         leaf:true
     },{
@@ -48,7 +48,7 @@ children: [
         id: 'mydataparameter',
         leaf:true
     },{
-        text:'Aliases',
+        text:'Aliases (TBU)',
         id: 'aliases',
         leaf:true
     }]
@@ -63,19 +63,51 @@ children: [
         id: 'plotSettings',        
         leaf:true
     },{
-        text:'Plot Intro',
-        id: 'panelSettings',        
+        text:'Plot Briefly',
+        id: 'plotSimplifiedView',        
         leaf:true
+    },
+    {
+        text:'Plot In Details (TBD)',
+        children:[{
+			text:'Plot Objects',
+			id: 'plotObjects',        
+			leaf:true
+        },{
+			text:'Plot Objects : Page',
+			id: 'plotPage',        
+			leaf:true
+        },{
+			text:'Plot Objects : Layout',
+			id: 'plotLayout',        
+			leaf:true
+        },{
+			text:'Plot Objects : Panel',
+			id: 'plotPanel',        
+			leaf:true
+        },{
+			text:'Plot Objects : Axis',
+			id: 'plotAxis',        
+			leaf:true
+        },{
+			text:'Plot Objects : Additional Objects',
+			id: 'plotAdditional',        
+			leaf:true
+        },{
+			text:'Plot Objects : Parameter',
+			id: 'plotParameter',        
+			leaf:true
+        }]
     },{
         text:'Interactive Plot Session',
         id: 'interSession',        
         leaf:true
     },{
-        text:'MultiPlot Mode',
+        text:'MultiPlot Mode (TBD) ',
         id: 'multiPlot',         
         leaf:true
     },{
-        text:'Access to Hubble Images',
+        text:'Access to Hubble Images (TBD)',
         id: 'hubbleImages',         
         leaf:true
     }]
@@ -86,63 +118,63 @@ children: [
         id: 'dataminingHelp',
         leaf:true
     },{
-        text:'Using Functions',
+        text:'Using Functions (TBD)',
         id: 'functionsHelp',
         leaf:true
     }]
 },{
     text:'Data Downloading',
     children:[{
-        text:'Data', 
+        text:'Data (TBU)', 
         id: 'downloadDataHelp',
         leaf:true
     },{
-        text:'TimeTables / Catalogs', 
+        text:'TimeTables / Catalogs (TBU)', 
         id: 'downloadTTHelp',
         leaf:true
     }]
 },{
     text:'Data Uploading',
     children:[{
-        text:'Data', 
+        text:'Data (TBU)', 
         id: 'uploadDataHelp',
         leaf:true
     },{
-        text:'TimeTables', 
+        text:'TimeTables (TBU)', 
         id: 'uploadTTHelp',
         leaf:true
     },{
-        text:'Catalogs', 
+        text:'Catalogs (TBD)', 
         id: 'uploadCatHelp',
         leaf:true
     }]
 },{
     text:'Catalogs',
     children:[{
-        text:'Generating Catalogs in AMDA', 
+        text:'Generating Catalogs in AMDA (TBD)', 
         id: 'statisticsHelp',
         leaf:true
     },{
-        text:'Managing Catalogs', 
+        text:'Managing Catalogs (TBD)', 
         id: 'catalogHelp',
         leaf:true
     },{
-        text:'Visualizing Catalogs', 
+        text:'Visualizing Catalogs (TBD)', 
         id: 'visuHelp',
         leaf:true
     }]
 },{
     text:'Time Tables',
     children:[{
-        text:'Managing Time Tables', 
+        text:'Managing Time Tables (TBU)', 
         id: 'timetableHelp',
         leaf:true
     },{
-        text:'Operations on Time Tables', 
+        text:'Operations on Time Tables (TBU)', 
         id: 'ttOperationsHelp',
         leaf:true
     },{
-        text:'Shared Time Tables', 
+        text:'Shared Time Tables (TBU)', 
         id: 'ttShared',
         leaf:true
     }]
@@ -156,21 +188,25 @@ children: [
         leaf:true
     },
     {
-        text:'Connecting to SAMP Hub', 
+        text:'Connecting to SAMP Hub (TBU)', 
         id: 'SampHelp',
         leaf:true
     }]
 },{ 
       text:'Remote Data',
       children:[{   
-      text:'Remote Data Centers', 
+      text:'Remote Data Centers (TBU)', 
         id: 'remoteIntro',
         leaf:true
     },{   
-      text:'Remote Centers: Adding Data', 
+      text:'Remote Centers: Adding Data (TBU)', 
         id: 'RemoteDataHelp',
         leaf:true
+    }]
+},{   
+      text:'EPN-TAP (TBD)', 
+        id: 'EPNTAP',
+        leaf:true
     }
-    ]
-}]
+]
 }
@@ -2,24 +2,24 @@
 <p>
 DataMining module is searching data for time intervals when a condition on parameters (defined by yourself)
 is valid.<br/><hr>
-<b>1 : </b>To construct a condition <b><i>drag</i></b> the parameter[s] from the Parameter Tree and <b><i>drop</i></b>  
+<b>1. </b>To construct a condition <b><i>drag</i></b> the parameter[s] from the Parameter Tree and <b><i>drop</i></b>  
 it onto the <b><i>Data Mining Condition</i></b> area.<br/>
 <img class="centered" src="help/images/mining1.png"/><br/>
 </p><hr>
 <p>
-<b>2 : </b>While constructing you may use <b><i>Tools For Condition Construction</i></b> -
+<b>2. </b>While constructing you may use <b><i>Tools For Condition Construction</i></b> -
 for example  - <b><i>Functions</i></b>:<br/><br/> 
 <img class="centered" src="help/images/derived2.png"><br/> 
 </p><hr>
 <p> 
-<b>3 : </b>To combine and compare different AMDA parameters which possibly have different 
+<b>3. </b>To combine and compare different AMDA parameters which possibly have different 
 sampling times you have to specify <b><i>Sampling Time Step</i></b>.<br/>
 </p><p> 
 <img align="left" src="help/images/mining2.png" style="margin: 0px 10px 0px 0px;"/>
 Depending on their original sampling, AMDA parameters will be averaged or interpolated to obtain 
 a condition evaluated at a <b><i>Sampling Time Step</i></b> resolution. Before evaluate the expression
 all the parameters are resampled and after that the expression is calculated. 
-</p><br/>
+</p>
 <p>
 You may also put  <b><i>Data Gap</i></b> value. It is expressed in the parameter 'sampling 
 times' and defines  gaps threshold. If data is absent for time interval greater than this threshold
@@ -31,12 +31,12 @@ are displayed in popup window shown when the mouse is over the corresponding dat
 </p><hr>
 <p>
 <img align="left"  src="help/images/mining3.png" style="margin: 10px 10px 0px 0px;"/>
-<b>4 : </b>Data Mining could be done either for a single time interval 
+<b>4. </b>Data Mining could be done either for a single time interval 
 (<b><i>Start Time</i></b> and <b><i>Time Interval</i></b> should be defined) 
 or for a set of time intervals from one or several <b><i>Time Tables or Catalogs</i></b>.
 </p><br/><hr>
 <p>
-<b>5 : </b>Condition may be saved in your Workspace for next use. 
+<b>5. </b>Condition may be saved in your Workspace for next use. 
 Just give the name to a condition (<b><i>Request Name</i></b>) and 
 click the <b><i>Save Request</i></b> button. Your condition is added to the <b><i>DataMining</i></b>
 subtree of the Workspace Explorer, <b><i>Operations</i></b> tab.
@@ -44,18 +44,18 @@ subtree of the Workspace Explorer, &lt;b&gt;&lt;i&gt;Operations&lt;/i&gt;&lt;/b&gt; tab.
 </p><hr>
 <p>
 <img align="left" src="help/images/mining6.png" style="margin: 10px 10px 0px 0px;"/><br/>
-<b>6 : </b>Double clicking on condition name in the <b><i>DataMining</i></b> tree 
+<b>6. </b>Double clicking on condition name in the <b><i>DataMining</i></b> tree 
 (Workspace Explorer, <b><i>Operations</i></b> tab) or selecting <b><i>DataMining By Request</i></b>
 from the context menu opens the DataMining module filled with the condition content.
 </p>
 <br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>
 <hr><p>
-<b>7 : </b> Data Mining produces two XML tables (Time Table  and  Gaps Time Table) accessible from the <b><i>Results</i></b> window : 
+<b>7. </b> Data Mining produces two XML tables (Time Table  and  Gaps Time Table) accessible from the <b><i>Results</i></b> window : 
 <img class="centered" src="help/images/mining8.png"><br/><br/>
 </p>
 <hr><p>
 <img align="right" src="help/images/mining9.png" style="margin: 10px 0px 0px 10px;"/> 
-<b>8 : </b> <b><i>Results</i></b> window may be always opened by selecting <b><i>Show Result</i></b> from context menu opened on the 
+<b>8. </b> <b><i>Results</i></b> window may be always opened by selecting <b><i>Show Result</i></b> from context menu opened on the 
 right click the corresponding node of the
  FinishedJobs / Results, DataMining tree of the Workspace Explorer, <b><i>Jobs</i></b> tab.
 </p>
@@ -26,7 +26,7 @@ You find the description of (6) Linked to Multi Plot Mode in the &lt;i&gt;MultiPlot Mo
 </p>
 <hr>
 <p>
-<img  align="right" style="margin: 0px 10px 10px 10px;" src="help/images/plot_14.png"/>
+<img  align="left" style="margin: 0px 10px 10px 10px;" src="help/images/plot_14.png"/>
 <b><i>Zoom In Time Interval (3)</i></b><br/>
 After right clicking <i>Zoom On Time Axis</i> in the context menu
 select interval of interest by clicking image.
 <h2><img src="js/resources/images/16x16/plot.png" style="margin: 0px 10px 0px 0px;"/>Plot Manager : Global Settings</h2>
 <p>
   <img src="help/images/plot_png.png" align="right" style="margin: 0px 10px 10px 10px;"/> 
-  <img src="help/images/plot_pdf.png" align="right" style="margin: 0px 10px 10px 10px;"/>
   <b><i>Output Options</i></b> panel controls the global plot settings.<br/> 
  <b><i>File Format</i></b>. You may select PNG, PDF, PostScript, or SVG file output format.<br/>
  PNG format by default produces screen output and opens an interactive plot session.
@@ -0,0 +1,52 @@
+<h2><img src="js/resources/images/16x16/plot.png" style="margin: 0px 10px 0px 0px;"/>Plot Manager : Simplified View</h2>
+ <p>
+   <img align="right" src="help/images/simplified.png" style="margin: 0px 10px 10px 10px;"/>
+   Plot request form is organised as multi-level tree. By default the 
+   main plot elements only (<b><i>Simplified View</i></b>) are shown. Drag-drop any parameter 
+   from Workspace Explorer Parameters tree onto the empty Plot request form. 
+   You'll see <b><i>panel</i></b> and <b><i>parameter</i></b> elements.<br/><br/>
+   <p> Default plot type for <b><i>panel</i></b> is <b><i>Time Plot</i></b>.
+   Default drawing type for <b><i>parameter</i></b> is <b><i>Serie</i></b> attached to <b><i>Y left</i></b> axe.
+   You see these (current) settings next to the plot element.<br/><br/>
+   To modify an element settings just click it and all available options are shown on the right panel.<br/><br/> 
+   Note that at any moment you can modify any option for any element. <br/> We consider here the main options of  
+   <b><i>panel</i></b> and <b><i>parameter</i></b> elements. For more detals visit  <b>Plot In Details</b> section.
+<hr>
+	<h3>1. Panel Element and Its Main Settings</h3>		 
+	<img class="left" src="help/images/panelOptions.png"/>
+		<br/><hr><br/>
+<img align="left" src="help/images/panelTypes.png" style="margin: 0px 10px 10px 10px;"/>		
+<b><i>1.1. Plot type</i></b> defines panel type.<br/>
+<i>Time Plot</i> and <i>Scatter Plot</i> types are the mostly used.
+Fine plot type selection is being done with parameter <i>Drawing Type</i> option.<br/> 
+Panel can be defined to be <i>Isotropic</i> (the same 'unit' length in X and Y) for <i>Scatter Plot</i>. 
+<img align="right" src="help/images/panelScatter.png" style="margin: 10px 10px 10px 10px;"/> <br/><br/> <br/><br/><br/><br/><br/><br/><br/><br/>   
+<b><i>1.2. Preferred Dimensions</i></b> (panel dimensions) can vary between 0 and 1<br/><br/>
+<b><i>1.3. Title</i></b> defines panel title. <i>Font</i> settings in <i>Title</i> fieldset affects panel Title itself only.<br/><br/>
+<b><i>1.4. Font</i></b> settings are applied to all panel legends, titles, tickmars etc, except <i>panel Title</i>.
+<hr>
+<h3>2. Parameter Element and Its Main Settings</h3>
+<img align="left" src="help/images/paramElem.png" style="margin: 0px 0px 10px 0px;"/>
+<img align="right" src="help/images/paramOptions.png" style="margin: 0px 10px 10px 10px;"/>
+<b><i>2.1. Arguments </i></b> depend on parameter type. 
+For vector parameter, for example, it is vector components.<br/><br/>
+<b><i>2.2. Drawing Type</i></b> depends on selected panel <i>Plot type</i>.
+Namely with <i>Time Plot</i> panel setting you may select <i>Serie</i>, or <i>Spectro</i>, 
+or <i>StatusBar</i> <b><i>Drawing Type</i></b>.<br/>
+Note that on one <i>Time Plot</i> panel you may plot several parameters 
+with different drawing types (Serie, TickBar, StatusBar...).<br/><br/>
+<b><i>2.3. Y axis</i></b>  - left or right.<br/><br/>
+<b><i>2.4. Min/Max thresholds</i></b>. Values out of<i> Min/Max thresholds</i> are not shown on the plot. To modify
+X/Y range you have to uncheck <i>Simplified View</i> and read <b>Plot In Details / Axis</b> section<br/><br/><br/>  
+	<img align="left" src="help/images/image2.png" style="margin: 0px 0px 10px 0px;"/>
+<br/>	
+<b><i>2.5. Colored Parameter.</i></b> You may colorize plotted parameter with the value of another parameter 
+by its drag/drop onto this field.<br/>	<br/>	
+<b><i>2.6-2.7. Lines-Symbols.</i></b>	 Self-explanatory.<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>	 
+<hr>		 
+<h3>3.0 Parameter Element : Additional "Scatter" Settings</h3> 
+<img align="left" src="help/images/scatterParam.png" style="margin: 10px 10px 10px 0px;"/>  
+In case of <b><i>Scatter Plot</i></b> panel type you have to define for <b><i>parameter</i></b> element :<br/><br/>	
+3.1. Parameter to be used as X values<br/>
+3.2. X range ( optional )<br/>
+3.3. Reference parameter for resampling ( in case if "X" parameter and "Y" parameter originate from different datasets)<br/>
 \ No newline at end of file
 <h2><img src="js/resources/images/16x16/plot.png" style="margin: 0px 10px 0px 0px;"/>Plot Manager : Getting Started</h2>
 <p>
-All the Parameters from the WorkspaceExplorer Parameters subtree shown as a circle of any color are "plotable".  
-Drag the desired parameter[s] and drop onto any place at the <b><i>PlotManager</i></b> form.
+All the Parameters from the WorkspaceExplorer Parameters subtree shown as a circle are "plotable".  
+Drag the desired parameter[s] and drop onto left panel at the <b><i>PlotManager</i></b> form.
 Note that parameter names appeared in the Plot form could slightly differ 
 from those of the Workspace Explorer tree.</p>
 <br/>