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

Last change on this file since 3041 was 3041, checked in by ansari, 19 years ago

ecriture documentation piapp pour piapp V4/sophya V2 , Reza 20/7/2006

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