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

Last change on this file since 3515 was 3490, checked in by ansari, 17 years ago

Mise a jour fichier piahelp.tex - Reza 29/04/2008

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