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

Last change on this file since 3085 was 3061, checked in by cmv, 19 years ago

un oeu de texte cmv 14/8/2006

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