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

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

MAJ fichier piahelp.tex genere par piapp , Reza 11/10/2006

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