source: Sophya/trunk/SophyaLib/Manual/piahelp.tex@ 3037

Last change on this file since 3037 was 2811, checked in by ansari, 20 years ago

MAJ tres partiel doc piapp , Reza 20/06/2005

File size: 84.9 KB
RevLine 
[2416]1% ----- Liste des groupes de Help -----
2List of {\bf piapp} on-line Help groups:
3\begin{itemize}
[2548]4\item {\bf Commander } (p. \pageref{Commander})
[2416]5\item {\bf CxxExecutorCmd } (p. \pageref{CxxExecutorCmd})
6\item {\bf Expr. Arithmetic } (p. \pageref{ExprZZArithmetic})
7\item {\bf Expr. Plotting } (p. \pageref{ExprZZPlotting})
8\item {\bf External Modules } (p. \pageref{ExternalZModules})
9\item {\bf FileIO } (p. \pageref{FileIO})
10\item {\bf Fitting } (p. \pageref{Fitting})
11\item {\bf Func Plot } (p. \pageref{FuncZPlot})
12\item {\bf Graphic-Elts } (p. \pageref{GraphicZElts})
13\item {\bf Graphics } (p. \pageref{Graphics})
14\item {\bf Obj. Display } (p. \pageref{ObjZZDisplay})
15\item {\bf Object Management } (p. \pageref{ObjectZManagement})
16\item {\bf Objects } (p. \pageref{Objects})
17\item {\bf PIACmd } (p. \pageref{PIACmd})
18\item {\bf SkyMapCmd } (p. \pageref{SkyMapCmd})
19\item {\bf SophyaCmd } (p. \pageref{SophyaCmd})
20\item {\bf pawCmd } (p. \pageref{pawCmd})
21\end{itemize}
22\vspace*{10mm}
23% ----- Liste de toutes les commandes et help item -----
24\vspace{5mm}
25\begin{center}
26 \rule{2cm}{1mm} List of {\bf piapp} Help items \rule{2cm}{1mm} \\
27\vspace{3mm}
28\begin{tabular}{llllll}
[2811]29CExpEvaluator & p. \pageref{CExpEvaluator} & Commander & p. \pageref{Commander} & ObjectExpressions & p. \pageref{ObjectExpressions} \\
30PIConsole & p. \pageref{PIConsole} & PIDraw3DWdg & p. \pageref{PIDraw3DWdg} & PIImage & p. \pageref{PIImage} \\
31PIScDrawWdg & p. \pageref{PIScDrawWdg} & RPNEvaluator & p. \pageref{RPNEvaluator} & Windows & p. \pageref{Windows} \\
32autoiniranf & p. \pageref{autoiniranf} & exitpiapp & p. \pageref{exitpiapp} & helpfit & p. \pageref{helpfit} \\
33helpwindow & p. \pageref{helpwindow} & shell execute & p. \pageref{shellZexecute} & stop & p. \pageref{stop} \\
[2416]34\end{tabular}
35\end{center}
36\newpage
37\vspace{6mm}
38\begin{center}
[2548]39 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Commander } help group} \rule{2cm}{0.5mm} \\
[2416]40\vspace{3mm}
41\begin{tabular}{llllll}
[2811]42CExpEvaluator & p. \pageref{CExpEvaluator} & Commander & p. \pageref{Commander} & RPNEvaluator & p. \pageref{RPNEvaluator} \\
43autoiniranf & p. \pageref{autoiniranf} & shell execute & p. \pageref{shellZexecute} & & \\
[2548]44\end{tabular}
45\end{center}
46\vspace{6mm}
47\begin{center}
48 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf CxxExecutorCmd } help group} \rule{2cm}{0.5mm} \\
49\vspace{3mm}
50\begin{tabular}{llllll}
[2416]51c++args & p. \pageref{cZZargs} & c++compile & p. \pageref{cZZcompile} & c++compileopt & p. \pageref{cZZcompileopt} \\
52c++create & p. \pageref{cZZcreate} & c++createfrf & p. \pageref{cZZcreatefrf} & c++declareomgvar & p. \pageref{cZZdeclareomgvar} \\
53c++exec & p. \pageref{cZZexec} & c++execfrf & p. \pageref{cZZexecfrf} & c++import & p. \pageref{cZZimport} \\
54c++include & p. \pageref{cZZinclude} & c++link & p. \pageref{cZZlink} & c++linkopt & p. \pageref{cZZlinkopt} \\
55c++mylibs & p. \pageref{cZZmylibs} & c++prtlevel & p. \pageref{cZZprtlevel} & & \\
56\end{tabular}
57\end{center}
58\vspace{6mm}
59\begin{center}
[2548]60 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Expr. Arithmetic } help group} \rule{2cm}{0.5mm} \\
[2416]61\vspace{3mm}
62\begin{tabular}{llllll}
63eval & p. \pageref{eval} & & & & \\
64\end{tabular}
65\end{center}
66\vspace{6mm}
67\begin{center}
[2548]68 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Expr. Plotting } help group} \rule{2cm}{0.5mm} \\
[2416]69\vspace{3mm}
70\begin{tabular}{llllll}
71ObjectExpressions & p. \pageref{ObjectExpressions} & exptovec & p. \pageref{exptovec} & fillgd1 & p. \pageref{fillgd1} \\
72fillgd2 & p. \pageref{fillgd2} & fillmtx & p. \pageref{fillmtx} & fillnt & p. \pageref{fillnt} \\
73fillvec & p. \pageref{fillvec} & gdfrvec & p. \pageref{gdfrvec} & ntexpcfile & p. \pageref{ntexpcfile} \\
74ntloop & p. \pageref{ntloop} & plot2d & p. \pageref{plot2d} & plot2de & p. \pageref{plot2de} \\
75plot2dvec & p. \pageref{plot2dvec} & plot2dw & p. \pageref{plot2dw} & plot3d & p. \pageref{plot3d} \\
76projh1d & p. \pageref{projh1d} & projh2d & p. \pageref{projh2d} & projprof & p. \pageref{projprof} \\
77\end{tabular}
78\end{center}
79\vspace{6mm}
80\begin{center}
[2548]81 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf External Modules } help group} \rule{2cm}{0.5mm} \\
[2416]82\vspace{3mm}
83\begin{tabular}{llllll}
84call & p. \pageref{call} & link & p. \pageref{link} & linkff2 & p. \pageref{linkff2} \\
85loadmodule & p. \pageref{loadmodule} & & & & \\
86\end{tabular}
87\end{center}
88\vspace{6mm}
89\begin{center}
[2548]90 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf FileIO } help group} \rule{2cm}{0.5mm} \\
[2416]91\vspace{3mm}
92\begin{tabular}{llllll}
93arrtoascii & p. \pageref{arrtoascii} & fitsadapt & p. \pageref{fitsadapt} & mtxfrascii & p. \pageref{mtxfrascii} \\
94ntfrascii & p. \pageref{ntfrascii} & openfits & p. \pageref{openfits} & openppf & p. \pageref{openppf} \\
95print & p. \pageref{print} & saveall & p. \pageref{saveall} & savefits & p. \pageref{savefits} \\
[2811]96savelist & p. \pageref{savelist} & saveobjs & p. \pageref{saveobjs} & saveppf & p. \pageref{saveppf} \\
97vecfrascii & p. \pageref{vecfrascii} & & & & \\
[2416]98\end{tabular}
99\end{center}
100\vspace{6mm}
101\begin{center}
[2548]102 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Fitting } help group} \rule{2cm}{0.5mm} \\
[2416]103\vspace{3mm}
104\begin{tabular}{llllll}
105helpfit & p. \pageref{helpfit} & crfitfil & p. \pageref{crfitfil} & crfitfun & p. \pageref{crfitfun} \\
106fit & p. \pageref{fit} & fitlin & p. \pageref{fitlin} & fitw & p. \pageref{fitw} \\
107\end{tabular}
108\end{center}
109\vspace{6mm}
110\begin{center}
[2548]111 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Func Plot } help group} \rule{2cm}{0.5mm} \\
[2416]112\vspace{3mm}
113\begin{tabular}{llllll}
114func & p. \pageref{func} & func2d & p. \pageref{func2d} & func2dff & p. \pageref{func2dff} \\
115funcff & p. \pageref{funcff} & & & & \\
116\end{tabular}
117\end{center}
118\vspace{6mm}
119\begin{center}
[2548]120 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Graphic-Elts } help group} \rule{2cm}{0.5mm} \\
[2416]121\vspace{3mm}
122\begin{tabular}{llllll}
123addarc & p. \pageref{addarc} & addarca & p. \pageref{addarca} & addarrow & p. \pageref{addarrow} \\
124addcirc & p. \pageref{addcirc} & addctext & p. \pageref{addctext} & addfarc & p. \pageref{addfarc} \\
[2811]125addfarca & p. \pageref{addfarca} & addfcirc & p. \pageref{addfcirc} & addfoval & p. \pageref{addfoval} \\
126addfpoly & p. \pageref{addfpoly} & addfrect & p. \pageref{addfrect} & addline & p. \pageref{addline} \\
127addmarker & p. \pageref{addmarker} & addoval & p. \pageref{addoval} & addpoly & p. \pageref{addpoly} \\
128addrect & p. \pageref{addrect} & addtext & p. \pageref{addtext} & & \\
[2416]129\end{tabular}
130\end{center}
131\vspace{6mm}
132\begin{center}
[2548]133 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Graphics } help group} \rule{2cm}{0.5mm} \\
[2416]134\vspace{3mm}
135\begin{tabular}{llllll}
136PIConsole & p. \pageref{PIConsole} & PIDraw3DWdg & p. \pageref{PIDraw3DWdg} & PIImage & p. \pageref{PIImage} \\
137PIScDrawWdg & p. \pageref{PIScDrawWdg} & Windows & p. \pageref{Windows} & addaxelabels & p. \pageref{addaxelabels} \\
138addtitle & p. \pageref{addtitle} & drpanel & p. \pageref{drpanel} & graphicatt & p. \pageref{graphicatt} \\
139imagcmap2eps & p. \pageref{imagcmap2eps} & imagcmap2ps & p. \pageref{imagcmap2ps} & newwin & p. \pageref{newwin} \\
140psclosefile & p. \pageref{psclosefile} & psgetfilename & p. \pageref{psgetfilename} & pssetfilename & p. \pageref{pssetfilename} \\
141setaxelabels & p. \pageref{setaxelabels} & setaxesatt & p. \pageref{setaxesatt} & setinsetlimits & p. \pageref{setinsetlimits} \\
142settitle & p. \pageref{settitle} & stacknext & p. \pageref{stacknext} & w2eps & p. \pageref{w2eps} \\
143w2ps & p. \pageref{w2ps} & zone & p. \pageref{zone} & & \\
144\end{tabular}
145\end{center}
146\vspace{6mm}
147\begin{center}
[2548]148 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Obj. Display } help group} \rule{2cm}{0.5mm} \\
[2416]149\vspace{3mm}
150\begin{tabular}{llllll}
[2811]151bargraph & p. \pageref{bargraph} & contour & p. \pageref{contour} & disp & p. \pageref{disp} \\
152gfd2d & p. \pageref{gfd2d} & gfd3d & p. \pageref{gfd3d} & imag & p. \pageref{imag} \\
153imagnav & p. \pageref{imagnav} & nt2d & p. \pageref{nt2d} & nt2dvec & p. \pageref{nt2dvec} \\
154nt3d & p. \pageref{nt3d} & ntcont & p. \pageref{ntcont} & surf & p. \pageref{surf} \\
155textdrawer & p. \pageref{textdrawer} & vecplot & p. \pageref{vecplot} & & \\
[2416]156\end{tabular}
157\end{center}
158\vspace{6mm}
159\begin{center}
[2548]160 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Object Management } help group} \rule{2cm}{0.5mm} \\
[2416]161\vspace{3mm}
162\begin{tabular}{llllll}
163cd & p. \pageref{cd} & copy & p. \pageref{copy} & cp & p. \pageref{cp} \\
164del & p. \pageref{del} & delobjs & p. \pageref{delobjs} & listdirs & p. \pageref{listdirs} \\
165listobjs & p. \pageref{listobjs} & mkdir & p. \pageref{mkdir} & mv & p. \pageref{mv} \\
166pwd & p. \pageref{pwd} & rename & p. \pageref{rename} & rm & p. \pageref{rm} \\
167rmdir & p. \pageref{rmdir} & setdiratt & p. \pageref{setdiratt} & & \\
168\end{tabular}
169\end{center}
170\vspace{6mm}
171\begin{center}
[2548]172 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf Objects } help group} \rule{2cm}{0.5mm} \\
[2416]173\vspace{3mm}
174\begin{tabular}{llllll}
[2811]175line2nt & p. \pageref{line2nt} & line2vec & p. \pageref{line2vec} & newdt & p. \pageref{newdt} \\
176newgfd & p. \pageref{newgfd} & newh1d & p. \pageref{newh1d} & newh2d & p. \pageref{newh2d} \\
177newmtx & p. \pageref{newmtx} & newnt & p. \pageref{newnt} & newprof & p. \pageref{newprof} \\
178newprofe & p. \pageref{newprofe} & newvec & p. \pageref{newvec} & ntcol2var & p. \pageref{ntcol2var} \\
179ntline2var & p. \pageref{ntline2var} & vec2var & p. \pageref{vec2var} & & \\
[2416]180\end{tabular}
181\end{center}
182\vspace{6mm}
183\begin{center}
[2548]184 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf PIACmd } help group} \rule{2cm}{0.5mm} \\
[2416]185\vspace{3mm}
186\begin{tabular}{llllll}
[2811]187exitpiapp & p. \pageref{exitpiapp} & helpwindow & p. \pageref{helpwindow} & stop & p. \pageref{stop} \\
[2416]188\end{tabular}
189\end{center}
190\vspace{6mm}
191\begin{center}
[2548]192 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf SkyMapCmd } help group} \rule{2cm}{0.5mm} \\
[2416]193\vspace{3mm}
194\begin{tabular}{llllll}
195alm2cl & p. \pageref{alm2cl} & alm2map & p. \pageref{alm2map} & cl2llcl & p. \pageref{cl2llcl} \\
196cl2map & p. \pageref{cl2map} & clmean & p. \pageref{clmean} & clmult & p. \pageref{clmult} \\
197clop & p. \pageref{clop} & clrebin & p. \pageref{clrebin} & crmapmask & p. \pageref{crmapmask} \\
198crmaskfrmap & p. \pageref{crmaskfrmap} & map2alm & p. \pageref{map2alm} & map2cl & p. \pageref{map2cl} \\
199map2double & p. \pageref{map2double} & map2float & p. \pageref{map2float} & map2local & p. \pageref{map2local} \\
200map2map & p. \pageref{map2map} & mapcover & p. \pageref{mapcover} & mapmult & p. \pageref{mapmult} \\
201mapop & p. \pageref{mapop} & maproj & p. \pageref{maproj} & mapstat & p. \pageref{mapstat} \\
202maskmap & p. \pageref{maskmap} & settypemap & p. \pageref{settypemap} & typemap & p. \pageref{typemap} \\
203\end{tabular}
204\end{center}
205\vspace{6mm}
206\begin{center}
[2548]207 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf SophyaCmd } help group} \rule{2cm}{0.5mm} \\
[2416]208\vspace{3mm}
209\begin{tabular}{llllll}
210mollgrid & p. \pageref{mollgrid} & mollgridsph & p. \pageref{mollgridsph} & powerspec & p. \pageref{powerspec} \\
[2811]211setprjmoldefval & p. \pageref{setprjmoldefval} & & & & \\
[2416]212\end{tabular}
213\end{center}
214\vspace{6mm}
215\begin{center}
[2548]216 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf pawCmd } help group} \rule{2cm}{0.5mm} \\
[2416]217\vspace{3mm}
218\begin{tabular}{llllll}
219h/cadd & p. \pageref{hZcadd} & h/cmult & p. \pageref{hZcmult} & h/copy & p. \pageref{hZcopy} \\
220h/deriv & p. \pageref{hZderiv} & h/err & p. \pageref{hZerr} & h/get\_vec & p. \pageref{hZgetZvec} \\
221h/integ & p. \pageref{hZinteg} & h/oper & p. \pageref{hZoper} & h/plot/2d & p. \pageref{hZplotZ2d} \\
222h/put\_vec & p. \pageref{hZputZvec} & h/rebin & p. \pageref{hZrebin} & h/set/cont & p. \pageref{hZsetZcont} \\
[2811]223h/set/err & p. \pageref{hZsetZerr} & n/merge & p. \pageref{nZmerge} & n/pl & p. \pageref{nZpl} \\
224n/plot & p. \pageref{nZplot} & n/proj & p. \pageref{nZproj} & n/read & p. \pageref{nZread} \\
[2416]225n/scan & p. \pageref{nZscan} & reset & p. \pageref{reset} & v/deriv & p. \pageref{vZderiv} \\
[2811]226v/integ & p. \pageref{vZinteg} & v/sort & p. \pageref{vZsort} & & \\
[2416]227\end{tabular}
228\end{center}
229% ----- Liste des commandes dans chaque groupe -----
230\newpage
[2548]231\subsection{Commander} \label{Commander}
232Basic (generic) interpreter (class SOPHYA::Commander) builtin commands
233 \\[2mm] \noindent
[2811]234\piahelpitem{CExpEvaluator} \label{CExpEvaluator}
235\begin{verbatim}
236> Evaluation of C-like expression (used in V = C-like-Expression)
237 >>> Arithmetic operators, parenthesis ( + - * / )
238 >>> Functions : sqrt fabs floor hypot
239 ... exp log log10 pow ; sinh cosh tanh
240 ... sin cos tan asin acos atan atan2
241 ... rand01() randpm1() gaurand()
242 >>> Constants : Pi = M_PI E = M_E
243 Example: x = 5.*(2.+sin(0.3*Pi))
244\end{verbatim}
[2548]245\piahelpitem{Commander} \label{Commander}
246\begin{verbatim}
247>>> (Commander) Interpreter's keywords :
[2811]248 > set varname string # To set a variable, $varname
[2548]249 > unset varname # clear variable definition
[2811]250 > rpneval varname RPNExpression # Reverse Polish Notation evaluation
251 > varname = ArithmeticExpression # C-like Expression evaluation
252 > varname = 'String' # Set variable vname
253 > var2words varname wordvarname [sep] # to break varname into words
[2548]254 > echo string # output string
255 > echo2file filename string # Append the string to the specified file
256 > alias name string # define a command alias
257 > foreach varname ( string-list ) # Loop
258 > for varname i1:i2[:di] # Integer loop
259 > for varname f1:f2[:df] # Float loop
[2811]260 > forinfile varname FileName # Loop over lines in file
[2548]261 > end # end loops
262 > if ( test ) then # Conditional test : a == != < > <= >= b
263 > else # Conditional
264 > endif # End of conditional if bloc
265 > break # Delete (clears) all test and loop blocs
266 > return # Stops command execution from a file
267 > defscript endscript # Command script definition
268 > listvars # List of variable names and values
269 > listalias # List of alias names and values
270 > listcommands # List of all known commands
271 > listscripts # List of all known scripts
272 > clearcript # Clear a script definition
[2811]273 > thrlist # List of command execution threads (& as the last character)
274 > clearthrlist # Removes finished threads from the list
275 > cancelthr Id # Cancel a given thread (ThrId=id)
276 > waitthr # Waits until all active threads have finished (join())
[2548]277 > exec filename # Execute commands from file
278 > help <command_name> # <command_name> usage info
[2811]279 > sleep nsec # sleep nsec seconds
280 > readstdin varname # reads a line from stdin into $varname
[2548]281 > timingon timingoff traceon traceoff
282
283\end{verbatim}
284\piahelpitem{RPNEvaluator} \label{RPNEvaluator}
285\begin{verbatim}
286 Reverse Polish Notation (HP calculator like) expression evaluation
287 >> Stack:
288 ... (4) (3) z=(2) y=(1) x=(0)=Stack.Top()
289 >> Examples:
290 - sin(PI/6): pi 6 / sin
291 - 1*2*...*5: 1 2 3 4 5 product
292 - x=x+y: x = $x $y *
293 >>> Stack operations :
294 print x<>y pop push (duplicate x)
295 >>> Constants (Cst pushed to stack):
296 pi e
297 >>> Arithmetic operators (x,y) --> x@y
298 + - * / % ( (int)y % (int)x )
299 >>> F(X): x --> F(x)
300 chs sqrt sq log log10 exp
301 fabs floor ceil
302 cos sin tan acos asin atan deg2rad rad2deg
303 >>> F(X,Y): (x,y) --> F(x,y)
304 pow atan2
305 >>> F(): random number generators
306 rand (flat 0..1) norand (normal/gaussian)
307 >>> Stack sum/product/mean/sigma/sigma^2
308 sum product mean sigma sigma2 sigmean (y->sigma x->mean)
309
310\end{verbatim}
311\piahelpitem{autoiniranf} \label{autoiniranf}
312\begin{verbatim}
313> Automatic random number generator initialisation
314 by Auto_Ini_Ranf(int lp)
315 Usage: autoiniranf
316\end{verbatim}
317\piahelpitem{shell execute} \label{shellZexecute}
318\begin{verbatim}
319> shell command_string # Execute shell command
320> cshell command_string # Execute cshell command
321---Examples:
322 > shell ls
323 > cshell echo '$LD_LIBRARY_PATH'; map2cl -h; ls
324 > shell myfile.csh [arg1] [arg2] [...]
325 (where the first line of "myfile.csh" is "#!/bin/csh")
326
327\end{verbatim}
[2416]328\subsection{CxxExecutorCmd} \label{CxxExecutorCmd}
329\noindent
330\piacommand{c++args} \label{cZZargs}
331\begin{verbatim}
332c++args: Define user function arguments for c++exec and c++execfrf
333Usage: c++args arg1 arg2 arg3 ...
334 c++args -? : give current arguments
335 c++args : reset current arguments
336\end{verbatim}
337\piacommand{c++compile} \label{cZZcompile}
338\begin{verbatim}
339c++compile: compile a file (file.cc -> file.so)
340Usage: c++compile file
341Warning: give "file" or "file.so" to create "file.so" from "file.cc"
342 : to be used before c++link
343\end{verbatim}
344\piacommand{c++compileopt} \label{cZZcompileopt}
345\begin{verbatim}
346c++compileopt: add personnal compile options
347Usage: c++compileopt -g -O5 -IMy_Inc_Dir ...
348 c++compileopt -? : list current additionnal compile options
349 c++compileopt : reset to no additionnal compile options
350Warning: to be used before c++create c++compile c++exec ...
351\end{verbatim}
352\piacommand{c++create} \label{cZZcreate}
353\begin{verbatim}
354c++create: create a file "file.cc" to be used by spiapp
355Usage: c++create file.cc func c++ user code...
356
357\end{verbatim}
358\piacommand{c++createfrf} \label{cZZcreatefrf}
359\begin{verbatim}
360c++createfrf: create a file "file.cc" to be used by spiapp
361 with a user file code "fileuser.cc"
362 and an optional user function code "fileuserfct.cc"
363Usage: c++createfrf file.cc func fileuser.cc [fileuserfct.cc]
364
365\end{verbatim}
366\piacommand{c++declareomgvar} \label{cZZdeclareomgvar}
367\begin{verbatim}
368c++declareomgvar: Activate/Deactivate ObjectManager variables declaration
369Usage: c++declareomgvar [false/true]
370 if true, the ObjectManager variables are declared as $varname
371 no arguments: display the current status of the flag (default=false
372
373\end{verbatim}
374\piacommand{c++exec} \label{cZZexec}
375\begin{verbatim}
376c++exec: Execute the following c++ user code
377Usage: c++exec c++ user code
378Warning: c++ user code can be found in "TmpDir/cxx_spiapp.h"
379 total generated code can be found in "TmpDir/cxx_spiapp.cc"
380\end{verbatim}
381\piacommand{c++execfrf} \label{cZZexecfrf}
382\begin{verbatim}
383c++execfrf: Execute c++ user_code [user_function_code]
384Usage: c++execfrf fileuser.cc [fileuserfct.cc]
385Warning: total generated code can be found in "TmpDir/cxx_spiapp.cc"
386\end{verbatim}
387\piacommand{c++import} \label{cZZimport}
388\begin{verbatim}
389c++import: Sophya additionnal modules to be use in C++ executor
390Usage: c++import module1 ... : set list of modules to be used by executor
391 c++import all : set all modules known by executor
392 c++import : reset to no additionnal module
393 c++import -? : list modules currently used in executor
394 c++import -?? : list of available modules for executor
395Warning: to be used before c++create c++compile c++exec ...
396\end{verbatim}
397\piacommand{c++include} \label{cZZinclude}
398\begin{verbatim}
399c++include: add personnal includes to be used by executor
400Usage: c++include myinc1.h myinc2.h ...
401 c++include -? : list current additionnal include files
402 c++include : reset to no additionnal include files
403Warning: to be used before c++create c++compile c++exec...
404\end{verbatim}
405\piacommand{c++link} \label{cZZlink}
406\begin{verbatim}
407c++link: link function "func" in file.so to spiapp
408Usage: c++link file.so func
409\end{verbatim}
410\piacommand{c++linkopt} \label{cZZlinkopt}
411\begin{verbatim}
412c++linkopt: add personnal link options
413Usage: c++linkopt -g -O5 ...
414 c++linkopt -? : list current additionnal link options
415 c++linkopt : reset to no additionnal link options
416Warning: to be used before c++create c++compile c++exec ...
417\end{verbatim}
418\piacommand{c++mylibs} \label{cZZmylibs}
419\begin{verbatim}
420c++mylibs: add personnal libraries
421Usage: c++mylibs -LMy_Lib_Dir -lmylib1 -lmylib2 ...
422 c++mylibs -? : list current additionnal libraries
423 c++mylibs : reset to no additionnal libraries
424Warning: to be used before c++create c++compile c++exec ...
425\end{verbatim}
426\piacommand{c++prtlevel} \label{cZZprtlevel}
427\begin{verbatim}
428c++prtlevel: Print level
429Usage: c++prtlevel prtlevel
430 prtlevel=0 : minimum printing
431 prtlevel=1 : + compiler/linker output
432 prtlevel=2 : + full infos (default)
433\end{verbatim}
434\subsection{Expr. Arithmetic} \label{ExprZZArithmetic}
435\noindent
436\piacommand{eval} \label{eval}
437\begin{verbatim}
438Compute arithmetic expression
439
440 Usage: eval resultvarname arithmetic expression....
441 resultvarname: store result in variable resultvarname
442 - If first character is not alphabetic, just print result
443 arithmetic expression:
444 ex: x + sqrt(y)+z +3.14 (x,y,z are variables)
445 ex: $x + sqrt($y)+$z +3.14 (x,y,z are variables)
446 ex: 360 * M_PI / 180.
447\end{verbatim}
448\subsection{Expr. Plotting} \label{ExprZZPlotting}
449\noindent
450\piahelpitem{ObjectExpressions} \label{ObjectExpressions}
451\begin{verbatim}
452Any mathematical expression (math.h) with object variables can be used
453 ------ Object Variable names (double) --------
454 (_nl is the table line number or the sequential index)
455- NTuple: ntuple variable names,_nl
456- Histo1D/HProf: i,x,val,err,_nl
457- Histo2D: i,j,x,y,val,err,_nl
458- Vector/Matrix: n,r,c,val,real,imag,mod,phas,_nl
459- TArray: n,x,y,z,t,u,val,real,imag,mod,phas,_nl
460- Image: i,j,x,y,val(=pix),_nl
461- GeneralFitData: x0,ex0 x1,ex1 ... xn,exn y,ey ok ,_nl
462- LocalMap/SphereThetaPhi/SphereHEALPix:
463- i,k,val,real,imag,mod,phas,teta,phi,_nl
464- FITS Binary/ASCII table: fits column names,_nl
465 ------ Other parameters --------
466Loop parameters can be specified as I1[:I2[:DI]] for(int i=I1; i<I2; i+=DI)
467The default Cut() expression in true (=1) for all
468
469 Related commands: plot2d plot2de plot2dw plot3d
470 projh1d projh2d projprof fillvec fillmtx
471 fillnt fillgd1 fillgd2 ntloop exptovec ...
472\end{verbatim}
473\piacommand{exptovec} \label{exptovec}
474\begin{verbatim}
475Creates and Fills a Vector with X=f(Object)
476 Usage: exptovec namevec nameobj f_X() [Cut() graphic_attributes loop_param]
477 Related commands: ntloop fillnt ObjectExpressions ...
478\end{verbatim}
479\piacommand{fillgd1} \label{fillgd1}
480\begin{verbatim}
481Creates and Fills a GeneralFitData with (X=f(Object), Y=g(...), ErrY=h(...))
482 Usage: fillgd1 namegfd nameobj f_X() g_Y() h_ErrY() [Cut() loop_param]
483 Related commands: ntloop fillnt ObjectExpressions ...
484\end{verbatim}
485\piacommand{fillgd2} \label{fillgd2}
486\begin{verbatim}
487Creates and Fills a GeneralFitData with (X=f(Object), Y=g(...), Z=h(...)) ErrZ=k(...)
488 Usage: fillgd1 namegfd nameobj f_X() g_Y() h_Z() k_ErrZ() [Cut() loop_param]
489 Related commands: ntloop fillnt ObjectExpressions ...
490\end{verbatim}
491\piacommand{fillmtx} \label{fillmtx}
492\begin{verbatim}
493Fills a Matrix M(Line=g_Y(Object)+0.5, Col=f_X(Object)+0.5)) = h_V(Object)
494 Usage: fillvec namevec nameobj f_X() g_Y() h_V() [Cut() graphic_attributes loop_param]
495 Related commands: fillvec fillnt ObjectExpressions ...
496\end{verbatim}
497\piacommand{fillnt} \label{fillnt}
498\begin{verbatim}
499Creates and Fills an NTuple(x,y,z,t) with (X=f(Object),Y=g(...),Z=h(...),T=k(...))
500 Usage: fillnt nameobj f_X() g_Y() h_Z() k_T() [Cut() nameNt loop_param]
501 Related commands: ntloop plot2d projh1d projh2d projprof
502 Related commands: fillvec fillmtx ntloop exptovec fillgd1 fillgd2 ObjectExpressions ...
503\end{verbatim}
504\piacommand{fillvec} \label{fillvec}
505\begin{verbatim}
506Fills a Vector V((int)(f_X(Object)+0.5)) = h_V(Object)
507 Usage: fillvec namevec nameobj f_X() h_V() [Cut() graphic_attributes loop_param]
508 Related commands: fillmtx fillnt ObjectExpressions ...
509\end{verbatim}
510\piacommand{gdfrvec} \label{gdfrvec}
511\begin{verbatim}
512Fills a GeneralFitData with vectors X,Y,Z,EZ
513 Usage: gdfrvec namegfd X Y
514 Usage: gdfrvec namegfd X Y ! EY
515 Usage: gdfrvec namegfd X Y Z
516 Usage: gdfrvec namegfd X Y Z EZ
517 Related commands: fillgd1 fillgd2 ...
518\end{verbatim}
519\piacommand{ntexpcfile} \label{ntexpcfile}
520\begin{verbatim}
521Creates a C-File with declarations suitable to be used for ntloop
522 Usage: ntexpcfile nameobj CFileName FuncName
523 Related commands: ntloop
524\end{verbatim}
525\piacommand{ntloop} \label{ntloop}
526\begin{verbatim}
527Loops over an Object NTupleInterface calling a function from a C-file
528and optionaly fills an NTuple(x,y,z,t) with (X=f(Object),Y=g(...),Z=h(...),T=k(...))
529 Usage: ntloop nameobj CFileName FuncName [NtupleName loop_param]
530 Related commands: fillvec fillmtx fillnt fillgd1 fillgd2 exptovec ObjectExpressions ...
531 Related commands: ntexpcfile fillnt
532\end{verbatim}
533\piacommand{plot2d} \label{plot2d}
534\begin{verbatim}
535Plots (2D) Y=g(Object) vs. X=f(Object) --- Object Variable names (double) :
536 Usage: plot2d nameobj f_X() g_Y() [f_Cut() graphic_attributes loop_param]
537 Related commands: plot2de plot2dw plot3d ObjectExpressions ...
538\end{verbatim}
539\piacommand{plot2de} \label{plot2de}
540\begin{verbatim}
541Plots (2D) Y=g(Object) vs. X=f(Object) with error bars eX/Y=f_ErrX/Y(Object)
542 Usage: plot2de nameobj f_X() g_Y() f_ErrX() f_ErrY() [f_Cut() graphic_attributes loop_param]
543 Related commands: plot2d plot2dw plot3d ObjectExpressions ...
544\end{verbatim}
545\piacommand{plot2dvec} \label{plot2dvec}
546\begin{verbatim}
547Creates and displays a flow chart from ntuple expressions
548 Usage: plot2dvec ntuple expx expy expvx expvy [cut graphic_att loop_par]
549\end{verbatim}
550\piacommand{plot2dw} \label{plot2dw}
551\begin{verbatim}
552Plots (2D) Y=g(Object) vs. X=f(Object) with Weight W=h(Object)
553 Usage: plot2dw nameobj f_X() g_Y() h_Wt() [Cut() graphic_attributes loop_param]
554 Related commands: plot2d plot2dw plot3d ObjectExpressions ...
555\end{verbatim}
556\piacommand{plot3d} \label{plot3d}
557\begin{verbatim}
558Plots (3D) Z=h(Object) vs. Y=g(Object) vs. X=f(Object) vs
559 Usage: plot3d nameobj f_X() g_Y() h_Z() [Cut() graphic_attributes loop_param]
560 Related commands: plot2d plot2dw plot2de plot3d ObjectExpressions ...
561\end{verbatim}
562\piacommand{projh1d} \label{projh1d}
563\begin{verbatim}
564Projects X=f(Object) with weight WT=h(Object) into a 1D histogram
565 Usage: projh1d nameh1d nameobj f_X() [h_WT()=1. Cut() graphic_attributes loop_param]
566 Histo1D nameh1d is created if necessary
567 Related commands: projh2d projprof ObjectExpressions ...
568\end{verbatim}
569\piacommand{projh2d} \label{projh2d}
570\begin{verbatim}
571Projects (X=f(Object),Y=g(Object)) with weight WT=h(Object) into a 2D histogram
572 Usage: projh2d nameh2d nameobj f_X() g_Y() [h_WT()=1. Cut() graphic_attributes loop_param]
573 Histo2D nameh2d is created if necessary
574 Related commands: projh1d projprof ObjectExpressions ...
575\end{verbatim}
576\piacommand{projprof} \label{projprof}
577\begin{verbatim}
578Projects (X=f(Object),Y=g(Object)) with weight WT=h(Object) into a profile histogram
579 Usage: projprof nameprof nameobj f_X() g_Y() [h_WT()=1. Cut() graphic_attributes loop_param]
580 HProf nameprof is created if necessary
581 Related commands: projh1d projh2d ObjectExpressions ...
582\end{verbatim}
583\subsection{External Modules} \label{ExternalZModules}
[2548]584Dynamic load (shared object modules) management command group
585 \\[2mm] \noindent
[2416]586\piacommand{call} \label{call}
587\begin{verbatim}
588Dynamically linked user function call
589 Usage: call userf [arg1 arg2 ...]
590 User function : f(vector<string>& args)
591 Related commands: link
592\end{verbatim}
593\piacommand{link} \label{link}
594\begin{verbatim}
595Dynamic linking of compiled user functions
596 Usage: link fnameso f1 [f2 f3]
597 fnameso: Shared-object file name, f1,f2,f3 : User function names
598 Related commands: call loadmodule linkff2
599\end{verbatim}
600\piacommand{linkff2} \label{linkff2}
601\begin{verbatim}
602Dynamic linking of compiled user functions (Set 2)
603 Usage: linkff2 fnameso f1 [f2 f3]
604 fnameso: Shared-object file name, f1,f2,f3 : User function names
605 Related commands: call link loadmodule
606\end{verbatim}
607\piacommand{loadmodule} \label{loadmodule}
608\begin{verbatim}
609To load and initialize modules
610 Usage: loadmodule fnameso modulename
611 Related commands: link
612\end{verbatim}
613\subsection{FileIO} \label{FileIO}
614\noindent
615\piacommand{arrtoascii} \label{arrtoascii}
616\begin{verbatim}
617Writes an array (TArray<T>) to an ASCII file
618 Usage: arrtoascii array_name file_name
619 Related commands: mtxfrascii vecfrascii ntfrascii
620\end{verbatim}
621\piacommand{fitsadapt} \label{fitsadapt}
622\begin{verbatim}
623fitsadapt: NTuple adaptor for Binary and ASCII Fits table
624Usage: fitsadapt fitsfile [nomobj hdu buflen[,bufsens,lp]]
625 fitsfile : Fits file name
626 nomobj : Object name (needed if file name misleading as C++ variable)
627 hdu : Fits HDU (if <=0 take first binary/ascii table)
628 buflen[,bufsens,lp] : buffer length (sens) for fits reading (default is 100,1,0)
629\end{verbatim}
630\piacommand{mtxfrascii} \label{mtxfrascii}
631\begin{verbatim}
632Reads a matrix from an ASCII file (TMatrix<r_8>)
633 Usage: mtxfrascii mtx_name file_name [CommChar Separator]
634 Related commands: arrtoascii vecfrascii ntfrascii
635\end{verbatim}
636\piacommand{ntfrascii} \label{ntfrascii}
637\begin{verbatim}
[2811]638Fills an existing NTuple or DataTable from ASCII table file
[2416]639 Usage: ntfrascii nt_name file_name [def_init_val]
640 Related commands: ntloop fillnt
641\end{verbatim}
642\piacommand{openfits} \label{openfits}
643\begin{verbatim}
644Loads a FITS file into an appropriate object
645 Usage: openfits filename
646 Related commands: savefits openppf
647\end{verbatim}
648\piacommand{openppf} \label{openppf}
649\begin{verbatim}
[2811]650Reads all or some objects from a PPF file
651 Usage: openppf filename [objname1 objname2 ...]
[2416]652 Related commands: saveall openfits
653\end{verbatim}
654\piacommand{print} \label{print}
655\begin{verbatim}
656Prints an object
657 Usage: print nameobj
658\end{verbatim}
659\piacommand{saveall} \label{saveall}
660\begin{verbatim}
661Saves all objects into a PPF file
662 Usage: saveall filename
[2811]663 Related commands: saveobj savelist openppf savefits
[2416]664\end{verbatim}
665\piacommand{savefits} \label{savefits}
666\begin{verbatim}
667Save an object into a FITS file
668 Usage: savefits nameobj filename
669 Related commands: openfits saveobjs saveall
670\end{verbatim}
[2811]671\piacommand{savelist} \label{savelist}
672\begin{verbatim}
673
674 Usage: savelist objname1 [objname2 ...] filename
675 Related commands: saveobj openppf savefits
676\end{verbatim}
[2416]677\piacommand{saveobjs} \label{saveobjs}
678\begin{verbatim}
679Saves objects with names matching a pattern into a
680 PPF file (pattern: x?y*) - Alias saveppf
681Usage: saveobjs nameobjpattern filename
[2811]682 Related commands: saveppf savelist saveall openppf savefits
[2416]683\end{verbatim}
684\piacommand{saveppf} \label{saveppf}
685\begin{verbatim}
686Saves objects with names matching a pattern into a
687 PPF file (pattern: x?y*) - Alias saveppf
688Usage: saveppf nameobjpattern filename
[2811]689 Related commands: saveobjs savelist saveall openppf savefits
[2416]690\end{verbatim}
691\piacommand{vecfrascii} \label{vecfrascii}
692\begin{verbatim}
693Reads a vector from an ASCII file (TVector<r_8>)
694 Usage: vecfrascii vec_name file_name
695 Related commands: arrtoascii mtxfrascii ntfrascii [CommChar Separator]
696\end{verbatim}
697\subsection{Fitting} \label{Fitting}
698\noindent
699\piahelpitem{helpfit} \label{helpfit}
700\begin{verbatim}
701
702//////////////////////////////////////////////////////////////////////
703| --------------- Fit Lineaire a 1 et 2 dimensions ---------------
704| Syntaxe:
705| fitlin nom pnn [o:.aa,bb,cc, o:dd,ee,ff o:gg,hh,jj,kk etc...]
706| avec:
707| nom : cf commentaire ordre ''fit''
708| pnn : fit polynome degre nn avec classe Poly (lineaire) 1D ou 2D
709| o:aa,...,bb : cf commentaires ordre ''fit''
710|
711//////////////////////////////////////////////////////////////////////
712| --------------- Fit d'objets a 1 et 2 dimensions ---------------
713| avec interface d'aide graphique
714| Syntaxe:
715| fitw nom func
716| [p:p1,p2,...,pn s:s1,s2,...,sn m:m1,m2,...,mn M:M1,mM2,...,Mn f:f1,...,fn]
717| [o:.aa,bb,cc, o:dd,ee,ff o:gg,hh,jj,kk etc...]
718| cf commentaire ordre ''fit''
719|
720//////////////////////////////////////////////////////////////////////
721| --------------- Fit d'objets a 1 et 2 dimensions ---------------
722| Syntaxe:
723| fit nom func
724| [p:p1,p2,...,pn s:s1,s2,...,sn m:m1,m2,...,mn M:M1,mM2,...,Mn f:f1,...,fn]
725| [o:.aa,bb,cc, o:dd,ee,ff o:gg,hh,jj,kk etc...]
726|----- OBJET -----
727| nom : nom de l'objet qui peut etre:
728| fit-1D: Vector,Histo1D,HProf ou GeneraFitData(1D)
729| fit-2D: Matrix,Histo2D,Image<T> ou GeneraFitData(2D)
730|
731|----- FUNCTION -----
732| func : pnn : fit polynome degre nn avec GeneralFit (non-lineaire) 1D ou 2D
733| : gnn : fit gaussienne (hauteur) + polynome de degre nn 1D
734| : g : fit gaussienne (hauteur) 1D
735| : enn : fit exponentielle + polynome de degre nn 1D
736| : e : fit exponentielle 1D
737| : Gnn : fit gaussienne (volume) + polynome de degre nn 1D
738| : G : fit gaussienne (volume) 1D
739| : : fit gaussienne+fond (volume) 2D
740| : Gi : fit gaussienne+fond integree (volume) 2D
741| : d : fit DL de gaussienne+fond (volume) 2D
742| : di : fit DL de gaussienne+fond integree (volume) 2D
743| : D : fit DL de gaussienne+fond avec coeff variable p6 (volume) 2D
744| : Di : fit DL de gaussienne+fond integree avec coeff variable p6 (volume) 2D
745| : M : fit Moffat+fond (expos=p6) (volume) 2D
746| : Mi : fit Moffat+fond integree (expos=p6) (volume) 2D
747| : Autre : fonction definie par l'utilisateur (cf commentaires ci apres)
748|
749|----- INIT PARAMETRES ET ETAT DU FIT -----
750| p : p1,...,pn : valeur d'initialisation des parametres (def=0)
751| s : s1,...,sn : valeur des steps de depart (def=1)
752| m : m1,...,mn : valeur des minima (def=1)
753| M : M1,...,Mn : valeur des maxima (def=-1) (max<=min : pas de limite)
754| f : f1,...,fn : si >=1 parametre fixe sinon libre (def=0)
755| - Remarque: si pi,si,mi ou Mi = '!' la valeur correspondante n'est pas changee
756|
757|----- OPTIONS -----
758| o : options ''o:Eaa.b,eaa.b,f,r,caa.b,Xaa.b''
759| F : initialisation a partir des resultats et de l'etat du fit precedent
760| (option non prioritaire sur les definitions p:,s:,m:,M:,f:o:)
761| a : initialisation automatique des parametres du fit (si disponible)
762| (option non prioritaire sur les definitions p:,s:,m:,M:,f:o:
763| et sur l'initialisation pa l'option ''F'')
764| f : generation d'un Objet identique contenant la fonction fittee
765| r : generation d'un Objet identique contenant les residus
766| Xaa.b : aa.b valeur du DXi2 d'arret (def=1.e-3)
767| Naa : aa nombre maximum d'iterations (def=100)
768| la : niveau ''a'' de print: a=niveau de print Fit1/2D
769| da : niveau ''a'' de debug: a=niveau de GeneralFit
770| Ii1/i2 : numeros des bins X de l'histos utilises pour le fit [i1,i2]
771|2D Jj1/j2 : numeros des bins Y de l'histos utilises pour le fit [j1,j2]
772| - Traitement des erreurs :
773| Par defaut, l'erreur est celle associee a l'objet (si elle existe),
774| elle est mise a 1 sinon.
775| haa.b/cc.d : erreur = aa.bb*(erreur associee a l'objet cf ci-dessus)
776| Haa.b/cc.d : erreur = aa.b*|val|
777| eaa.b/cc.d : erreur = aa.b
778| Eaa.b/cc.d : erreur = aa.b*sqrt(|val|)
779| aa.b<0 (ou non precise) est equivalent aa.b=1.0
780| cc.d non precise est equivalent a cc.d=0
781| si cc.d>=0 si erreur>0 erreur = max(erreur,cc.d)
782| si erreur<=0 alors erreur
783| si cc.d<0 si erreur>0 erreur = max(erreur,|cc.d|)
784| si erreur<=0 alors erreur=|cc.d|
785| xaa.b : demande de centrage: on fit x-aa.b au lieu de x)
786| x : demande de centrage: on fit x-xc au lieu de x
787| avec xc=abscisse du ''milieu logique'' de l'objet.
788| Actif pour exp+poly 1D, poly 1D
789| Pour gauss+poly 1D, xc est le centre de la gaussienne.
790|2D yaa.b et y : idem ''xaa.b et x'' mais pour y
791|
792//////////////////////////////////////////////////////////////////////
793| --------------- Def des fcts de fit par l'utilisateur ---------------
794| Pour definir une fonction parametree utilisateur:
795| Un exemple de fichier contenant des fonctions a fitter: PIext/userfitfunex.c
796| > crfitfil nom_fichier nom_fonction nvar npar
797| pour creer un squelette de fichier C contenant la fonction a fitter
798| nom_fichier : nom du fichier ou est le code de la fonction
799| c'est un fichier C de nom blabla.c
800| nom_fonction : nom de la fonction ex: gauss2
801| nvar : nombre de variables x[] (1D=1, 2D=2, etc...)
802| npar : nombre de parametre p[]
803| - La fonction est donc F(x[];p[]), soit par ex:
804| double gauss2(double const* x,double const* p)
805| - L'utilisateur a la possibilite de donner egalement la fonction
806| retournant les derivees de la fonction par rapport aux parametres
807| double gauss2_der(double const* x,double const* p,double* dp)
808| ou dp[i] = dF(x[];p[])/dp[i]
809| Par convention, cette fonction a le meme nom suivi de ''_der''
810| > crfitfun nom_fichier nom_fonction nvar npar
811| Permet de compiler le fichier ''nom_fichier'' et de linker
812| la fonction ''nom_fonction''
813| - Un meme fichier peut contenir plusieurs fonctions a fitter
814|
815//////////////////////////////////////////////////////////////////////
816\end{verbatim}
817\piacommand{crfitfil} \label{crfitfil}
818\begin{verbatim}
819Creation de fichier C pour function utilisateur du fit
820 Usage: crfitfil file func nvar npar
821 Related commands: fit fitw fitlin crfitfun
822\end{verbatim}
823\piacommand{crfitfun} \label{crfitfun}
824\begin{verbatim}
825Creation et link de function utilisateur pour le fit
826 Usage: crfitfun file func nvar npar
827 Related commands: fit fitw fitlin crfitfil
828\end{verbatim}
829\piacommand{fit} \label{fit}
830\begin{verbatim}
831Fitting function to DataObjects (Histo, Histo2D, Vector, ...)
832 Usage: fit nomobj func [Options]
833 [p:p1,...,pn s:s1,...,sn m:m1,...,mn M:M1,...,Mn o:... o:...]
834 Related commands: fitw fitlin crfitfun crfitfil
835\end{verbatim}
836\piacommand{fitlin} \label{fitlin}
837\begin{verbatim}
838Linear Fitting of Polynoms to DataObjects
839 Usage: fitlin nomobj func [o:... o:...]
840 Related commands: fit fitw crfitfun crfitfil
841\end{verbatim}
842\piacommand{fitw} \label{fitw}
843\begin{verbatim}
844Fitting function to DataObjects with Interactive Window Help
845 Usage: fitw nomobj func [Options]
846 [p:p1,...,pn s:s1,...,sn m:m1,...,mn M:M1,...,Mn o:... o:...]
847 Related commands: fit fitlin crfitfun crfitfil
848\end{verbatim}
849\subsection{Func Plot} \label{FuncZPlot}
850\noindent
851\piacommand{func} \label{func}
852\begin{verbatim}
853Displays a function y=f(x) (Fills a vector with function values)
854 Usage: func f(x) xmin xmax [npt graphic_attributes]
855 Related commands: funcff func2d func2dff
856\end{verbatim}
857\piacommand{func2d} \label{func2d}
858\begin{verbatim}
859Displays a function z=f(x,y) (Fills a matrix with function values)
860 Usage: func2d f(x,y) xmin xmax nptx ymin ymax npty [graphic_attributes]
861 Related commands: func
862\end{verbatim}
863\piacommand{func2dff} \label{func2dff}
864\begin{verbatim}
865Displays a function z=f(x,y) from a C-file (Fills a matrix with function values)
866 Usage: func2dff C-FileName FunctionName xmin xmax nptx ymin ymax npty [graphic_attributes]
867 Related commands: func funcff func2d
868\end{verbatim}
869\piacommand{funcff} \label{funcff}
870\begin{verbatim}
871Displays a function y=f(x) from a C-file (Fills a vector with function values)
872 Usage: funcff C-FileName FunctionName xmin xmax [npt graphic_attributes]
873 Related commands: func func2d func2dff
874\end{verbatim}
875\subsection{Graphic-Elts} \label{GraphicZElts}
876\noindent
877\piacommand{addarc} \label{addarc}
878\begin{verbatim}
879Adds an arc to the current graphic object
880 defined by 3 points (+ graphic attribute)
881 The Base/AxesDrawer is used to handle added arcs
882 Alt<E> to remove the added element
883 Usage: addarc x1 y1 x2 y2 x3 y3 [GraphicAtt] [fgnc=false/true]
884 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
885 Related commands: addtext addline addarrow addfrect addfrect
886 addcirc addfcirc addfarc addarca addpoly addfpoly graphicatt
887\end{verbatim}
888\piacommand{addarca} \label{addarca}
889\begin{verbatim}
890Adds an arc to the current graphic object
891 defined by the circle (center+radius), start angle and angular extension
892 Angles are specified in degrees
893 Usage: addarca xc yc r a0deg dadeg [GraphicAtt] [fgnc=false/true]
894 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
895 Related commands: addtext addline addfarca addarc ...
896\end{verbatim}
897\piacommand{addarrow} \label{addarrow}
898\begin{verbatim}
899Adds an arrow to the current graphic object
900 at the specified position (+ graphic attribute)
901 The Base/AxesDrawer is used to handle added lines
902 Alt<E> to remove the added element
903 Usage: addarrow x1 y1 x2 y2 [GraphicAtt] [fgnc=false/true]
904 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
905 Related commands: addline addtext addrect addfrect
906 addmarker addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
907\end{verbatim}
908\piacommand{addcirc} \label{addcirc}
909\begin{verbatim}
910Adds a circle to the current graphic object
911 with the specified center and radius (+ graphic attribute)
912 The Base/AxesDrawer is used to handle added circles
913 Alt<E> to remove added element
914 Usage: addcirc xcenter ycenter radius [GraphicAtt] [fgnc=false/true]
915 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
916 Related commands: addtext addline addarrow addfrect addfrect
917 addfcirc addarc addfarc addpoly addfpoly graphicatt
918\end{verbatim}
919\piacommand{addctext} \label{addctext}
920\begin{verbatim}
921Adds a composite text string with superscript and subscripts
922 at the specified position (+ color/font/pos/dir attributes)
923 Usage: addctext x y Text sUp sDown [ColFontPosAtt] [UpDownFontAtt] [fgnc]
924 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
925 Related commands: addtext addline addrect ...
926 (See command addtext and graphicatt for more details)
927\end{verbatim}
928\piacommand{addfarc} \label{addfarc}
929\begin{verbatim}
930Adds a filled arc to the current graphic object
931 defined by 3 points (+ graphic attribute)
932 The Base/AxesDrawer is used to handle added arcs
933 Alt<E> to remove added element
934 Usage: addarc x1 y1 x2 y2 x3 y3 [GraphicAtt] [fgnc=false/true]
935 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
936 Related commands: addtext addline addarrow addfrect addfrect
937 addcirc addfcirc addfarc addpoly addfpoly graphicatt
938\end{verbatim}
939\piacommand{addfarca} \label{addfarca}
940\begin{verbatim}
941Adds a filled arc to the current graphic object
942 defined by the circle (center+radius), start angle and angular extension
943 Angles are specified in degrees
944 Usage: addfarca xc yc r a0deg dadeg [GraphicAtt] [fgnc=false/true]
945 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
946 Related commands: addtext addline addarca addarc ...
947\end{verbatim}
948\piacommand{addfcirc} \label{addfcirc}
949\begin{verbatim}
950Adds a filled circle to the current graphic object
951 with the specified center and radius (+ graphic attribute)
952 The Base/AxesDrawer is used to handle added circles
953 Alt<E> to remove added element
954 Usage: addcirc xcenter ycenter radius [GraphicAtt] [fgnc=false/true]
955 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
956 Related commands: addtext addline addarrow addfrect addfrect
957 addcirc addarc addfarc addpoly addfpoly graphicatt
958\end{verbatim}
[2811]959\piacommand{addfoval} \label{addfoval}
960\begin{verbatim}
961Adds a filled oval (ellipse) to the current graphic object
962 centered on xc,yc - semi-axis ds,dy (+ graphic attribute)
963 The Base/AxesDrawer is used to handle added rectangle
964 Alt<E> to remove added element
965 Usage: addfoval xc yc dx dy [GraphicAtt] [fgnc=false/true]
966 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
967 Related commands: addoval addline addarrow addfrect addcirc addfcirc
968 addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
969\end{verbatim}
[2416]970\piacommand{addfpoly} \label{addfpoly}
971\begin{verbatim}
972Adds a filled polygon to the current graphic object
973 Usage: addploy 'x1,y1 x2,y2 x3,y3 ...' [GraphicAtt] [fgnc=false/true]
974 Coordinates specified as pairs x,y in a single word (use simple or double quotes
975 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
976 Related commands: addtext addline addarrow addfrect addfrect
977 addcirc addfcirc addfarc graphicatt
978\end{verbatim}
979\piacommand{addfrect} \label{addfrect}
980\begin{verbatim}
981Adds a filled rectangle to the current graphic object
982 between the specified positions (+ graphic attribute)
983 The Base/AxesDrawer is used to handle added rectangle
984 Alt<E> to remove added element
985 Usage: addfrect x1 y1 x2 y2 [GraphicAtt] [fgnc=false/true]
986 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
987 Related commands: addtext addline addarrow addrect
988 addcirc addfcirc addpoly addfpoly graphicatt
989\end{verbatim}
990\piacommand{addline} \label{addline}
991\begin{verbatim}
992Adds a line to the current graphic object
993 at the specified position (+ graphic attribute)
994 The Base/AxesDrawer is used to handle added lines
995 Alt<E> to remove the added element
996 Usage: addline x1 y1 x2 y2 [GraphicAtt] [fgnc=false/true]
997 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
998 Related commands: addarrow addtext addrect addfrect
999 addmarker addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
1000\end{verbatim}
1001\piacommand{addmarker} \label{addmarker}
1002\begin{verbatim}
1003Adds a marker to the current graphic object
1004 at the specified position (+ graphic attribute)
1005 The Base/AxesDrawer is used to handle added circles
1006 Alt<E> to remove added element
1007 Usage: addmarker xpos ypos [GraphicAtt] [fgnc=false/true]
1008 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
1009 Related commands: addtext addline addarrow addfrect addfrect
1010 addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
1011\end{verbatim}
[2811]1012\piacommand{addoval} \label{addoval}
1013\begin{verbatim}
1014Adds an oval (ellipse) to the current graphic object
1015 centered on xc,yc - semi-axis ds,dy (+ graphic attribute)
1016 The Base/AxesDrawer is used to handle added rectangle
1017 Alt<E> to remove added element
1018 Usage: addoval xc yc dx dy [GraphicAtt] [fgnc=false/true]
1019 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
1020 Related commands: addfoval addline addarrow addfrect addcirc addfcirc
1021 addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
1022\end{verbatim}
[2416]1023\piacommand{addpoly} \label{addpoly}
1024\begin{verbatim}
1025Adds a polyline/polygon to the current graphic object
1026 Usage: addploy 'x1,y1 x2,y2 x3,y3 ...' [GraphicAtt] [fgnc=false/true]
1027 Coordinates specified as pairs x,y in a single word (use simple or double quotes
1028 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
1029 Related commands: addtext addline addarrow addfrect addfrect
1030 addcirc addfcirc addfarc graphicatt
1031\end{verbatim}
1032\piacommand{addrect} \label{addrect}
1033\begin{verbatim}
1034Adds a rectangle to the current graphic object
1035 between the specified positions (+ graphic attribute)
1036 The Base/AxesDrawer is used to handle added rectangle
1037 Alt<E> to remove added element
1038 Usage: addrect x1 y1 x2 y2 [GraphicAtt] [fgnc=false/true]
1039 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
1040 Related commands: addtext addline addarrow addfrect
1041 addcirc addfcirc addarc addfarc addpoly addfpoly graphicatt
1042\end{verbatim}
1043\piacommand{addtext} \label{addtext}
1044\begin{verbatim}
1045Adds a text string to the current graphic object
1046 at the specified position (+ color/font/pos/dir attributes)
1047 The Base/AxesDrawer is used to handle added text strings
1048 Alt<E> to remove the added element
1049 Usage: addtext x y TextString [ColFontPosAtt] [fgnc=false/true]
1050 (use quotes '' for multi word text strings)
1051 if fgnc==true : Normalized 0..1 coordinates specification (def=false)
1052 Text position/direction attribute:
1053 horizleft horizcenter horizright
1054 vertbottom vertcenter verttop
1055 textdirhoriz textdirvertup textdirvertdown
1056 Related commands: addctext addline addarrow addrect addfrect
1057 addcirc addfcirc addarc addfrac addpoly addfpoly settitle graphicatt
1058\end{verbatim}
1059\subsection{Graphics} \label{Graphics}
[2548]1060Basic graphics and object display commands
1061 \\[2mm] \noindent
[2416]1062\piahelpitem{PIConsole} \label{PIConsole}
1063\begin{verbatim}
1064Text output area and command editing window (console)
1065>>>> Mouse controls :
1066o Button-1: Rectangle selection for copy/paste
1067o Button-2: Paste text in the command editing line
1068o Button-3: activate display option menu
1069>>>> Keyboard controls :
1070o <Alt>O : activate display option menu
1071o <Alt>V : Paste text in the command editing line
1072o <Alt>A : Selection of the whole window for copy
1073o <Alt>L : Command history (List of command history buffer)
1074o <Ctl>A : Command editing -> Goto the beginning of line
1075o <Ctl>E : Command editing -> Goto the end of line
1076o <Ctl>K : Command editing -> Clear to the end of line
1077o <Ctl>C : Command editing -> Clear the line
1078o Cursor left,right : Command editing -> Move cursor
1079o Cursor Up,Down : recall command from history buffer
1080o Backspace,Del : Command editing
1081o <Return>,<Enter> : Execute command
1082
1083\end{verbatim}
1084\piahelpitem{PIDraw3DWdg} \label{PIDraw3DWdg}
1085\begin{verbatim}
1086Manages display of 3-D objects (drawers)
1087>>>> Mouse controls :
1088o Button-2: Rotates the observer (camera) around object
1089o Shift-Button-2: Rotates object with camera fixed
1090 The object rotation mode can be assigned to Button-2 with <Alt>S
1091o Button-3: Zoom control (Camera distance And/Or view angle)
1092>>>> Keyboard controls :
1093o <Alt>R : Resets the 3-D view and refreshes the display
[2811]1094o <Alt>O : Displays a specific control window (default: PIDrawerTools)
1095 (2-D histograms, contour plot ...)
[2416]1096o <Alt>G : Show the PIDrawerTools (Graphic attributes of displayed Drawers)
[2811]1097 Drawer 0 manages the axes, as well as the added text
1098o <Alt>D : Shows the drawer manipulation pop-up menu
[2416]1099o <Alt>V : Copy/Paste / Text paste at the current position (Drawer 0)
1100o <Alt>Z : Removes added graphic elements (handled by BaseDrawer - 0)
1101o <Alt>E : Removes the last added graphic element
1102o <Alt>A : Activate/Deactivate axes drawing
1103o <Alt>S : Activate/Deactivate object rotation mode on Button-2
1104
1105\end{verbatim}
1106\piahelpitem{PIImage} \label{PIImage}
1107\begin{verbatim}
1108Manages the display of a 2-D array (P2DArrayAdapter) as an image
1109and controls a zoom widget, as well as a global image view widget
1110>>>> Mouse controls :
1111o Button-1: Display current coordinates and pixel value
1112 Position the cursor an refresh the zoom widget
1113o Button-2: Defines an image zone and positions the cursor
1114o Button-3: Moves the viewed portion of the array inside the window
1115>>>> Keyboard controls :
1116o <Alt>R : Refresh display
1117o <Alt>O : Shows the PIImageTools (image display parameter controls)
1118o <Alt>G : Show the PIDrawerTools (Graphic attributes of overlayed graphics (Drawers))
[2811]1119o <Alt>D : Shows the drawer manipulation pop-up menu
[2416]1120o <Alt>V : Copy/Paste / Text paste at the current cursor position
1121o <Alt>C : Copy/Paste / Copies the selected regions content as text in the copy/paste buffer
1122o <Alt>X : Show/Hide the Cut Window
1123o <Alt>Z : Removes added graphic elements (handled by BaseDrawer - 0)
1124o <Alt>E : Removes the last added graphic element
1125o <Alt>+ or <Cntl>+ : Zoom in
1126o <Alt>- or <Cntl>- : Zoom out
1127o Cursor keys : Moves the image cursor
1128
1129\end{verbatim}
1130\piahelpitem{PIScDrawWdg} \label{PIScDrawWdg}
1131\begin{verbatim}
1132Manages display of 2-D drawers with interactive zoom
1133>>>> Mouse controls :
1134o Button-1: Display current coordinates
1135o Button-2: Defines a rectangle for zoom
1136o Button-3: Defines a rectangle for Text-Info (<Alt>I)
1137>>>> Keyboard controls :
1138o <Alt>R : Refresh display
1139o <Alt>O : Displays a specific control window (default: PIDrawerTools)
[2811]1140 (2-D histograms, contour plot ...)
[2416]1141o <Alt>G : Show the PIDrawerTools (Graphic attributes of displayed Drawers)
1142 Drawer 0 manages the axes, as well as the added text
[2811]1143o <Alt>D : Shows the drawer manipulation pop-up menu
[2416]1144o <Alt>V : Copy/Paste / Text paste at the current position
1145o <Alt>Z : Removes added graphic elements (handled by BaseDrawer - 0)
1146o <Alt>E : Removes the last added graphic element
1147o <Alt>I : Shows (or updates) a text info window on the selected rectangle
1148o <Alt>M : Activate/Deactivate a measurement cursor on Button-1
1149o <Alt>L : Deactivate DX,DY print (see below)
1150>>>> Mouse + Keyboard controls :
1151o Button-1 + <Alt>K : Set (reset) the reference point for DX,DY print
1152
1153\end{verbatim}
1154\piahelpitem{Windows} \label{Windows}
1155\begin{verbatim}
1156Objects can be displayed in different windows, or overlayed on the
1157previous display. The graphics attributes next,win,stack,same control
1158the display window.
1159o GraphicWindow : This is the default mode (gr_att=next)
1160 Graphic windows can be divided int zones. Object is displayed
1161 in the next available position, removing a previously displayed
1162 widget if necessary
1163o Window : An object is displayed in its own window (gr_att= win)
1164o StackWindow : multpile widgets can be stacked in a StackWindow (gr_att= stack)
1165 A single widget is displayed a any time. Different widgets in a StackWindow
1166 can be displayed using the stacknext command, as well as the StackTools item
1167 in the Tools menu (from Menubar). An automatic cyclic display mode can also
1168 be activated using the StackTools menu (Blink)
1169o Most objects can be also be displayed overlayed
1170 on the last displayed widget (gr_att= same)
1171o The overlay can be on a selected rectangle of the
1172 last displayed widget (gr_att= inset) - See setinsetlimits
1173
1174 Related commands: newwin zone stacknext graphicatt setinsetlimits
1175\end{verbatim}
1176\piacommand{addaxelabels} \label{addaxelabels}
1177\begin{verbatim}
1178Set the X and Y axis labels for the current 2D graphic object alias for setaxelabels
1179\end{verbatim}
1180\piacommand{addtitle} \label{addtitle}
1181\begin{verbatim}
1182Set the title string (top title / bottom title)
1183 alias for settitle
1184\end{verbatim}
1185\piacommand{drpanel} \label{drpanel}
1186\begin{verbatim}
1187Creates a new 2D drawing zone for addtext, addline
1188 Usage: drpanel xmin xmax ymin ymax [GrAtt] [Name]
1189 Related commands: addtext addline addrect addcirc ...
1190\end{verbatim}
1191\piacommand{graphicatt} \label{graphicatt}
1192\begin{verbatim}
[2811]1193To change default graphic options
1194 Usage: graphicatt att_list
[2416]1195att_list=def back to default values, Example: gratt 'red circlemarker5'
[2811]1196 ------------------ Graphic attribute list ------------------
1197>> Colors: defcol black white grey red blue green yellow
1198 magenta cyan turquoise navyblue orange siennared purple
1199 limegreen gold violet violetred blueviolet darkviolet
1200 or "color=name" "fgcolor=name" "bgcolor=name" ex: "color=red"
1201>> Lines: defline normalline thinline thickline dashedline thindashedline
1202 thickdashedline dottedline thindottedline thickdottedline
1203 or "line=type,width" ex: "line=dotted,7"
1204>> Fonts:
1205 > Att: deffontatt normalfont boldfont italicfont bolditalicfont
1206 smallfont smallboldfont smallitalicfont smallbolditalicfont
1207 bigfont bigboldfont bigitalicfont bigbolditalicfont
1208 hugefont hugeboldfont hugeitalicfont hugebolditalicfont
1209 > Names: deffont courierfont helveticafont timesfont symbolfont
1210 or "font=name,type,size" ex: "font=courrier,bolditalic,10"
1211>> Marker: dotmarker<T> plusmarker<T> crossmarker<T> circlemarker<T>
1212 fcirclemarker<T> boxmarker<T> fboxmarker<T> trianglemarker<T>
1213 ftrianglemarker<T> starmarker<T> fstarmarker<T>
1214 with <T> = 1 3 5 7 .. 15 , Example fboxmarker5 , plusmarker9 ...
1215 or "marker=type,size" ex: "marker=plus,10"
1216>> ArrowMarker: basicarrow<T> trianglearrow<T> ftrianglearrow<T>
1217 arrowshapedarrow<T> farrowshapedarrow<T>
1218 with <T> = 5 7 .. 15 , Example trianglearrow7 ...
1219 or "arrow=type,size" ex: "arrow=arrowshaped,10"
1220------ Specific options for image displays:
1221>> ColorTables: defcmap grey32 invgrey32 colrj32 colbr32
1222 grey128 invgrey128 colrj128 colbr128
1223 red32cm green32cm blue32cm yellow32cm
1224 orange32cm cyan32cm violet32cm
[2416]1225 midas_pastel midas_heat midas_rainbow3 midas_bluered
[2811]1226 midas_bluewhite midas_redwhite
1227 multicol16 multicol64
1228>> revcmap : reverse colorMap
1229>> ZoomFactors : zoomxN ex: zoomx1 zoomx2 zoomx3 ...
1230 zoom/N ex: zoom/2 zoom/3 zoom/4 ...
1231>> imagecenter=ix,iy : Position the image in widget
1232>> lut=ltyp,min,max : Sets LUT type and min/max
1233 (ltyp=lin/log/sqrt/square)
1234>> invx,invy,exchxy : image axes configuration
1235>> for Axes / Axe labels / LogScale / xylimits / defdrrect
1236 see setaxesatt command
1237--- General purpose options:
1238>> stat,stats / nsta,nstat,nostat,nostats : Toggle statistic display
1239>> title,tit / notitle,notit -> Toggle automatic title display
1240>> Choose display window: next same win stack inset
1241
[2416]1242 Related commands: setaxesatt setinsetlimits
1243\end{verbatim}
1244\piacommand{imagcmap2eps} \label{imagcmap2eps}
1245\begin{verbatim}
1246imagcmap2eps: Current Image+ColorMap To EncapsulatedPostScript
1247Usage: imagcmap2eps EPSFileName
1248\end{verbatim}
1249\piacommand{imagcmap2ps} \label{imagcmap2ps}
1250\begin{verbatim}
1251w2ps: Current Image+ColorMap To PostScript
1252Usage: imagcmap2ps
1253\end{verbatim}
1254\piacommand{newwin} \label{newwin}
1255\begin{verbatim}
1256To Create a New Graphic window, with zones
1257 Window size can be specified
1258 Usage: newwin [nx ny [sizeX sizeY]]
1259 Related commands: zone
1260\end{verbatim}
1261\piacommand{psclosefile} \label{psclosefile}
1262\begin{verbatim}
1263psclosefile: close current postscript file
1264Usage: w2psclosefile
1265\end{verbatim}
1266\piacommand{psgetfilename} \label{psgetfilename}
1267\begin{verbatim}
1268psgetfilename: Prints current PostScript file name
1269Usage: psgetfilename
1270\end{verbatim}
1271\piacommand{pssetfilename} \label{pssetfilename}
1272\begin{verbatim}
1273pssetfilename: Sets current PostScript file name
1274Usage: pssetfilename FileName
1275\end{verbatim}
1276\piacommand{setaxelabels} \label{setaxelabels}
1277\begin{verbatim}
1278Set the X and Y axis labels for the current 2D graphic object
1279
1280 Usage: setaxelabels xLabel yLabel [ColorFntAtt]
1281 Related commands: settitle addtext graphicatt
1282\end{verbatim}
1283\piacommand{setaxesatt} \label{setaxesatt}
1284\begin{verbatim}
1285To set default axes attributes
1286 Usage: setaxesatt att_list
1287Color/Line/Font attributes and axes attributes
[2811]1288>> Axes: axesnone stdaxes=defaxes=boxaxes boxaxesgrid
1289 fineaxes fineaxesgrid centeredaxes finecenteredaxes
1290 centeredaxesgrid finecenteredaxesgrid
1291 axescenter=x0,y0 (only with centered axes, default "axescenter=")
1292 grid nogrid labels nolabels
1293 ticks noticks minorticks nominorticks
1294 extticks intticks extintticks
1295 nbticks=X_NTicks,Y_NTicks
1296 tickslen=MajTickLenFrac,MinTickLenFrac
[2416]1297>> Axe labels font size: fixedfontsize/autofontsize=fszf
[2811]1298 autofontsize=fsizef: Font size computed automatically
1299 fixedfontsize: Use font size attribute (BaseDrawer)
1300>> Scale type: linx liny logx logy -> Lin/Log Scales for 2D plots
[2416]1301>> xylimits=xmin,xmax,ymin,ymax -> Forces X-Y limits in 2-D plots
1302>> defdrrect=xmin,xmax,ymin,ymax -> Defines drawing rectangle 2-D plots
1303 The rectangle is defined as a fraction of the widget size
1304
1305\end{verbatim}
1306\piacommand{setinsetlimits} \label{setinsetlimits}
1307\begin{verbatim}
1308Define the display rectangle for drawers added as insets
1309 over existing graphic objects - limits expressed as fraction
1310 graphic object size (0. .. 1.) Xmax at right, YMax top. Usage: setinsetlimits xmin xmax ymin ymax
1311 Related commands: graphicatt /inset
1312\end{verbatim}
1313\piacommand{settitle} \label{settitle}
1314\begin{verbatim}
1315Set the title string (top title / bottom title) for the current graphic object
1316 Usage: settitle TopTitle [BottomTitle] [fontAtt]
1317 Related commands: addtext graphicatt
1318\end{verbatim}
1319\piacommand{stacknext} \label{stacknext}
1320\begin{verbatim}
1321Displays the next widget on stack window
1322 Usage: stacknext
1323\end{verbatim}
1324\piacommand{w2eps} \label{w2eps}
1325\begin{verbatim}
1326w2eps: Current Window To EncapsulatedPostScript
1327Usage: w2eps EPSFileName
1328\end{verbatim}
1329\piacommand{w2ps} \label{w2ps}
1330\begin{verbatim}
1331w2ps: Current Window To PostScript
1332Usage: w2ps
1333\end{verbatim}
1334\piacommand{zone} \label{zone}
1335\begin{verbatim}
1336To Divide the Graphic window
1337 Usage: zone [nx=1 ny=1]
1338 Related commands: newwin
1339\end{verbatim}
1340\subsection{Obj. Display} \label{ObjZZDisplay}
1341\noindent
[2811]1342\piacommand{bargraph} \label{bargraph}
1343\begin{verbatim}
1344Bar-Graph view of a sequence of values
1345 Usage: bargraph ValueVarName [gr_opt]
1346 or bargraph ValueVarName LabelVarName ColPosVarName [gr_opt]
1347 ValueVarName,LabelVarName,ColPosVarName are PIACmd interpreter
1348 variable name (vectors)
1349 - ValueVarName: Sequence of values to be represented
1350 - LabelVarName: Corresponding labels
1351 - ColPosVarName: Corresponding colors or color,position pairs
1352 Use a dash (-) or ! as placeholder for LabelVarName/ColPosVarName
1353 Specific graphic options: fill/nofill packfrac=value
1354 horizontalbars/verticalbars barvaluelabel/nobarvaluelabel
1355 Related commands: disp nt2d vecplot ...
1356\end{verbatim}
[2416]1357\piacommand{contour} \label{contour}
1358\begin{verbatim}
1359Creates and displays a ContourDrawer
1360 Usage: contour objectName [graphic_att/specific_opt]
1361 Specific Options
1362 ncont=[number of contours (automatic levels) ]
1363 niv/lev=[values for contours, separated by ',']
1364 lstep=[nomber,first_value,increment for contours ]
1365 bspline : use bspline algo for contour
1366 3spl : use cubic spline algo for contour
1367 labon : put labels for contours
1368\end{verbatim}
1369\piacommand{disp} \label{disp}
1370\begin{verbatim}
1371Displays an object
1372 Usage: disp nameobj [graphic_attributes]
1373 Related commands: surf nt2d nt3d vecplot
1374\end{verbatim}
1375\piacommand{gfd2d} \label{gfd2d}
1376\begin{verbatim}
1377Displays Points (X-Y) with error-bars from a GeneralFit Data
1378 Usage : gfd2d nameobj numvarx erreur=(x y xy) [graphic_attributes]
1379 Related commands: gfd3d nt2d nt3d
1380 ----- OBSOLETE: utilisez nt2d -----
1381\end{verbatim}
1382\piacommand{gfd3d} \label{gfd3d}
1383\begin{verbatim}
1384Displays 3D-Points (X-Y-Z) with error-bars from a GeneralFit Data
1385 Usage : gfd3d nameobj numvarx numvary erreur=(x y z xy xz yz xyz) [graphic_attributes]
1386 Related commands: gfd2d nt2d nt3d
1387 ----- OBSOLETE: utilisez nt3d -----
1388\end{verbatim}
1389\piacommand{imag} \label{imag}
1390\begin{verbatim}
1391Displays an object as an image
1392 Usage: imag nameobj [graphic_attributes]
[2811]1393 Related commands: disp imagnav surf nt2d nt3d vecplot
[2416]1394\end{verbatim}
[2811]1395\piacommand{imagnav} \label{imagnav}
1396\begin{verbatim}
1397Displays an object as an image with the ImageNavigator viewer
1398Usage: imagnav nameobj [graphic_attributes]
1399 Related commands: disp imag surf nt2d nt3d vecplot
1400\end{verbatim}
[2416]1401\piacommand{nt2d} \label{nt2d}
1402\begin{verbatim}
1403Displays Points (X-Y) [with error-bar / Weight / Label ] from an NTuple
1404 Usage : nt2d nameobj varx vary [errx erry wt label graphic_attributes]
1405 Related commands: disp surf nt3d gfd2d vecplot
1406\end{verbatim}
1407\piacommand{nt2dvec} \label{nt2dvec}
1408\begin{verbatim}
1409Creates and displays a flow chart from ntuple variables
1410 Usage: nt2dvec x y vx vy [graphic_att]
1411\end{verbatim}
1412\piacommand{nt3d} \label{nt3d}
1413\begin{verbatim}
1414Displays 3D-Points (X-Y-Z) [with error-bars / Weight / Label ] from an NTuple
1415 Usage : nt3d nameobj varx vary varz [errx erry errz wt label graphic_attributes]
1416 Related commands: disp surf nt2d gfd3d
1417\end{verbatim}
1418\piacommand{ntcont} \label{ntcont}
1419\begin{verbatim}
1420Creates and displays a ContourDrawer (from a NTuple)
1421 Usage: ntcont NTupleName varx vary varz [graphic_att/specific_opt]
1422 specific options
1423 ncont=[number of contours (automatic levels) ]
1424 niv/lev=[values for contours, separated by ',']
1425 lstep=[nomber,first_value,increment for contours ]
1426 bspline : use bspline algo for contour
1427 3spl : use cubic spline algo for contour
1428 labon : put labels for contours
1429\end{verbatim}
1430\piacommand{surf} \label{surf}
1431\begin{verbatim}
1432Displays an object as a 3D surface
1433 Usage: surf nameobj [graphic_attributes]
1434 Related commands: disp nt2d nt3d vecplot
1435\end{verbatim}
[2811]1436\piacommand{textdrawer} \label{textdrawer}
1437\begin{verbatim}
1438Multi line text darwer
1439 Usage : textdrawer LinesVarName AttVarName [gr_opt]
1440 LinesVarName,AttVarName are PIACmd interpreter variables
1441 - LinesVarName: Lines to be displayed
1442 - AttVarName: Corresponding font/marker/color attributes
1443 Use a dash (-) or ! as placeholder for AttVarName
1444 Specific graphic options: frame/noframe
1445 Related commands: disp ...
1446\end{verbatim}
[2416]1447\piacommand{vecplot} \label{vecplot}
1448\begin{verbatim}
1449Displays Points (X-Y) with coordinates defined by two vectors
1450 Usage : vecplot nameVecX nameVecY [graphic_attributes]
1451 Related commands: disp nt2d
1452\end{verbatim}
1453\subsection{Object Management} \label{ObjectZManagement}
1454\noindent
1455\piacommand{cd} \label{cd}
1456\begin{verbatim}
1457Change current directory
1458 Usage: cd [dirname]
1459\end{verbatim}
1460\piacommand{copy} \label{copy}
1461\begin{verbatim}
1462Copy objects (Alias cp)
1463 Usage: copy name_from name_to
1464 Related commands: cp new...
1465\end{verbatim}
1466\piacommand{cp} \label{cp}
1467\begin{verbatim}
1468Copy objects (Alias copy)
1469 Usage: cp name_from name_to
1470 Related commands: copy new...
1471\end{verbatim}
1472\piacommand{del} \label{del}
1473\begin{verbatim}
1474Deletes an object (Alias: rm)
1475 Usage: del nameobj [nameobj2 ...]
1476 Related commands: rm delobjs rename
1477\end{verbatim}
1478\piacommand{delobjs} \label{delobjs}
1479\begin{verbatim}
1480Delete a set of objects with names matching a pattern (x?y*)
1481 Usage: delobjs nameobjpattern
1482
1483 Related commands: del rename
1484\end{verbatim}
1485\piacommand{listdirs} \label{listdirs}
1486\begin{verbatim}
1487Prints the list of directories
1488 Usage: listdirs [patt=*]
1489 patt : * , ?
1490\end{verbatim}
1491\piacommand{listobjs} \label{listobjs}
1492\begin{verbatim}
1493Prints the list of objects (Alias: ls)
1494 Usage: listobjs [patt=*]
1495 patt : /*/x?y* ...
1496\end{verbatim}
1497\piacommand{mkdir} \label{mkdir}
1498\begin{verbatim}
1499Create a directory
1500 Usage: mkdir dirname [true]
1501 if second argument==true, the directory's KeepOld attribute is set to true
1502\end{verbatim}
1503\piacommand{mv} \label{mv}
1504\begin{verbatim}
1505Rename an object (Alias: rename)
1506 Usage: mv nameobj namenew
1507 Related commands: rename del delobjs
1508\end{verbatim}
1509\piacommand{pwd} \label{pwd}
1510\begin{verbatim}
1511Prints current directory
1512 Usage: pwd
1513\end{verbatim}
1514\piacommand{rename} \label{rename}
1515\begin{verbatim}
1516Rename an object (Alias: mv)
1517 Usage: rename nameobj namenew
1518 Related commands: mv del delobjs
1519\end{verbatim}
1520\piacommand{rm} \label{rm}
1521\begin{verbatim}
1522Deletes an object (Alias: del)
1523 Usage: rm nameobj [nameobj2 ...]
1524 Related commands: del delobjs rename
1525\end{verbatim}
1526\piacommand{rmdir} \label{rmdir}
1527\begin{verbatim}
1528Removes an empty directory
1529 Usage: remove dirname
1530\end{verbatim}
1531\piacommand{setdiratt} \label{setdiratt}
1532\begin{verbatim}
1533Sets directory attributes
1534 Usage: setdiratt dirname KeepOldFlag(=true/false)
1535 KeepOldFlag=true Object with the same name is moved to old
1536 when adding objects
1537\end{verbatim}
1538\subsection{Objects} \label{Objects}
1539\noindent
1540\piacommand{line2nt} \label{line2nt}
1541\begin{verbatim}
1542Fills (append) an NTuple from the line content
1543 Usage: line2nt ntname col0 col1 ...
1544 Related commands: newnt line2vec ntline2var ntcol2var
1545\end{verbatim}
1546\piacommand{line2vec} \label{line2vec}
1547\begin{verbatim}
1548Creates a vector from the line
1549 Usage: line2vec vecname v0 v1 v2 ...
1550 Related commands: newvec line2nt
1551\end{verbatim}
[2811]1552\piacommand{newdt} \label{newdt}
1553\begin{verbatim}
1554Creates a datatable
1555 Usage: newdt name v1:t1 v2:t2 v3:t3 .. vn:tn
1556 newdt name nvar
1557 vi : variable name
1558 ti : variable type
1559 r8,r4 for 8 and 4 bytes float
1560 i8,i4 for 8 and 4 bytes signed integer
1561 s for string
1562 Related commands: newnt newh1d newh2d newprof[e] newgfd
1563\end{verbatim}
[2416]1564\piacommand{newgfd} \label{newgfd}
1565\begin{verbatim}
1566Creates GeneralFit Data object
1567 Usage: newgfd nvar nalloc [errx(0/1)]
[2811]1568 Related commands: newh1d newh2d newprof[e] newdt newnt
[2416]1569\end{verbatim}
1570\piacommand{newh1d} \label{newh1d}
1571\begin{verbatim}
1572Creates a 1D histogramm
1573 Usage: newh1d name xmin xmax nbin
[2811]1574 Related commands: newh2d newprof[e] newdt newnt newgfd
[2416]1575\end{verbatim}
1576\piacommand{newh2d} \label{newh2d}
1577\begin{verbatim}
1578Creates a 2D histogramm
1579 Usage: newh2d name xmin xmax nbinx ymin ymax nbiny
[2811]1580 Related commands: newh1d newprof[e] newdt newnt newgfd
[2416]1581\end{verbatim}
1582\piacommand{newmtx} \label{newmtx}
1583\begin{verbatim}
1584Creates (and optionaly fills) a matrix
1585 Usage: newmtx name sizeX(Col) sizeY(Lines) [f(i,j) [dopt] ]
1586 Related commands: newvec
1587\end{verbatim}
1588\piacommand{newnt} \label{newnt}
1589\begin{verbatim}
1590Creates a ntuple
1591 Usage: newnt name v1 v2 v3 .. vn
1592 newnt name nvar
[2811]1593 Related commands: newdt newh1d newh2d newprof[e] newgfd
[2416]1594\end{verbatim}
1595\piacommand{newprof} \label{newprof}
1596\begin{verbatim}
1597Creates a profile histogramm
1598 Usage: newprof name xmin xmax nbin [ymin ymax]
1599 Errors represent the data spread in the X bin
[2811]1600 Related commands: newh1d newh2d newprofe newdt newnt newgfd
[2416]1601\end{verbatim}
1602\piacommand{newprofe} \label{newprofe}
1603\begin{verbatim}
1604Creates a profile histogramm
1605 Usage: newprofe name xmin xmax nbin [ymin ymax]
1606 Errors represent the error on the data mean in the X bin
[2811]1607 Related commands: newh1d newh2d newprof newdt newnt newgfd
[2416]1608\end{verbatim}
1609\piacommand{newvec} \label{newvec}
1610\begin{verbatim}
1611Creates (and optionaly fills) a vector
1612 Usage: newvec name size [f(i) [dopt] ]
1613 Related commands: newmtx line2vec
1614\end{verbatim}
1615\piacommand{ntcol2var} \label{ntcol2var}
1616\begin{verbatim}
1617Object NTupleInterface column to an interpreter variable
1618 Usage: ntline2var objname column_number varname [LoopParam start:end[:step] ]
1619 Related commands: vec2var ntline2var
1620\end{verbatim}
1621\piacommand{ntline2var} \label{ntline2var}
1622\begin{verbatim}
1623Object NTupleInterface line to an interpreter variable
1624 Usage: ntline2var objname line_number varname
1625 Related commands: vec2var ntcol2var
1626\end{verbatim}
1627\piacommand{vec2var} \label{vec2var}
1628\begin{verbatim}
1629Vector content to an interpreter variable varname = 'v0 v1 v2 ...'
1630 Usage: line2vec vecname varname [LoopParam start:end[:step] ]
1631 Related commands: line2vec ntline2var
1632\end{verbatim}
1633\subsection{PIACmd} \label{PIACmd}
[2548]1634piapp interpreter (class PIACmd) additional builtin commands
1635 \\[2mm] \noindent
[2416]1636\piahelpitem{exitpiapp} \label{exitpiapp}
1637\begin{verbatim}
[2548]1638To end the piapp session
[2416]1639\end{verbatim}
[2548]1640\piahelpitem{helpwindow} \label{helpwindow}
[2416]1641\begin{verbatim}
[2548]1642To display the Help window
[2416]1643\end{verbatim}
[2811]1644\piahelpitem{stop} \label{stop}
1645\begin{verbatim}
1646To stop (break) interpreter (PIACmd/Commander) execution
1647\end{verbatim}
[2416]1648\subsection{SkyMapCmd} \label{SkyMapCmd}
[2548]16494 Pi spherical, local maps manipulation commands
1650and spherical harmonics analysis Ylm.
1651 This is mainly Based on SOPHYA SkyMap and Samba modules.
1652 \\[2mm] \noindent
[2416]1653\piacommand{alm2cl} \label{alm2cl}
1654\begin{verbatim}
1655Project alm to cl
1656 Usage: alm2cl alm cl
1657\end{verbatim}
1658\piacommand{alm2map} \label{alm2map}
1659\begin{verbatim}
1660Generate SkyMap map(double) from Alm
1661 Usage: alm2map almmat map(double) nside
1662 (see command settypemap)
1663\end{verbatim}
1664\piacommand{cl2llcl} \label{cl2llcl}
1665\begin{verbatim}
1666Project cl to l*(l+1)*cl
1667 Usage: cl2llcl cl llcl
1668\end{verbatim}
1669\piacommand{cl2map} \label{cl2map}
1670\begin{verbatim}
1671Generate SkyMap map(double) from Cl
1672 Usage: cl2map clvec map(double) nside [fwhm]
1673 (see command settypemap)
1674\end{verbatim}
1675\piacommand{clmean} \label{clmean}
1676\begin{verbatim}
1677Compute mean for a cl vector
1678 Usage: clmean cl imin,imax [meanvarname]
1679 imin,imax = compute between these indices
1680 meanvarname = variable name to store mean
1681\end{verbatim}
1682\piacommand{clmult} \label{clmult}
1683\begin{verbatim}
1684Multiply a cl by a constant
1685 Usage: clmult cl val
1686\end{verbatim}
1687\piacommand{clop} \label{clop}
1688\begin{verbatim}
1689operation on a cl
1690 Usage: clop cl(double) op1 cl1(double) [op2 cl2(double)] [op2 cl3(double)] [...]
1691 Do "cl op1= cl1", "cl op2=cl2", ...
1692 where op = +,-,*,/
1693\end{verbatim}
1694\piacommand{clrebin} \label{clrebin}
1695\begin{verbatim}
1696rebin a cl into an ntuple
1697 Usage: clrebin cl ntuple nbin,bin0
1698 nbin: rebin by nbin
1699 bin0: begin rebinning at bin bin0 (def=0)
1700\end{verbatim}
1701\piacommand{crmapmask} \label{crmapmask}
1702\begin{verbatim}
1703Create a map mask(double) (nside) between latitudes lat1,lat2 longitudes lon1,lon2
1704 Usage: crmapmask mapmsk(double) nside lat1,lat2 lon1,lon2 [valmsk,valnomsk]
1705 mask pixels between [lat1,lat2] ([-90,90] in degrees)
1706 and [lon1,lon2] ([0,360[ in degrees)
1707 (for no mask "!")
1708 valmsk=value to be written into masked pixels (def=0)
1709 valnomsk=value to be written into unmasked pixels (def=1)
1710 (see command settypemap)
1711\end{verbatim}
1712\piacommand{crmaskfrmap} \label{crmaskfrmap}
1713\begin{verbatim}
1714Create a map mask(double) (nside) relative to an other map(double) pixels values
1715 Usage: crmaskfrmap mapmsk(double) nside map(double) v1,v2 [valmsk,valnomsk]
1716 mask if v1<mapmsk(i)<v2
1717 valmsk=value to be written into masked pixels (def=0)
1718 valnomsk=value to be written into unmasked pixels (def=1)
1719\end{verbatim}
1720\piacommand{map2alm} \label{map2alm}
1721\begin{verbatim}
1722SkyMap map(double) to Alm
1723 Usage: map2alm map(double) almmat [lmax] [niter]
1724 lmax: if <=0 or "!" use default (3*nside-1)
1725 niter: number of iterations (<=0 or def=3)
1726\end{verbatim}
1727\piacommand{map2cl} \label{map2cl}
1728\begin{verbatim}
1729SkyMap map(double) to Cl
1730 Usage: map2cl map(double) clvec [lmax] [niter]
1731 lmax: if <=0 or "!" use default (3*nside-1)
1732 niter: number of iterations (<=0 or def=3)
1733\end{verbatim}
1734\piacommand{map2double} \label{map2double}
1735\begin{verbatim}
1736Convert a float map to a double map
1737 Usage: map2double map(float)
1738\end{verbatim}
1739\piacommand{map2float} \label{map2float}
1740\begin{verbatim}
1741Convert a double map to a float map
1742 Usage: map2float map(double)
1743\end{verbatim}
1744\piacommand{map2local} \label{map2local}
1745\begin{verbatim}
1746Project a map(double) into a local map(double)
1747 Usage: map2local map(double) localmap(double) nx,ny angleX,angleY phi0,theta0 [x0,y0] [angle]
1748 nx,ny: number of pixels in x(col),y(row) direction
1749 X-axis==phi, Y-axis==theta
1750 angleX,angleY: total angle aperture in x,y direction (degrees)
1751 phi0,theta0: define origin in phi,theta (degrees)
1752 x0,y0: map phi0,theta0 to pixel x0,y0 ("!" or def=middle of the localmap)
1753 angle: angle (degrees) of rotation between x-axis of map-coordinate system
1754 and the tangent to parallel on the sphere (def: 0.)
1755\end{verbatim}
1756\piacommand{map2map} \label{map2map}
1757\begin{verbatim}
1758Convert a map(double) into an other map type
1759 Usage: map2map map(double) type [nside]
1760 type= H for Healpix
1761 T for ThetaPhi
1762 if nside <=1 use nside from map
1763\end{verbatim}
1764\piacommand{mapcover} \label{mapcover}
1765\begin{verbatim}
1766Print the covering of a map(double)
1767 Usage: mapcover map(double) v1,v2 [varname]
1768 v1,v2: good pixels have v1<=val<=v2 (def=0.99,1.01)
1769 (use default (0.99,1.01): "!")
1770 $varname: percent of sky covering
1771\end{verbatim}
1772\piacommand{mapmult} \label{mapmult}
1773\begin{verbatim}
1774Multiply a map(double) by a constant
1775 Usage: mapmult map(double) cste
1776\end{verbatim}
1777\piacommand{mapop} \label{mapop}
1778\begin{verbatim}
1779operation on a map(double)
1780 Usage: mapop map(double) op1 map1(double) [op2 map2(double)] [op2 map3(double)] [...]
1781 Do "map op1= map1", "map op2=map2", ...
1782 where op = +,-,*,/
1783\end{verbatim}
1784\piacommand{maproj} \label{maproj}
1785\begin{verbatim}
1786Project a map(double) into an other one
1787 Usage: maproj map(double) mapproj(double) [nside]
1788 Create mapproj(nside) and project map into mapproj
1789 (use "maproj map mapproj" to make a copy)
1790\end{verbatim}
1791\piacommand{mapstat} \label{mapstat}
1792\begin{verbatim}
1793Statistics from a map(double)
1794 Usage: mapstat map(double) [msk(double)] [meanvarname] [sigmavarname]
1795 msk = mask sphere used as weight
1796 if msk(i)<=0 do not use that pixel
1797 if msk(i)>0 use that pixel with weight msk(i)
1798 msk = "!" means no mask sphere
1799 meanvarname = variable name to store mean
1800 sigmavarname = variable name to store sigma
1801 ("!" means do not store)
1802\end{verbatim}
1803\piacommand{maskmap} \label{maskmap}
1804\begin{verbatim}
1805Mask a map(double) with a mask map(double)
1806 Usage: maskmap map msk
1807 operation is map(i) *= msk(theta,phi)
1808\end{verbatim}
1809\piacommand{settypemap} \label{settypemap}
1810\begin{verbatim}
1811Set le type de map(double) par default
1812 Usage: settypemap type
1813 type= H for Healpix (default)
1814 T for ThetaPhi
1815\end{verbatim}
1816\piacommand{typemap} \label{typemap}
1817\begin{verbatim}
1818Imprime le type de map
1819 Usage: typemap map
1820\end{verbatim}
1821\subsection{SophyaCmd} \label{SophyaCmd}
1822\noindent
1823\piacommand{mollgrid} \label{mollgrid}
1824\begin{verbatim}
1825Creates a spherical coordinate grid in Molleweide projection
1826 Usage: mollgrid [Nb_Parallel Nb_Meridien graphic_att]
1827\end{verbatim}
1828\piacommand{mollgridsph} \label{mollgridsph}
1829\begin{verbatim}
1830Creates a spherical coordinate grid in Molleweide projection
1831 Usage: mollgridsph NameSphericalMap [Nb_Parallel Nb_Meridien graphic_att]
1832\end{verbatim}
1833\piacommand{powerspec} \label{powerspec}
1834\begin{verbatim}
1835FFT on a vector -> Plots power spectrum
1836 Usage: fftp vecName vecFFT [graphic_att]
1837\end{verbatim}
[2811]1838\piacommand{setprjmoldefval} \label{setprjmoldefval}
1839\begin{verbatim}
1840Set default value for Molleweide projection of spherical maps (outside maps)
1841 Usage: setprjmoldefval OutOfMapValue
1842\end{verbatim}
[2416]1843\subsection{pawCmd} \label{pawCmd}
1844\noindent
1845\piacommand{h/cadd} \label{hZcadd}
1846\begin{verbatim}
1847Add a constant to an histogram, a vector or a matrix
1848 h/cadd namehisto val
1849 Related commands: h/cmult h/oper
1850\end{verbatim}
1851\piacommand{h/cmult} \label{hZcmult}
1852\begin{verbatim}
1853Multiply an histogram, a vector or a matrix by a constant
1854 h/cmult namehisto val
1855 Related commands: h/cadd h/oper
1856\end{verbatim}
1857\piacommand{h/copy} \label{hZcopy}
1858\begin{verbatim}
1859Copy content of object1 into object2
1860 objects are Vector,Matrix,Histo,Histo2D
1861 h/copy namefrom nametocopy [i1[:i2]] [j1[:j2]] [ic1[:jc1]]
1862 copy obj1Dfrom(i1->i2) into obj1Dto(ic1->)
1863 copy obj2Dfrom(i1,j1->i2,j2) into obj2Dto(ic1,jc1->)
1864 Warning: elements from i1 to i2 included are copied
1865 If obj1Dto does not exist, is is created with size i2-i1+1
1866 or obj2Dto with size i2-i1+1,j2-j1+1
1867 The adressed content of obj?Dfrom is overwritten
1868 The non-adressed content of obj?Dfrom is left unchanged
1869 Related commands: copy
1870\end{verbatim}
1871\piacommand{h/deriv} \label{hZderiv}
1872\begin{verbatim}
1873Derivate a 1D histogram
1874 h/deriv nameh1d
1875 Related commands: h/integ v/integ v/deriv
1876\end{verbatim}
1877\piacommand{h/err} \label{hZerr}
1878\begin{verbatim}
1879Set Histo,Histo2D error to function of bin content value
1880 h/err namehisto expr_func
1881 Related commands: h/set/err
1882\end{verbatim}
1883\piacommand{h/get\_vec} \label{hZgetZvec}
1884\begin{verbatim}
1885Get content of histogram 1D profile or 2D into vector (matrix)
1886 h/get_vec nameh1d namevector [cont,err2,absc] [proj]
1887 h/get_vec nameh2d namematrix [cont,err2,absc]
1888 cont : get histogramme content
1889 err2 : get histogramme error^2
1890 absc : get histogramme low bin abscissa (1D only)
1891 proj :
1892 show : show available projections for Histo2D
1893 px : get X projection
1894 py : get Y projection
1895 bx n : get X band number n
1896 by n : get Y band number n
1897 sx n : get X slice number n
1898 sy n : get Y slice number n
1899 Related commands: h/put_vec
1900\end{verbatim}
1901\piacommand{h/integ} \label{hZinteg}
1902\begin{verbatim}
1903Integrate a 1D histogram
1904 h/integ nameh1d [norm]
1905 norm<=0 means no normalisation (def norm=1)
1906 Related commands: h/deriv v/integ v/deriv
1907\end{verbatim}
1908\piacommand{h/oper} \label{hZoper}
1909\begin{verbatim}
1910Operation on histograms vectors or matrices
1911 h/oper @ h1 h2 hres
1912 hres = h1 @ h2 with @ = (+,-,*,/)
1913 For vectors and matrices, operations are elements by elements
1914 Related commands: h/cadd h/cmult
1915\end{verbatim}
1916\piacommand{h/plot/2d} \label{hZplotZ2d}
1917\begin{verbatim}
1918Specific plot for 2D histogrammes
1919 h/plot/2d nameh2d show : infos on 2D histogramme
1920 h/plot/2d nameh2d h [dopt] : plot 2D histogramme
1921 h/plot/2d nameh2d px [dopt] : plot X projection
1922 h/plot/2d nameh2d py [dopt] : plot Y projection
1923 h/plot/2d nameh2d bx n [dopt] : plot X band number n
1924 h/plot/2d nameh2d by n [dopt] : plot Y band number n
1925 h/plot/2d nameh2d sx n [dopt] : plot X slice number n
1926 h/plot/2d nameh2d sy n [dopt] : plot Y slice number n
1927 n < 0 means Show Info
1928\end{verbatim}
1929\piacommand{h/put\_vec} \label{hZputZvec}
1930\begin{verbatim}
1931Put content of vector (matrix) into content of histogram 1D or 2D
1932 h/put_vec nameh1d namevector [cont,err2]
1933 h/put_vec nameh2d namematrix [cont,err2]
1934 cont : put into histogramme content
1935 err2 : put into histogramme error^2
1936 Related commands: h/get_vec
1937\end{verbatim}
1938\piacommand{h/rebin} \label{hZrebin}
1939\begin{verbatim}
1940Rebin a 1D histogram or profile
1941 h/rebin nameh1d nbin
1942\end{verbatim}
1943\piacommand{h/set/cont} \label{hZsetZcont}
1944\begin{verbatim}
1945Set Histo,Histo2D content for range of bins or range of values
1946 h/set/cont namehisto setvalue i1[:i2] [j1[:j2]]
1947 set content to setvalue for bin range i1:i2 j1:j2
1948 h/set/cont namehisto setvalue v v1:v2
1949 set content to setvalue for content values range v1:v2
1950 h/set/cont namehisto setvalue e e1:e2
1951 set content to setvalue for error values range v1:v2
1952 Related commands: h/set/err
1953\end{verbatim}
1954\piacommand{h/set/err} \label{hZsetZerr}
1955\begin{verbatim}
1956Set Histo,Histo2D errors for range of bins or range of values
1957 h/set/err namehisto setvalue i1[:i2] [j1[:j2]]
1958 set error to setvalue for bin range i1:i2 j1:j2
1959 h/set/err namehisto setvalue v v1:v2
1960 set error to setvalue for content values range v1:v2
1961 h/set/err namehisto setvalue e e1:e2
1962 set error to setvalue for error values range v1:v2
1963 Related commands: h/set/cont
1964\end{verbatim}
[2811]1965\piacommand{n/merge} \label{nZmerge}
1966\begin{verbatim}
1967Merge ntuples
1968 n/merge nt nt_1 nt_2 ... nt_n
1969 Merge ntuples nt_i into ntuple nt
1970\end{verbatim}
1971\piacommand{n/pl} \label{nZpl}
1972\begin{verbatim}
1973alias to n/plot (see n/plot)
1974\end{verbatim}
[2416]1975\piacommand{n/plot} \label{nZplot}
1976\begin{verbatim}
[2811]1977Plot NTuple variables "a la paw" (alias n/pl)
[2416]1978 n/plot nameobj.x_exp [cut] [w_exp] [loop] [gratt]
1979 n/plot nameobj.y_exp%x_exp [cut] [loop] [gratt]
1980 n/plot nameobj.z_exp%y_exp%x_exp [cut] [loop] [gratt]
1981 for default use ! , loop=i1[:i2[:di]]
[2811]1982 for 1 dimensional (1D) projection:
1983 use graphic option "keepbin" to keep previous
1984 plot binning for 1D distribution
[2416]1985 Related commands: plot2dw plot3d
1986\end{verbatim}
1987\piacommand{n/proj} \label{nZproj}
1988\begin{verbatim}
1989Project NTuple in histogram (1D or 2D) a la paw
1990 n/proj nameproj nameobj.x_exp [cut] [w_exp] [loop] [gratt]
1991 n/proj nameproj nameobj.y_exp%x_exp [cut] [w_exp] [loop] [gratt]
1992 for default use ! , loop=i1[:i2[:di]]
[2811]1993 for 1 dimensional (1D) projection:
1994 no display is performed if "nameproj" is an existing histogram
1995 unless a graphic option "gratt" is given
[2416]1996 Related commands: projh1d projh2d projprof exptovec
1997\end{verbatim}
[2811]1998\piacommand{n/read} \label{nZread}
1999\begin{verbatim}
2000Read columns in an ASCII file and fill a NTuple or a DataTable
2001 n/read nt fascii [options] var_1,c_1 var_2,c_2 ... var_n,c_n
2002 nt : NTuple or DataTable (see options) name
2003 var_i,c_i : variable name, associated column in ASCII file [0,n[
2004 where [options] are:
2005 "-dt": create a DataTable of double instead of a NTuple
2006 "=s": separator character is 's' (could be " ")
2007 "-^abcd": do not read lines beginning with string "abcd"
2008 "+^abcd": read only lines beginning with string "abcd"
2009 "-abcd": do not read lines which contain string "abcd"
2010 "+abcd": read only lines which contain string "abcd"
2011 these options may be repeated (ex: "-^abcd" "-^xyz")
2012 - in case of "do not read" options are added with logical AND
2013 - in case of "read only" options are added with logical OR
2014\end{verbatim}
[2416]2015\piacommand{n/scan} \label{nZscan}
2016\begin{verbatim}
2017Scan NTuple a la paw
2018 n/scan nameobj[.exp1%exp2%exp3] cut loop
2019 [-f:filename] [list_of_variables]
2020 loop : iev1[:iev2[:diev]] or !
2021 cut : cut expression or 1. or !
2022 list_of_variables : default is all variables
2023 : var1 var2 var3 ... varn
2024 : var1 : var2 (from var1 to var2)
2025 : : var2 (from first variable to var2)
2026 : var1 : (from var1 to last variable)
2027 ex: "v1 : v3 v7 v4 : v6 v2 v9 :"
2028 exp1%exp2%exp3 :
2029 if given add exp1,exp2,exp3 to the variable list
2030 -f:filename : write into "filename", Default is to stdout
2031\end{verbatim}
2032\piacommand{reset} \label{reset}
2033\begin{verbatim}
2034Reset histograms vectors or matrix
2035 reset nameobj
2036\end{verbatim}
2037\piacommand{v/deriv} \label{vZderiv}
2038\begin{verbatim}
2039Derivate a TVector / vector
2040 v/deriv namevec [deriv_option]
2041 deriv_option -1 replace v[i] with v[i]-v[i-1]
2042 0 replace v[i] with (v[i+1]-v[i-1])/2 (default)
2043 +1 replace v[i] with v[i+1]-v[i]
2044 Related commands: h/integ h/deriv v/integ
2045\end{verbatim}
2046\piacommand{v/integ} \label{vZinteg}
2047\begin{verbatim}
2048Integrate a TVector / vector
2049 v/integ namevec [norm]
2050 norm<=0 means no normalisation (def norm=0)
2051 Related commands: h/integ h/deriv v/deriv
2052\end{verbatim}
[2811]2053\piacommand{v/sort} \label{vZsort}
2054\begin{verbatim}
2055Sort a vector into itself
2056 v/sort namevec [+1/-1]
2057 "+1" means increasing order, "-1" decreasing order
2058\end{verbatim}
Note: See TracBrowser for help on using the repository browser.