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

Last change on this file since 3437 was 3437, checked in by ansari, 18 years ago

Suite doc piapp.tex/ajout syncmap.eps - Reza 11/12/2007

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