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

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

Ajout aknowledgments ds docs et + chapitre 5 ds piapp.tex (expression plotting) - Reza 12/12/2007

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