furanku

NMRPipe System Programs

nmrPipe

Pipeline-based Spectral Processing



Command-Line Argument List

Program nmrPipe, argument checking enabled.

 *-----------------------------------------------------------------*
 |             The NMRPipe System -- Legal Notice                  |
 |                                                                 |
 | This  program  and  its related software is provided  "as is".  |
 | It is based on a design originating in the NIH  Laboratory  of  |
 | Chemical Physics, NIDDK.  The NIH,  the Laboratory of Chemical  |
 | Physics,  NIDDK,  and the authors make  no warranties,  either  |
 | express or implied,  as to any matter whatsoever with  respect  |
 | to the software.  In particular,  any and  all  warranties  of  |
 | merchantability and fitness for  any  particular  purpose  are  |
 | expressly excluded.  In no event will the NIH,  the Laboratory  |
 | of Chemical Physics,  NIDDK,  or the authors be liable for any  |
 | loss  of  profits,  any  incidental,  special,  exemplary,  or  |
 | consequential damages  of  any  nature  whatsoever  (including  |
 | without  limitation,  loss  of  use  or  other  commercial  or  |
 | research loss) arising out  of  or  relating  to  the  use  or  |
 | performance of the software.                                    |
 *-----------------------------------------------------------------*
 | This program and its related software is based  on  a  design   |
 | originating in the NIH Laboratory of Chemical Physics, NIDDK.   |
 | It is not to be distributed or modified. (C) F. Delaglio 1995   |
 *-----------------------------------------------------------------*
 
 *** NMRPipe System Version 1.7 Rev 2000.020.15.13 ***

NMR Stream Processing:
nmrPipe -fn fnName [fnArgs] < inFile > outFile
Optional Flags:
 -in   inName     NMRPipe Format Input File Name.
 -out  outName    NMRPipe Format Output File Name.
 -ov              Force Overwrite of Existing Data.
 -nofs            Suppress File Size Check.
 -tty             Suppress Check for I/O to TTY.
 -inPlace         Allows in-place processing.
Data Type Adjustment; Select Only One:
Deleting Imaginary Data:
 -xi    Delete Imaginaries;
        Complex Data Only.
 -dt    Delete Imaginaries;
        Hypercomplex (Double Block) Only.
 -di    Delete Current Imaginaries;
        Hypercomplex or Complex Data.
Creating Empty Imaginary Data:
 -ai    Create Imaginaries;
        Real Data Only.
 -ad    Create Hypercomplex Imaginaries;
        Complex Data Only.
 -ac    Create Current Imaginaries;
        Real or Complex Data.
Processing or Pass-Through of a Selected Region:
 -select  Y1 YN ...  Specification of Region Limits.
 -outside            Process vectors outside region.
 -inside             Process vectors inside region;
                     (Default).
Report Modes:
 -verb  verboseLevel               [2]
 -inc   verboseIncrement          [16]
 -dbg   debugReportLevel           [0]
 -noSig Suppress Signal Catching.
 -X11   X11 is available for reports.
Help Text:
 -help    Prints help text; use the
          -fn fnName switch for more.
 -allHelp Prints help text for all
          functions (requires -help).
Parallel Processing:
 -client  serverListName
 -server  portFileName
 -sID     serverID
 -inSock  inSocketPort
 -outSock outSocketPort
 -path    pathName          [$cwd]
 -smt     serverMaxTries    [-1]
 -sto     serveruSecTimeOut [512]
Header Control:
 -inHdr   inHdrName      Use Name or !cmnd.
 -outHdr  outHdrName     Use Name, !cmnd, or 'none'.
 -inSwap                 Byte Swap of Input  ON.
 -outSwap                Byte Swap of Output ON.
 -fdata   loc1 parm1...  Parameter/Value List.
I/O Control:
 -buff    ioBuffCount       [0]
 -ibuff   inputBuffCount    [0]
 -obuff   outputBuffCount   [0]
 -mt      maxTries          [-1]
 -to      uSecTimeOut       [512]
 -noRd    Suppress Reading of Input.
 -noWr    Suppress Writing of Output.

Processing Functions:
 -fn NULL                                              Null Function
 -fn FT       [-inv -real -alt -bruk -auto]            Fourier Transform
 -fn RFT      [-inv]                                   Real Transform
 -fn HT       -ps90-180 -zf                            Hilbert Transform
 -fn MC                                                Modulus Calculation
 -fn TP       [-hyper -nohyper -auto]                  2D Transpose XY->YX
     YTP      [-hyper -nohyper -auto]                  2D Transpose XY->YX
     XY2YX    [-hyper -nohyper -auto]                  2D Transpose XY->YX
 -fn ZTP                                               3D Transpose XYZ->ZYX
     XYZ2ZYX                                           3D Transpose XYZ->ZYX
 -fn ZF       [-zf count | -size xSize -inv ETC...]    Zero Fill
 -fn REV      [-sw]                                    Reverse Data
 -fn PS       [-p0 degP0 -p1 degP1 -ht -inv ETC...]    Phase Correct
 -fn APOD     [-qName -q1 -q2 -q3 -start -size ETC...] Generic Apodization
 -fn EM       [-lb lbHz -start -size -c ETC...]        Exponential Multiply
 -fn GM       [-g1 -g2 -g3 -start -size -c ETC...]     Lorentz-to-Gauss
 -fn GMB      [-gb -lb -start -size -c ETC...]         Gauss Broaden Window
 -fn TM       [-t1 len -t2 len -start -size -c ETC...] Trapezoid Multiply
 -fn SP       [-off -end -pow -start -size -c ETC...]  Adjustable Sine Bell
     SINE     [-off -end -pow -start -size -c ETC...]  Adjustable Sine Bell
 -fn TRI      [-loc -lHi -rHi -start -size -c ETC...]  Triangle Window
 -fn ZD       [-wide -x0 -slope -func -g]              Zero Diagonal
 -fn MIR      [-left | -right -invl -invr | -ps90-180] Mirror Image
 -fn EXT      [-left | -time | -x1 -xn -sw ETC...]     Extract Region
 -fn CBF      [-last percent | -reg x1 x2... -slice..] Constant Baseline
 -fn FSH      [-ls leftShiftPts -sw -nosw]             Frequency Shift
 -fn MAC      [-macro macroName -all]                  MACRO Processing
 -fn LP       [-x1 -xn -ord -pred -fb -b ETC...]       Linear Prediction
     LPC      [-x1 -xn -ord -pred -fb -b ETC...]       Linear Prediction
 -fn LP2D     [-xOrd -yOrd -xSize -ySize ETC...]       2D Linear Prediction
 -fn DX                                                Derivative
 -fn INTEG                                             Integral
 -fn SOL      [-mode -fs -fl -sn -sf -head ETC...]     Solvent Filter
 -fn BASE     [-nl nList -nw nWidth]                   Linear Corrections
 -fn POLY     [-sx1 -sxn -nw -nc -nl -ord ETC...]      Polynomial Subtract
 -fn MED      [-nw nodeWidth -sf smothWidth -avg]      Median Baseline
 -fn SMO      [-n nWidth]                              N-Point Smooth
 -fn CS       [-rs rsPts | -ls lsPts -neg -sw -nosw]   Circular Shift
 -fn RS       [-rs rsPts -sw -nosw]                    Right Shift
 -fn LS       [-ls lsPts -sw -nosw]                    Left Shift
 -fn SHUF     [-ri2c -c2ri -exlr -rolr ETC...]         Shuffle Data
 -fn SIGN     [-r -i -left -right -abs -alt]           Sign Manipulation
 -fn SET      [-r cR -i cI -c cC -x1 pnt1 -xn pntN]    Set Data to Constant
 -fn ADD      [-r cR -i cI -c cC -x1 pnt1 -xn pntN]    Add a Constant
 -fn MULT     [-r cR -i cI -c cC -x1 pnt1 -xn pntN...] Multiply Data
 -fn COADD    [-c cList -axis aName -time]             Co-Addition of Data
     COAD     [-c cList -axis aName -time]             Co-Addition of Data
 -fn QMIX     [-ic -oc -cList -time]                   Complex Mixing
 -fn QART     [-a cI -f cR]                            Scale Quad Artifacts
 -fn SAVE     [-name]                                  Save Current Data
 -fn ANN      [-rms noise -wName wtTab -c scale]       ANN Fourier Analysis
 -fn MEM      [-sigma timeDomNoise -zero -neg...]      ND Maximum Entropy
 -fn ML       [-sigma timeDomNoise -w wName]           Maximum Likelihood
 -fn IMG      [-dx dx -dy dy -kern kList ...]          Image Processing
 -fn DMUSIC   [-fStep -dStep -d1 -dN ...]              DMUSIC Analysis
 -fn DEV                                               Development Use
NULL: No Change to Data.