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

Last change on this file since 2452 was 2416, checked in by cmv, 22 years ago

fabrication de piapp.ps rz+cmv 21/7/2003

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