furanku

NMRPipe System Programs

bin2pipe

General Purpose Binary Format Conversion



Command-Line Argument List

Program bin2pipe, argument checking enabled.
 *** NMRPipe System Version 1.7 Rev 2000.012.14.42 ***
Bin2Pipe: Four-Byte Binary to NMRPipe Conversion;
 bin2pipe hdrFlags < binData > pipeFile
General Flags:
 -in  inName           Four-Byte Binary Input.
 -in  inNameR inNameI  Four-Byte Binary Input Pair.
 -out outTemplate      NMRPipe Output.
 -ov                   Force Overwrite.
 -nodir                Suppress Directory Creation.
 -nofs                 Suppress File Size Check.
 -verb                 Verbose Mode On.
General Format Flags:
 -bo bytOff [0] Byte Offset at Start of Input.
 -bp bytPad [0] Bytes Between 1D Slices in Input.
 -pad           Pad missing data by zeros.
 -nopad         Suppress padding by zeros (Default).
 -il            Interleave Pairs of Input Planes;
                (Default if two inputs are given).
 -noil          No Interleave of Input Planes;
                (Default if one input is given).
 -i2r           Do Int-to-Real Conversion.
 -neg           Do Negation of Imaginary Data.
 -ri            Do Separation of Real/Imag.
 -bad bPt [0.0] Bad Point Threshold;
                (Use 0.0 for No Bad Point Adjust).
Byte-Swap Options:
 -swap             Do Four-Byte Swap.
 -noswap           Suppress Four-Byte Swap (Default).
 -aswap            Do Four-Byte Swap.
                   (Meaning is System-dependant)
 -noaswap          Suppress Four-Byte Swap.
                   (Meaning is System-dependant)
Specific Format Flags:
 -alpha    Same As: -bo 8704  -i2r -ri -neg -aswap
 -alpha2   Same As: -bo 16384 -i2r -ri -neg -aswap
 -lambda   Same As: -bo -1 -ri -neg -aswap
 -gsx      Same As: -ri -i2r -aswap
 -ex       Same As: -ri -i2r -aswap
 -chem     Same As: -i2r -aswap
 -ge       Same As: -ri -noaswap
 -ftOLD    Same As: -bo 8 -bp 12 -ri -pad -noaswap
           (Required byte offset may vary)
 -ftNEW    Same As: -bo 1036 -bp 4 -ri -pad -noaswap
           (Required byte offset may vary)
Null Data Flags:
 -noIn      No Input Data; Use Zeros.
 -noOut     No Output Data; Header Only.
Parallel Processing: (Not yet implemented)
 -par   sListName  Server List File Name.
 -first firstPlane First Plane to process.
 -last  lastPlane  Last Plane to process.
Notes:
 1. JEOL GSX Phase-Sensitive input is specified
    as a pair of file names.
 2. JEOL LAMBDA mode (-lambda) will attempt to
    find the byte offset from the JEOL header.
 3. By default, byte-swap is ON for Pentium systems,
    and OFF for other platforms.

General Header Flags:
 -fdata loc val... Adjust File Header.
 -u1 -u2...-u5     User Parameters.
 -ndim             Number of Dimensions.
 -tau              Tau Value.
 -day              Day.
 -month            Month [1-12].
 -year             Year.
 -hours            Hours [0-23]
 -mins             Minutes [0-59]
 -secs             Seconds [0-59]
 -temp             Temperature.
 -aq2D             2D Acquisition Code or Keyword:
                      0=Magnitude.
                      1=TPPI.
                      2=States.
                      3=Image.
 -tpFlag           0=Not Transposed.
                   1=Transposed.

Header Labels:
 -srcName          Source File Name.
 -operName         Operator Name.
 -userName         User Name.
 -comment          Comment.
 -title            Title.

Axis-Specific Header Flags -xQ -yQ etc;
Default Values are zero:
 -xN   Actual Size in File.      Pts Real plus Imag.
 -xT   Current Time Domain Size. Pts Real or Imag.
 -xSW  Full Spectral Width.      Hz.
 -xOBS Observe Frequency.        MHz.
 -xCAR Carrier Position.         ppm.
 -xLAB Axis Label.               8 Chars.

 -xMODE  Acquisition Mode Code or Keyword:
          0=Complex,States,Complex-N,States-N.
          0=States-TPPI,States-TPPI-N.
          1=Real,TPPI.
          2=Sequential,Bruker.

 -xALT   Sign Adjustment Code or Keyword:
          0=Complex,States    No Alternation Needed.
          0=Real,TPPI         No Alternation Needed.
          1=Sequential,Bruker Real Alternation.
          2=States-TPPI       Complex Alternation.
         With Negation of Imaginaries:
          16=Complex-N        No Alternation Needed.
          16=States-N         No Alternation Needed.
          18=States-TPPI-N    Complex Alternation.

Note: Default Sign Adjustment Mode is Automatically
Set by the Corresponding Acquisition Mode Keyword.

Axis-Specific Header Flags -xQ -yQ etc;
Not required for conversion; used to adjust header:
 -xTD    Original Time Domain Size. Pts.
 -xMID   Carrier Virtual Loc.       Pts.
 -xORIG  Last Point Coord.          Hz.
 -xDIM   Dimension Order.
          2=Original X-Axis
          1=Original Y-Axis
          3=Original Z-Axis
          4=Original A-Axis
 -xFT    Fourier Flag         Code or Keyword:
          0=Time              Time-Domain Data.
          1=Freq              Frequency-Domain Data.

Special Acquisition-Axis Flags (no longer required):
 -aqN     Actual Size.         Pts Real or Imag.
 -aqMODE  Acquisition Mode.    0=Complex.
                               1=Real.
                               2=Sequential.

Axis-Specific Processing Values -xQ -yQ etc:
 -xAPOD  Apodize Function      SP EM GM TM TRI or NONE.
 -xQ1    Apodize Parameter 1.  Depends on Function.
 -xQ2    Apodize Parameter 2.  Depends on Function.
 -xQ3    Apodize Parameter 3.  Depends on Function.
 -xC1    First Point Scale.    Default is 1.0.
 -xP0    Zero Order Phase.     Degrees.
 -xP1    First Order Phase.    Degrees.

Bin2Pipe Error extracting arguments.