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


Ignore:
Timestamp:
Jul 20, 2006, 7:12:06 PM (19 years ago)
Author:
ansari
Message:

ecriture documentation piapp pour piapp V4/sophya V2 , Reza 20/7/2006

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SophyaLib/Manual/piahelp.tex

    r2811 r3041  
    77\item {\bf Expr. Plotting }  (p. \pageref{ExprZZPlotting})
    88\item {\bf External Modules }  (p. \pageref{ExternalZModules})
     9\item {\bf FFT }  (p. \pageref{FFT})
    910\item {\bf FileIO }  (p. \pageref{FileIO})
    1011\item {\bf Fitting }  (p. \pageref{Fitting})
    … …  
    6970\vspace{3mm}
    7071\begin{tabular}{llllll}
    71 ObjectExpressions & p. \pageref{ObjectExpressions}  & exptovec & p. \pageref{exptovec}  & fillgd1 & p. \pageref{fillgd1}  \\ 
    72 fillgd2 & p. \pageref{fillgd2}  & fillmtx & p. \pageref{fillmtx}  & fillnt & p. \pageref{fillnt}  \\ 
    73 fillvec & p. \pageref{fillvec}  & gdfrvec & p. \pageref{gdfrvec}  & ntexpcfile & p. \pageref{ntexpcfile}  \\ 
    74 ntloop & p. \pageref{ntloop}  & plot2d & p. \pageref{plot2d}  & plot2de & p. \pageref{plot2de}  \\ 
    75 plot2dvec & p. \pageref{plot2dvec}  & plot2dw & p. \pageref{plot2dw}  & plot3d & p. \pageref{plot3d}  \\ 
    76 projh1d & p. \pageref{projh1d}  & projh2d & p. \pageref{projh2d}  & projprof & p. \pageref{projprof}  \\ 
     72ObjectExpressions & p. \pageref{ObjectExpressions}  & expmeansig & p. \pageref{expmeansig}  & exptovec & p. \pageref{exptovec}  \\ 
     73fillgd1 & p. \pageref{fillgd1}  & fillgd2 & p. \pageref{fillgd2}  & fillmtx & p. \pageref{fillmtx}  \\ 
     74fillnt & p. \pageref{fillnt}  & fillvec & p. \pageref{fillvec}  & gdfrvec & p. \pageref{gdfrvec}  \\ 
     75ntexpcfile & p. \pageref{ntexpcfile}  & ntloop & p. \pageref{ntloop}  & plot2d & p. \pageref{plot2d}  \\ 
     76plot2de & p. \pageref{plot2de}  & plot2dvec & p. \pageref{plot2dvec}  & plot2dw & p. \pageref{plot2dw}  \\ 
     77plot3d & p. \pageref{plot3d}  & plot3dw & p. \pageref{plot3dw}  & projh1d & p. \pageref{projh1d}  \\ 
     78projh2d & p. \pageref{projh2d}  & projprof & p. \pageref{projprof}  &   &   \\ 
    7779\end{tabular}
    7880\end{center}
    … …  
    8890\vspace{6mm}
    8991\begin{center}
     92 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf FFT } help group} \rule{2cm}{0.5mm} \\
     93\vspace{3mm}
     94\begin{tabular}{llllll}
     95fftback & p. \pageref{fftback}  & fftfilter & p. \pageref{fftfilter}  & fftforw & p. \pageref{fftforw}  \\ 
     96fftfuncfilter & p. \pageref{fftfuncfilter}  &   &  &  &   \\ 
     97\end{tabular}
     98\end{center}
     99\vspace{6mm}
     100\begin{center}
    90101 \rule{2cm}{0.5mm} \makebox[60mm]{{ \bf FileIO } help group} \rule{2cm}{0.5mm} \\
    91102\vspace{3mm}
    92103\begin{tabular}{llllll}
    93104arrtoascii & p. \pageref{arrtoascii}  & fitsadapt & p. \pageref{fitsadapt}  & mtxfrascii & p. \pageref{mtxfrascii}  \\ 
    94 ntfrascii & p. \pageref{ntfrascii}  & openfits & p. \pageref{openfits}  & openppf & p. \pageref{openppf}  \\ 
    95 print & p. \pageref{print}  & saveall & p. \pageref{saveall}  & savefits & p. \pageref{savefits}  \\ 
    96 savelist & p. \pageref{savelist}  & saveobjs & p. \pageref{saveobjs}  & saveppf & p. \pageref{saveppf}  \\ 
    97 vecfrascii & p. \pageref{vecfrascii}  &   &  &  &   \\ 
     105ntfrascii & p. \pageref{ntfrascii}  & openppf & p. \pageref{openppf}  & print & p. \pageref{print}  \\ 
     106readfits & p. \pageref{readfits}  & saveall & p. \pageref{saveall}  & savelist & p. \pageref{savelist}  \\ 
     107saveobjs & p. \pageref{saveobjs}  & saveppf & p. \pageref{saveppf}  & scanfits & p. \pageref{scanfits}  \\ 
     108vecfrascii & p. \pageref{vecfrascii}  & writefits & p. \pageref{writefits}  &   &   \\ 
    98109\end{tabular}
    99110\end{center}
    … …  
    177188newmtx & p. \pageref{newmtx}  & newnt & p. \pageref{newnt}  & newprof & p. \pageref{newprof}  \\ 
    178189newprofe & p. \pageref{newprofe}  & newvec & p. \pageref{newvec}  & ntcol2var & p. \pageref{ntcol2var}  \\ 
    179 ntline2var & p. \pageref{ntline2var}  & vec2var & p. \pageref{vec2var}  &   &   \\ 
     190ntline2var & p. \pageref{ntline2var}  & objaoper & p. \pageref{objaoper}  & vec2var & p. \pageref{vec2var}  \\ 
    180191\end{tabular}
    181192\end{center}
    … …  
    200211map2map & p. \pageref{map2map}  & mapcover & p. \pageref{mapcover}  & mapmult & p. \pageref{mapmult}  \\ 
    201212mapop & p. \pageref{mapop}  & maproj & p. \pageref{maproj}  & mapstat & p. \pageref{mapstat}  \\ 
    202 maskmap & p. \pageref{maskmap}  & settypemap & p. \pageref{settypemap}  & typemap & p. \pageref{typemap}  \\ 
     213maskmap & p. \pageref{maskmap}  & resol2szidx & p. \pageref{resol2szidx}  & settypemap & p. \pageref{settypemap}  \\ 
     214szidx2resol & p. \pageref{szidx2resol}  & typemap & p. \pageref{typemap}  &   &   \\ 
    203215\end{tabular}
    204216\end{center}
    … …  
    208220\vspace{3mm}
    209221\begin{tabular}{llllll}
    210 mollgrid & p. \pageref{mollgrid}  & mollgridsph & p. \pageref{mollgridsph}  & powerspec & p. \pageref{powerspec}  \\ 
    211 setprjmoldefval & p. \pageref{setprjmoldefval}  &   &  &  &   \\ 
     222mollgrid & p. \pageref{mollgrid}  & mollgridsph & p. \pageref{mollgridsph}  & setprjmoldefval & p. \pageref{setprjmoldefval}  \\ 
    212223\end{tabular}
    213224\end{center}
    … …  
    221232h/integ & p. \pageref{hZinteg}  & h/oper & p. \pageref{hZoper}  & h/plot/2d & p. \pageref{hZplotZ2d}  \\ 
    222233h/put\_vec & p. \pageref{hZputZvec}  & h/rebin & p. \pageref{hZrebin}  & h/set/cont & p. \pageref{hZsetZcont}  \\ 
    223 h/set/err & p. \pageref{hZsetZerr}  & n/merge & p. \pageref{nZmerge}  & n/pl & p. \pageref{nZpl}  \\ 
     234h/set/err & p. \pageref{hZsetZerr}  & n/assoc/col & p. \pageref{nZassocZcol}  & n/copy & p. \pageref{nZcopy}  \\ 
     235n/merge & p. \pageref{nZmerge}  & n/merge/col & p. \pageref{nZmergeZcol}  & n/pl & p. \pageref{nZpl}  \\ 
    224236n/plot & p. \pageref{nZplot}  & n/proj & p. \pageref{nZproj}  & n/read & p. \pageref{nZread}  \\ 
    225237n/scan & p. \pageref{nZscan}  & reset & p. \pageref{reset}  & v/deriv & p. \pageref{vZderiv}  \\ 
    … …  
    273285  > thrlist       # List of command execution threads (& as the last character)
    274286  > clearthrlist  # Removes finished threads from the list 
    275   > cancelthr Id  # Cancel a given thread (ThrId=id) 
     287  > killthr Id    # Try to stop a given thread (ThrId=id) by sending SIGUSR1
     288  > cancelthr Id  # Try to cancel a given thread (ThrId=id) 
    276289  > waitthr       # Waits until all active threads have finished (join())
    277290  > exec filename # Execute commands from file
    … …  
    467480The default Cut() expression in true (=1) for all
    468481
    469   Related commands: plot2d plot2de plot2dw plot3d
    470         projh1d projh2d  projprof fillvec fillmtx
    471         fillnt fillgd1 fillgd2 ntloop exptovec ...
     482 Related commands: plot2d plot2de plot2dw plot3d plot3dw
     483         projh1d projh2d  projprof fillvec fillmtx
     484         fillnt fillgd1 fillgd2 ntloop exptovec ...
     485\end{verbatim}
     486\piacommand{expmeansig} \label{expmeansig}
     487\begin{verbatim}
     488Computes Mean/Sigma (+Min/Max) for an expression X=f(Object)
     489 Usage: expmeansig nameobj f_X() [Cut() loop_param]
     490  Related commands: exptovec ntloop fillnt ObjectExpressions ...
    472491\end{verbatim}
    473492\piacommand{exptovec} \label{exptovec}
    … …  
    535554Plots (2D) Y=g(Object) vs. X=f(Object) --- Object Variable names (double) :
    536555 Usage: plot2d nameobj f_X() g_Y() [f_Cut() graphic_attributes loop_param]
    537   Related commands: plot2de plot2dw plot3d ObjectExpressions ...
     556  Related commands: plot2de plot2dw plot3d plot3dw ObjectExpressions ...
    538557\end{verbatim}
    539558\piacommand{plot2de} \label{plot2de}
    … …  
    556575\piacommand{plot3d} \label{plot3d}
    557576\begin{verbatim}
    558 Plots (3D) Z=h(Object) vs. Y=g(Object) vs. X=f(Object) vs
     577Plots (3D) Z=h(Object) vs. Y=g(Object) vs. X=f(Object)
    559578 Usage: plot3d nameobj f_X() g_Y() h_Z() [Cut() graphic_attributes loop_param]
    560   Related commands: plot2d plot2dw plot2de plot3d ObjectExpressions ...
     579  Related commands: plot2d plot2de plot3dw ObjectExpressions ...
     580\end{verbatim}
     581\piacommand{plot3dw} \label{plot3dw}
     582\begin{verbatim}
     583Plots (3D) Z=h(Object) vs. Y=g(Object) vs. X=f(Object) with Weight W=k(Object) 
     584 Usage: plot3d nameobj f_X() g_Y() h_Z() k_Wt() [Cut() graphic_attributes loop_param]
     585  Related commands: plot2d plot2dw plot3d ObjectExpressions ...
    561586\end{verbatim}
    562587\piacommand{projh1d} \label{projh1d}
    … …  
    610635  Usage: loadmodule fnameso modulename
    611636  Related commands: link
     637\end{verbatim}
     638\subsection{FFT} \label{FFT}
     639\noindent
     640\piacommand{fftback} \label{fftback}
     641\begin{verbatim}
     642FFT on a vector -> computes backward Fourier transform
     643 Usage: fftback vecSpec vecSig [graphic_att] [C/Z]
     644 vecSig = FFTBackward(vecSpec)
     645 vecSpec: Input data vector of type complex<r_8>
     646 vecSig:  Output Data vector of type r_8 (default)
     647    or complex<r_8> if C/Z specified or
     648    vecSpec computed by fftforw on a complex vector
     649 See also : fftforw fftfilter fftfuncfilter
     650\end{verbatim}
     651\piacommand{fftfilter} \label{fftfilter}
     652\begin{verbatim}
     653Filter (multiply) vecSpec (vector complex<r_8>) by Filter (vector<r_8>)
     654 Usage: fftfilter vecSpec FilterVec vecFiltSpec [graphic_att]
     655   vecFiltSpec(i) = vecSpec(i) * complex(FilterVec(i),0)
     656 See also : fftforw fftbackw fftfuncfilter
     657\end{verbatim}
     658\piacommand{fftforw} \label{fftforw}
     659\begin{verbatim}
     660FFT on a vector -> computes forward Fourier transform
     661 Usage: fftforw vecSig vecSpec [graphic_att]
     662 vecSpec = FFTForward(vecSig)
     663 vecSig: Input data vector of type r_8 or complex<r_8>
     664 vecSpec: Output data vector of type complex<r_8>
     665 See also : fftback fftfilter fftfuncfilter
     666\end{verbatim}
     667\piacommand{fftfuncfilter} \label{fftfuncfilter}
     668\begin{verbatim}
     669Filter (multiply) vecSpec (vector complex<r_8>) by FilterFunc(i)
     670 Usage: fftfilter vecSpec FilterFunc vecFiltSpec [graphic_att]
     671   vecFiltSpec(i) = vecSpec(i) * complex(FilterFunc(i),0)
     672 See also : fftforw fftbackw fftfilter
    612673\end{verbatim}
    613674\subsection{FileIO} \label{FileIO}
    … …  
    627688 hdu : Fits HDU (if <=0 take first binary/ascii table)
    628689 buflen[,bufsens,lp] : buffer length (sens) for fits reading (default is 100,1,0)
     690 See also  scanfits writefits readfits
    629691\end{verbatim}
    630692\piacommand{mtxfrascii} \label{mtxfrascii}
    … …  
    640702  Related commands: ntloop fillnt
    641703\end{verbatim}
    642 \piacommand{openfits} \label{openfits}
    643 \begin{verbatim}
    644 Loads a FITS file into an appropriate object
    645  Usage: openfits filename
    646   Related commands: savefits openppf
    647 \end{verbatim}
    648704\piacommand{openppf} \label{openppf}
    649705\begin{verbatim}
    650706Reads all or some objects from a PPF file
    651707 Usage: openppf filename [objname1 objname2 ...]
    652   Related commands: saveall openfits
     708  Related commands: saveall
    653709\end{verbatim}
    654710\piacommand{print} \label{print}
    655711\begin{verbatim}
    656712Prints an object
    657  Usage: print nameobj
     713 Usage: print nameobj [prtlev]
     714 prtlev = 0,1,2...  default: prtlev=0
     715\end{verbatim}
     716\piacommand{readfits} \label{readfits}
     717\begin{verbatim}
     718readfits: Read all HDU's of a fits file
     719Usage: readfits nameobj/pattern FileName
     720(use FitsManager) .... See also  scanfits writefits fitsadapt
    658721\end{verbatim}
    659722\piacommand{saveall} \label{saveall}
    … …  
    661724Saves all objects into a PPF file
    662725 Usage: saveall filename
    663   Related commands: saveobj savelist openppf savefits
    664 \end{verbatim}
    665 \piacommand{savefits} \label{savefits}
    666 \begin{verbatim}
    667 Save an object into a FITS file
    668  Usage: savefits nameobj filename
    669   Related commands: openfits saveobjs saveall
     726  Related commands: saveobj savelist openppf
    670727\end{verbatim}
    671728\piacommand{savelist} \label{savelist}
    … …  
    673730
    674731 Usage: savelist objname1 [objname2 ...] filename
    675   Related commands: saveobj openppf savefits
     732  Related commands: saveobj openppf
    676733\end{verbatim}
    677734\piacommand{saveobjs} \label{saveobjs}
    … …  
    680737  PPF file (pattern: x?y*) - Alias saveppf
    681738Usage: saveobjs nameobjpattern filename
    682   Related commands: saveppf savelist saveall openppf savefits
     739  Related commands: saveppf savelist saveall openppf
    683740\end{verbatim}
    684741\piacommand{saveppf} \label{saveppf}
    … …  
    687744  PPF file (pattern: x?y*) - Alias saveppf
    688745Usage: saveppf nameobjpattern filename
    689   Related commands: saveobjs savelist saveall openppf savefits
     746  Related commands: saveobjs savelist saveall openppf
     747\end{verbatim}
     748\piacommand{scanfits} \label{scanfits}
     749\begin{verbatim}
     750scanfits: scan fits files and print information on each HDU
     751Usage: scanfits FileName [slev=0 ... 3]
     752slev=1,3: header keywords , slev=2,3: try to read each HDU
    690753\end{verbatim}
    691754\piacommand{vecfrascii} \label{vecfrascii}
    … …  
    694757 Usage: vecfrascii vec_name file_name
    695758  Related commands: arrtoascii mtxfrascii ntfrascii [CommChar Separator]
     759\end{verbatim}
     760\piacommand{writefits} \label{writefits}
     761\begin{verbatim}
     762writefits: Write objects to a fits file
     763Usage: writefits nameobj/pattern FileName
     764(use FitsManager) .... See also  scanfits readfits fitsadapt
    696765\end{verbatim}
    697766\subsection{Fitting} \label{Fitting}
    … …  
    16251694  Related commands: vec2var ntcol2var
    16261695\end{verbatim}
     1696\piacommand{objaoper} \label{objaoper}
     1697\begin{verbatim}
     1698Perform an operation through the object adapter NObjMgrAdapter::PerformOperation()
     1699  Usage: objaoper objname operation [arg1 ...]
     1700  Examples of defined operations :
     1701  Matrices: row indx_row , col indx_col
     1702  Arrays: slicexy indx_Z , slicexz indx_Y, sliceyz indxX
     1703
     1704\end{verbatim}
    16271705\piacommand{vec2var} \label{vec2var}
    16281706\begin{verbatim}
    … …  
    18071885    operation is map(i) *= msk(theta,phi)
    18081886\end{verbatim}
     1887\piacommand{resol2szidx} \label{resol2szidx}
     1888\begin{verbatim}
     1889Compute SizeIndex value (=nside for HEALPix) for a
     1890 given resolution, (resol in arcminutes)
     1891 Usage: resol2szidx resol
     1892\end{verbatim}
    18091893\piacommand{settypemap} \label{settypemap}
    18101894\begin{verbatim}
    … …  
    18141898         T for ThetaPhi
    18151899\end{verbatim}
     1900\piacommand{szidx2resol} \label{szidx2resol}
     1901\begin{verbatim}
     1902Compute resolution for a given SizeIndex (=nside for HEALPix)
     1903 Usage: szidx2resol szidx_m
     1904\end{verbatim}
    18161905\piacommand{typemap} \label{typemap}
    18171906\begin{verbatim}
    … …  
    18301919Creates a spherical coordinate grid in Molleweide projection
    18311920 Usage: mollgridsph NameSphericalMap [Nb_Parallel Nb_Meridien graphic_att]
    1832 \end{verbatim}
    1833 \piacommand{powerspec} \label{powerspec}
    1834 \begin{verbatim}
    1835 FFT on a vector -> Plots power spectrum
    1836  Usage: fftp vecName vecFFT [graphic_att]
    18371921\end{verbatim}
    18381922\piacommand{setprjmoldefval} \label{setprjmoldefval}
    … …  
    19632047  Related commands: h/set/cont
    19642048\end{verbatim}
     2049\piacommand{n/assoc/col} \label{nZassocZcol}
     2050\begin{verbatim}
     2051Merge ntuples columns with an association index
     2052 n/assoc/col ntass[,u/i] nt_1[,ext] nt_2[,ext] nt_assoc[,icass]
     2053 Merge ntuples nt_1 and nt_2 columns into ntuple ntass
     2054   with line association number given by ntuple nt_assoc
     2055 ---
     2056 icass: association number given by column "icass" of nt_assoc (def=0)
     2057 ---
     2058 ext : character string to add at the end of the ntuple variable names
     2059   if "ext"="!" no extension is added
     2060   if no "ext" is given, automatic extension "_0" "_1" "_2" ...
     2061 ---
     2062 u   : do the union of all the lines of nt_1 and nt_2
     2063       (all ssociated and un-associated lines of nt_1 and nt_2)
     2064 i   : do the intersection of all the lines of nt_1 and nt_2
     2065       (only associated lines of nt_1 and nt_2)
     2066 def : write all lines of nt_1 with possible associated line of nt_2
     2067       (number of entries of ntass = number of entries of nt_1)
     2068\end{verbatim}
     2069\piacommand{n/copy} \label{nZcopy}
     2070\begin{verbatim}
     2071Copy all or some variables of a ntuple into another new ntuple
     2072 n/merge ntnew nt [vname1 vname2 vname3 ...]
     2073\end{verbatim}
    19652074\piacommand{n/merge} \label{nZmerge}
    19662075\begin{verbatim}
    1967 Merge ntuples
     2076Merge ntuples (by adding lines)
    19682077 n/merge nt nt_1 nt_2 ... nt_n
    1969  Merge ntuples nt_i into ntuple nt
     2078 Merge ntuples nt_i lines into ntuple nt
     2079\end{verbatim}
     2080\piacommand{n/merge/col} \label{nZmergeZcol}
     2081\begin{verbatim}
     2082Merge ntuples (by adding columns for each line)
     2083 n/merge/col nt nt_1[,ext] nt_2[,ext] ... nt_n[,ext]
     2084 Merge ntuples nt_i columns into ntuple nt
     2085 ext : character string to add at the end of the ntuple variable names
     2086   if "ext"="!" no extension is added
     2087   if no "ext" is given, automatic extension "_0" "_1" "_2" ...
    19702088\end{verbatim}
    19712089\piacommand{n/pl} \label{nZpl}
Note: See TracChangeset for help on using the changeset viewer.