Changeset 3429 in Sophya for trunk/SophyaLib/Manual/piahelp.tex


Ignore:
Timestamp:
Dec 10, 2007, 12:28:29 AM (18 years ago)
Author:
ansari
Message:

Chapitre V complete sur data formats,I/O + maj piahelp.tex genere par la derniere version de piapp (V=4.1) - Reza 10/12/2007

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SophyaLib/Manual/piahelp.tex

    r3093 r3429  
    7474fillnt & p. \pageref{fillnt}  & fillvec & p. \pageref{fillvec}  & gdfrvec & p. \pageref{gdfrvec}  \\ 
    7575ntexpcfile & p. \pageref{ntexpcfile}  & ntloop & p. \pageref{ntloop}  & plot2d & p. \pageref{plot2d}  \\ 
    76 plot2de & p. \pageref{plot2de}  & plot2dvec & p. \pageref{plot2dvec}  & plot2dw & p. \pageref{plot2dw}  \\ 
    77 plot3d & p. \pageref{plot3d}  & plot3dw & p. \pageref{plot3dw}  & projh1d & p. \pageref{projh1d}  \\ 
    78 projh2d & p. \pageref{projh2d}  & projprof & p. \pageref{projprof}  &   &   \\ 
     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}  \\ 
    7979\end{tabular}
    8080\end{center}
    … …  
    103103\begin{tabular}{llllll}
    104104arrtoascii & p. \pageref{arrtoascii}  & fitsadapt & p. \pageref{fitsadapt}  & mtxfrascii & p. \pageref{mtxfrascii}  \\ 
    105 ntfrascii & p. \pageref{ntfrascii}  & openppf & p. \pageref{openppf}  & print & p. \pageref{print}  \\ 
    106 readfits & p. \pageref{readfits}  & saveall & p. \pageref{saveall}  & savelist & p. \pageref{savelist}  \\ 
    107 saveobjs & p. \pageref{saveobjs}  & saveppf & p. \pageref{saveppf}  & scanfits & p. \pageref{scanfits}  \\ 
    108 swfitstable & p. \pageref{swfitstable}  & vecfrascii & p. \pageref{vecfrascii}  & writefits & p. \pageref{writefits}  \\ 
     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}  &   &   \\ 
    109110\end{tabular}
    110111\end{center}
    … …  
    162163bargraph & p. \pageref{bargraph}  & contour & p. \pageref{contour}  & disp & p. \pageref{disp}  \\ 
    163164gfd2d & p. \pageref{gfd2d}  & gfd3d & p. \pageref{gfd3d}  & imag & p. \pageref{imag}  \\ 
    164 imagnav & p. \pageref{imagnav}  & nt2d & p. \pageref{nt2d}  & nt2dvec & p. \pageref{nt2dvec}  \\ 
    165 nt3d & p. \pageref{nt3d}  & ntcont & p. \pageref{ntcont}  & surf & p. \pageref{surf}  \\ 
    166 textdrawer & p. \pageref{textdrawer}  & vecplot & p. \pageref{vecplot}  &   &   \\ 
     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}  &   &  &  &   \\ 
    167169\end{tabular}
    168170\end{center}
    … …  
    174176cd & p. \pageref{cd}  & copy & p. \pageref{copy}  & cp & p. \pageref{cp}  \\ 
    175177del & p. \pageref{del}  & delobjs & p. \pageref{delobjs}  & listdirs & p. \pageref{listdirs}  \\ 
    176 listobjs & p. \pageref{listobjs}  & mkdir & p. \pageref{mkdir}  & mv & p. \pageref{mv}  \\ 
    177 pwd & p. \pageref{pwd}  & rename & p. \pageref{rename}  & rm & p. \pageref{rm}  \\ 
    178 rmdir & p. \pageref{rmdir}  & setdiratt & p. \pageref{setdiratt}  &   &   \\ 
     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}  \\ 
    179181\end{tabular}
    180182\end{center}
    … …  
    232234h/get\_vec & p. \pageref{hZgetZvec}  & h/integ & p. \pageref{hZinteg}  & h/oper & p. \pageref{hZoper}  \\ 
    233235h/plot/2d & p. \pageref{hZplotZ2d}  & h/put\_vec & p. \pageref{hZputZvec}  & h/rebin & p. \pageref{hZrebin}  \\ 
    234 h/set/cont & p. \pageref{hZsetZcont}  & h/set/err & p. \pageref{hZsetZerr}  & n/assoc/col & p. \pageref{nZassocZcol}  \\ 
    235 n/copy & p. \pageref{nZcopy}  & n/merge & p. \pageref{nZmerge}  & n/merge/col & p. \pageref{nZmergeZcol}  \\ 
    236 n/pl & p. \pageref{nZpl}  & n/plot & p. \pageref{nZplot}  & n/proj & p. \pageref{nZproj}  \\ 
    237 n/read & p. \pageref{nZread}  & n/scan & p. \pageref{nZscan}  & reset & p. \pageref{reset}  \\ 
    238 v/deriv & p. \pageref{vZderiv}  & v/integ & p. \pageref{vZinteg}  & v/sort & p. \pageref{vZsort}  \\ 
     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}  &   &   \\ 
    239242\end{tabular}
    240243\end{center}
    … …  
    467470  (_nl is the table line number or the sequential index)
    468471- NTuple: ntuple variable names,_nl
    469 - Histo1D/HProf/HistoErr: i,x,val,err,nb,_nl
     472- Histo1D/HProf: i,x,val,err,nb,_nl
    470473- 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
    471476- Vector/Matrix: n,r,c,val,real,imag,mod,phas,_nl
    472477- TArray: n,x,y,z,t,u,val,real,imag,mod,phas,_nl
    … …  
    504509\piacommand{fillgd2} \label{fillgd2}
    505510\begin{verbatim}
    506 Creates and Fills a GeneralFitData with (X=f(Object), Y=g(...), Z=h(...)) ErrZ=k(...)
    507  Usage: fillgd1 namegfd nameobj f_X() g_Y() h_Z() k_ErrZ() [Cut() loop_param]
     511Creates and Fills a GeneralFitData with
     512            (X=f(Object), Y=g(...), Z=h(...)) ErrZ=k(...)
     513 Usage: fillgd2 namegfd nameobj f_X() g_Y() h_Z() k_ErrZ()
     514                                [Cut() loop_param]
    508515  Related commands: ntloop fillnt ObjectExpressions ...
    509516\end{verbatim}
    … …  
    511518\begin{verbatim}
    512519Fills a Matrix M(Line=g_Y(Object)+0.5, Col=f_X(Object)+0.5)) =  h_V(Object)
    513  Usage: fillvec namevec nameobj f_X() g_Y() h_V() [Cut() graphic_attributes loop_param]
     520 Usage: fillmtx namevec nameobj f_X() g_Y() h_V()
     521                [Cut() graphic_attributes loop_param]
    514522  Related commands: fillvec fillnt ObjectExpressions ...
    515523\end{verbatim}
    516524\piacommand{fillnt} \label{fillnt}
    517525\begin{verbatim}
    518 Creates and Fills an NTuple(x,y,z,t) with (X=f(Object),Y=g(...),Z=h(...),T=k(...))
     526Creates and Fills an NTuple(x,y,z,t) with
     527            (X=f(Object),Y=g(...),Z=h(...),T=k(...))
    519528 Usage: fillnt nameobj f_X() g_Y() h_Z() k_T() [Cut() nameNt loop_param]
    520529  Related commands: ntloop plot2d projh1d projh2d projprof
    521   Related commands: fillvec fillmtx ntloop exptovec fillgd1 fillgd2 ObjectExpressions ...
     530  Related commands: fillvec fillmtx ntloop exptovec fillgd1
     531                    fillgd2 ObjectExpressions ...
    522532\end{verbatim}
    523533\piacommand{fillvec} \label{fillvec}
    … …  
    545555\begin{verbatim}
    546556Loops over an Object NTupleInterface calling a function from a C-file
    547 and optionaly fills an NTuple(x,y,z,t) with (X=f(Object),Y=g(...),Z=h(...),T=k(...))
     557and optionaly fills an NTuple(x,y,z,t) with
     558     (X=f(Object),Y=g(...),Z=h(...),T=k(...))
    548559 Usage: ntloop nameobj CFileName FuncName [NtupleName loop_param]
    549   Related commands: fillvec fillmtx fillnt fillgd1 fillgd2 exptovec ObjectExpressions ...
    550   Related commands: ntexpcfile fillnt
     560  Related commands: fillvec fillmtx fillnt fillgd1 fillgd2
     561  Related commands: exptovec ntexpcfile fillnt ObjectExpressions ...
    551562\end{verbatim}
    552563\piacommand{plot2d} \label{plot2d}
    … …  
    556567  Related commands: plot2de plot2dw plot3d plot3dw ObjectExpressions ...
    557568\end{verbatim}
     569\piacommand{plot2dc} \label{plot2dc}
     570\begin{verbatim}
     571Plots (2D) Y=g(Object) vs. X=f(Object) with Color ColIndex=h(Object)
     572 Usage: plot2dc nameobj f_X() g_Y() h_Col() [Cut() graphic_attributes loop_param]
     573  Related commands: plot2d plot2dw plot3d ObjectExpressions ...
     574\end{verbatim}
    558575\piacommand{plot2de} \label{plot2de}
    559576\begin{verbatim}
    560577Plots (2D) Y=g(Object) vs. X=f(Object) with error bars eX/Y=f_ErrX/Y(Object)
    561  Usage: plot2de nameobj f_X() g_Y() f_ErrX() f_ErrY() [f_Cut() graphic_attributes loop_param]
     578 Usage: plot2de nameobj f_X() g_Y() f_ErrX() f_ErrY() [f_Cut()
     579                graphic_attributes loop_param]
    562580  Related commands: plot2d plot2dw plot3d ObjectExpressions ...
    563581\end{verbatim}
    … …  
    571589Plots (2D) Y=g(Object) vs. X=f(Object) with Weight W=h(Object)
    572590 Usage: plot2dw nameobj f_X() g_Y() h_Wt() [Cut() graphic_attributes loop_param]
    573   Related commands: plot2d plot2dw plot3d ObjectExpressions ...
     591  Related commands: plot2d plot2dc plot3d ObjectExpressions ...
    574592\end{verbatim}
    575593\piacommand{plot3d} \label{plot3d}
    … …  
    595613\begin{verbatim}
    596614Projects (X=f(Object),Y=g(Object)) with weight WT=h(Object) into a 2D histogram
    597  Usage: projh2d nameh2d nameobj f_X() g_Y() [h_WT()=1. Cut() graphic_attributes loop_param]
     615 Usage: projh2d nameh2d nameobj f_X() g_Y() [h_WT()=1. Cut()
     616                graphic_attributes loop_param]
    598617   Histo2D nameh2d is created if necessary
    599618  Related commands: projh1d projprof ObjectExpressions ...
    … …  
    602621\begin{verbatim}
    603622Projects (X=f(Object),Y=g(Object)) with weight WT=h(Object) into a profile histogram
    604  Usage: projprof nameprof nameobj f_X() g_Y() [h_WT()=1. Cut() graphic_attributes loop_param]
     623 Usage: projprof nameprof nameobj f_X() g_Y() [h_WT()=1. Cut()
     624                 graphic_attributes loop_param]
    605625   HProf nameprof is created if necessary
    606626  Related commands: projh1d projh2d ObjectExpressions ...
    … …  
    702722  Related commands: ntloop fillnt
    703723\end{verbatim}
     724\piacommand{openfits} \label{openfits}
     725\begin{verbatim}
     726openfits: alias for readfits
     727
     728\end{verbatim}
    704729\piacommand{openppf} \label{openppf}
    705730\begin{verbatim}
    706 Reads all or some objects from a PPF file
    707  Usage: openppf filename [objname1 objname2 ...]
    708   Related commands: saveall
     731Reads all or some objects from a PPF file
     732  Usage: (1) openppf filename
     733     Or  (2) openppf -s filename (2)
     734     Or  (3) openppf filename objname1 [ objname2 ...]
     735  The first form reads all objects at NameTags,
     736    or all objects if the file has no NameTags.
     737  The third reads only the objects with the specified nametags
     738  Related commands: saveppf saveall savelist
    709739\end{verbatim}
    710740\piacommand{print} \label{print}
    … …  
    726756 Usage: saveall filename
    727757  Related commands: saveobj savelist openppf
     758\end{verbatim}
     759\piacommand{savefits} \label{savefits}
     760\begin{verbatim}
     761savefits: alias for writefits
     762
    728763\end{verbatim}
    729764\piacommand{savelist} \label{savelist}
    … …  
    943978\begin{verbatim}
    944979Displays a function z=f(x,y) from a C-file (Fills a matrix with function values)
    945  Usage: func2dff C-FileName FunctionName xmin xmax nptx ymin ymax npty [graphic_attributes]
    946   Related commands: func funcff func2d
     980 Usage: func2dff C-FileName FunctionName xmin xmax nptx ymin ymax npty [gr_att]
     981Related commands: func funcff func2d
    947982\end{verbatim}
    948983\piacommand{funcff} \label{funcff}
    … …  
    11981233o <Alt>D : Shows the drawer manipulation pop-up menu
    11991234o <Alt>V : Copy/Paste / Text paste at the current cursor position
    1200 o <Alt>C : Copy/Paste / Copies the selected regions content as text in the copy/paste buffer
     1235o <Alt>C : Copy/Paste / Copies the selected region content as text
     1236                        in the copy/paste buffer
    12011237o <Alt>X : Show/Hide the Cut Window
    12021238o <Alt>Z : Removes added graphic elements (handled by BaseDrawer - 0)
    … …  
    12481284o Most objects can be also be displayed overlayed
    12491285  on the last displayed widget (gr_att= same)
    1250 o The overlay can be on a selected rectangle of the
    1251   last displayed widget (gr_att= inset) - See setinsetlimits
     1286  or by specifying a widget name samew=Widgetname
     1287o The widget/window name can be specified (gr_att wname=Name)
     1288o The overlay can be on a selected rectangle of the last
     1289  displayed widget (gr_att: inset  or inset=fxmin,fxmax,fymin,fymax)
    12521290
    12531291  Related commands: newwin zone stacknext graphicatt setinsetlimits
    … …  
    13101348>> imagecenter=ix,iy : Position the image in widget
    13111349>> lut=ltyp,min,max : Sets LUT type and min/max
    1312                       (ltyp=lin/log/sqrt/square)
     1350                   (ltyp=lin/log/sqrt/square)
     1351>> autolut=alt[,ns[,min,max]] : AutoLut method selection
     1352                   (alt=minmax/meansig/hispeak/histail)
    13131353>> invx,invy,exchxy : image axes configuration
    1314 >> for Axes / Axe labels / LogScale / xylimits / defdrrect
    1315        see setaxesatt command
    13161354--- General purpose options:
    13171355>> stat,stats / nsta,nstat,nostat,nostats : Toggle statistic display
    13181356>> title,tit / notitle,notit -> Toggle automatic title display
    13191357>> Choose display window: next same win stack inset
     1358>> for Axes / Axe labels / LogScale / xylimits / defdrrect
     1359       see setaxesatt command
    13201360
    13211361   Related commands: setaxesatt setinsetlimits
    … …  
    13871427Define the display rectangle for drawers added as insets
    13881428 over existing graphic objects - limits expressed as fraction
    1389  graphic object size (0. .. 1.) Xmax at right, YMax top.  Usage: setinsetlimits xmin xmax ymin ymax
     1429 graphic object size (0. .. 1.) Xmax at right, YMax top
     1430  Usage: setinsetlimits xmin xmax ymin ymax
    13901431  Related commands: graphicatt /inset
    13911432\end{verbatim}
    … …  
    14821523Displays Points (X-Y) [with error-bar / Weight / Label ] from an NTuple
    14831524 Usage : nt2d nameobj varx vary [errx erry wt label graphic_attributes]
    1484   Related commands: disp  surf  nt3d  gfd2d vecplot
     1525  Related commands: disp surf nt2dcn nt2dci nt3d  gfd2d vecplot
     1526\end{verbatim}
     1527\piacommand{nt2dci} \label{nt2dci}
     1528\begin{verbatim}
     1529   with colors specified by a column content (as color index)
     1530 Usage : nt2dci nameobj color varx vary [errx erry wt label graphic_attributes]
     1531  Related commands: disp  surf  nt2d nt2dci nt3d  gfd2d vecplot
     1532\end{verbatim}
     1533\piacommand{nt2dcn} \label{nt2dcn}
     1534\begin{verbatim}
     1535   with colors specified by a column content (as color names)
     1536 Usage : nt2dcn nameobj color varx vary [errx erry wt label graphic_attributes]
     1537  Related commands: disp  surf  nt2d nt2dci nt3d  gfd2d vecplot
    14851538\end{verbatim}
    14861539\piacommand{nt2dvec} \label{nt2dvec}
    … …  
    15711624\begin{verbatim}
    15721625Prints the list of objects (Alias: ls)
    1573  Usage: listobjs [patt=*]
    1574  patt : /*/x?y* ...
     1626 Usage: listobjs [patt=*] 
     1627    Or  listobjs patt VarName
     1628   Obj. name pattern patt in the form abc?x* or /*/x?y ...
     1629\end{verbatim}
     1630\piacommand{ls} \label{ls}
     1631\begin{verbatim}
     1632 Alias for listobjs
     1633 Usage: ls [patt=*] [VarName]
    15751634\end{verbatim}
    15761635\piacommand{mkdir} \label{mkdir}
    … …  
    18331892\begin{verbatim}
    18341893Project a map(double) into a local map(double)
    1835  Usage: map2local map(double) localmap(double) nx,ny angleX,angleY phi0,theta0 [x0,y0] [angle]
     1894 Usage: map2local map(double) localmap(double) nx,ny angleX,angleY phi0,theta0
     1895                  [x0,y0] [angle]
    18361896   nx,ny: number of pixels in x(col),y(row) direction
    18371897          X-axis==phi, Y-axis==theta
    … …  
    20682128     set error to setvalue for error values range v1:v2
    20692129  Related commands: h/set/cont
     2130\end{verbatim}
     2131\piacommand{herr/mean} \label{herrZmean}
     2132\begin{verbatim}
     2133Perform bin mean computation for HistoErr and Histo2DErr
     2134 herr/mean nameherr todo
     2135    todo = +1 : compute mean
     2136         = -1 : cancel computation
     2137\end{verbatim}
     2138\piacommand{herr/variance} \label{herrZvariance}
     2139\begin{verbatim}
     2140Perform bin mean and variance computation for HistoErr and Histo2DErr
     2141 herr/variance nameherr todo
     2142    todo = +1 : compute mean and variance
     2143         = -1 : cancel computation
    20702144\end{verbatim}
    20712145\piacommand{n/assoc/col} \label{nZassocZcol}
Note: See TracChangeset for help on using the changeset viewer.