ODINRECO(1)

πŸ’– ODINRECO(1) πŸ’–

okay bestie, pull up a chair, because this is odinreco(1) from the User Commands section and she is a lot β€” but in the best way. ✨


🌸 NAME 🌸

odinreco β€” automatic reconstruction for ODIN sequences. that's it. that's the whole vibe. she reconstructs. automatically. 🫢


πŸŽ€ SYNOPSIS πŸŽ€

odinreco [ options ] -r <input-file-to-be-read>

πŸ¦‹ DESCRIPTION πŸ¦‹

so like. odinreco: automatic reconstruction for ODIN sequences. slay.

odinreco gives you a generic reconstruction for imaging sequences β€” think spin-warp, EPI, RARE, the whole girl gang β€” and she is not picky about it either. 🌈 how does she know what to do?? she reads the file recoInfo, which lives on disk right next to your raw data. that file is holding all the lore about the acquired signal, including the k-space position of each acquisition window (ADC). iykyk. πŸ‘‘

as output, odinreco generates a bunch of files in different image formats β€” which ones you get depends on the option -f and on which third-party libraries are available to ODIN. and every single one of those filenames starts with the output prefix you gave her. periodt.

this program is part of odin 2.0.5, built with the configuration using_gcc debug gui(:5) standalone dl posix_threads libz gsl nifti vtk dicom png ismrmrd gdb. iconic honestly. πŸ’…


✨ OPTIONS ✨

  • -bcw β€” correlation weighting of all blades against the mean of all blades (in image space)
  • -bf β€” filter function for blade phase correction (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=NoFilter)
  • -bfw β€” width of the filter function used for blade phase correction. [0.0 (0%) ... 1.0 (100%) of blade width; -1.0 (100%) ... 0.0 (0%) of center width] (default=1.0)
  • -bkf β€” blade-keyhole filter function (and its arguments) (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=CosSq)
  • -bkt β€” blade-keyhole transition width (fraction of oversampled k-space center) (default=0.20)
  • -bwf β€” window/filter function for kspace weighting of each blade (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=Triangle)
  • -bww β€” window/filter width for kspace weighting of each blade (default=1.0)
  • -cp β€” use direct Fourier transform with conjugate-phase correction instead of gridding
  • -dce β€” TE used for field drift calculations, if non-zero [ms] (default=0.0)
  • -dcs β€” index selection string in recipe used for drift correction (space separated list of 'dim=selection', e.g. te=2)
  • -dcw β€” store field drift to file with this prefix
  • -dd β€” disable field-drift correction
  • -df β€” output format (file extension) of dump files (default=nii)
  • -dg β€” disable GRAPPA interpolation
  • -dh β€” disable homodyne reconstruction
  • -dm β€” disable fieldmap-based multi-frequency reconstruction
  • -dp β€” prefix of dump files (default=./dump)
  • -ds β€” disable slice-time correction
  • -dt β€” disable template-based phase correction
  • -el β€” level relative to mean value of first echo for setting mask of exponential decay fit (default=0.50)
  • -f β€” space separated list of output formats (file extensions). the possible formats are 3db analyze asc coi dat dcm double float gz h5 hdr idx ima interfile jdx mag mhd nii ph png pos pro reg s16bit s32bit s8bit smp u16bit u32bit u8bit vtk xml xpro (default=nii)
  • -ff β€” k-space filter function (and its arguments) (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=NoFilter)
  • -fm β€” load fieldmap data from this file
  • -fp β€” filter plateau width (0=no plateau, 1=full plateau) (default=0.0)
  • -gd β€” fraction of k-space points to discard in auto-calibration lines because of high residuals (default=0.0)
  • -gp β€” number of neighbouring measured k-space lines used for GRAPPA interpolation (default=2)
  • -gr β€” number of neighbours in read direction used for GRAPPA interpolation (default=5)
  • -gs β€” scale factor for the grid used for gridding (default=1.0)
  • -gt β€” store GRAPPA template images
  • -ip β€” command line args for extra processing of final images (default=none)
  • -j β€” number of concurrent jobs (threads) in reco (default=16)
  • -kg1d β€” kernel function for 1d k-space gridding (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=Gauss(0.36169))
  • -kg2d β€” kernel function for 2d k-space gridding (options=Gauss NoFilter Triangle Hann Hamming CosSq Blackman BlackmanNuttall Exp , default=Gauss(0.36169))
  • -kh β€” keyhole reconstruction, e.g. for PROPELLER
  • -ks β€” store k-space data
  • -kw1d β€” kernel width for 1d k-space gridding [Pixel] (default=4.24264)
  • -kw2d β€” kernel width for 2d k-space gridding [Pixel] (default=3.0)
  • -mf β€” maximum number of frequencies for multi-frequency reconstruction (default=256)
  • -mn β€” in sliding-window maximum-intensity projection, use this number of neighbors in each direction (default=4)
  • -mr β€” maximum recursion of reconstruction when waiting for blackboard data, zero means no recursion (default=100)
  • -o β€” prefix of output files (default=./image)
  • -pc β€” combine phase of channels using a phase correction
  • -pe β€” exponent for magnitude weighting when calculating combined phase of all channels (default=0.0)
  • -pf β€” file name of FIFO (named pipe) to obtain the raw data from
  • -pop β€” recipe for post processing of 3D volume after channel combining (default=null)
  • -prp β€” recipe for post processing of 3D volume before channel combining (default=null)
  • -pt β€” combine and store phase timecourse from all channels
  • -pz β€” pad missing raw data (of interrupted measurement) with zeroes
  • -qs β€” quality control: check for spikes in data
  • -rd β€” dump signal data and its protocol to files with this prefix, do not reconstruct images
  • -rf β€” read reco recipe (pipeline layout) from this file
  • -rp β€” reco recipe (pipeline layout)
  • -s β€” select certain dimensions ranges (space separated list of 'dim=selection', e.g. slice=3)
  • -sc β€” store images from channels separately instead of combining them
  • -sp β€” store phase in addition to magnitude
  • -sw β€” sliding window reconstruction, e.g. for Spiral/PROPELLER
  • -t1f β€” use this type of T1 fit, can be one of 'simple', 'magnitude' (default=simple)
  • -t1l β€” level relative to mean value of first echo for setting mask of T1 fit (default=0.50)
  • -t1m β€” upper limit for T1 fit [ms] (default=3000.0)
  • -to β€” timeout for reco in seconds, 0=infinite (default=0)
  • -type β€” image representation type (options=automatic float double s32bit u32bit s16bit u16bit s8bit u8bit , default=automatic)
  • -wdialect β€” write data using given dialect of the format (default is no dialect)
  • -wp β€” store the protocol separately to this file.
  • -zp β€” minimum size of final image in phase direction obtained zero filling (default=0)
  • -zr β€” minimum size of final image in read direction obtained zero filling (default=0)
  • -zs β€” minimum size of final image in slice direction obtained zero filling (default=0)
  • -v <loglevel> or <component:loglevel> β€” for debugging/tracing all components or a single component, respectively. possible values for loglevel are: 0(noLog), 1(errorLog), 2(warningLog), 3(infoLog), 4(significantDebug), 5(normalDebug), 6(verboseDebug).
  • -h, --help, -help, --version β€” print help text or version information
also bestie don't forget the -r <input-file-to-be-read> from the synopsis, she's the one actually holding the raw data you want reconstructed. no -r, no images. πŸ’€

and that's the whole page!! πŸŽ€ this is odinreco 2.0.5, dated October 2021 β€” go forth and reconstruct, you've got this, no cap. πŸ’œπŸ¦‹βœ¨