TEND-ESTIM(1)

πŸ“¦ version 1.11.0, in fedora 43, fedora 44

πŸ’– TEND-ESTIM πŸ’–

okay so real quick, bestie β€” this is the manual page for tend-estim, a User Command, and it's genuinely one of the most useful little tools in the tend family. no cap. let's get into it πŸŽ€


✨ NAME ✨

tend-estim β€” estimate tensors from a set of DW images 🧚


🌸 SYNOPSIS 🌸

tend estim [-old] [-sigma <sigma>] [-v <verbose>] [-est
<estimate method>] [-wlsi <WLS iters>] [-fixneg] [-ee <filename>] [-eb
<filename>] [-t <thresh>] [-soft <soft>] [-scale <scale>] [-mv
<min val>] -B <B-list> [-b <b>] -knownB0 <bool> [-i <dwi0 dwi1 ...>] [-o
<nout>]

like. look at her. so many flags. she's giving options πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So the whole vibe here is: you hand over a set of DW images and tend-estim estimates tensors from them. That's the job. That's the assignment and she ate. ✨

Now the tensor coefficient weightings associated with each of the DWIs β€” that's the B-matrix β€” and it gets given to you either as a separate array (peep tend-bmat(1) for the details, iykyk) OR by the key-value pairs sitting right there in the DWI nrrd header. either one, your choice, both are valid πŸ’–

And listen β€” a β€œconfidence” value gets computed alongside the tensor. How? Based on a soft thresholding of the sum of all the DWIs, according to the threshold and softness parameters. it's literally in the math. periodt. πŸ”₯


πŸ’… OPTIONS πŸ’…

  • -old β€” instead of the new tenEstimateContext code, use the old tenEstimateLinear code. vintage vibes, no judgment 🫢
  • -sigma <sigma> β€” Rician noise parameter (float)
  • -v <verbose> β€” verbosity level (int) default: β€œ0”
  • -est <estimate method> β€” estimation method to use. β€œlls”: linear-least squares; default: β€œlls”
  • -wlsi <WLS iters> β€” when using weighted-least-squares (-est wls), how many iterations to do after the initial weighted fit. (unsigned int) default: β€œ1”
  • -fixneg β€” after estimating the tensor, ensure that there are no negative eigenvalues by adding (to all eigenvalues) the amount by which the smallest is negative (corresponding to increasing the non-DWI image value). no negative eigenvalues allowed on this account πŸ™…β€β™€οΈ
  • -ee <filename> β€” Giving a filename here allows you to save out the tensor estimation error: a value which measures how much error there is between the tensor model and the given diffusion weighted measurements for each sample. By default, no such error calculation is saved. (string)
  • -eb <filename> β€” In those cases where there is no B=0 reference image given (-knownB0 false), giving a filename here allows you to save out the B=0 image which is estimated from the data. By default, this image value is estimated but not saved. (string)
  • -t <thresh> β€” value at which to threshold the mean DWI value per pixel in order to generate the β€œconfidence” mask. By default, the threshold value is calculated automatically, based on histogram analysis. (double)
  • -soft <soft> β€” how fuzzy the confidence boundary should be. By default, confidence boundary is perfectly sharp (float) default: β€œ0”
  • -scale <scale> β€” After estimating the tensor, scale all of its elements (but not the confidence value) by this amount. Can help with downstream numerical precision if values are very large or small. (float) default: β€œ1”
  • -mv <min val> β€” minimum plausible value (especially important for linear least squares estimation) (double) default: β€œ1.0”
  • -B <B-list> β€” 6-by-N list of B-matrices characterizing the diffusion weighting for each image. tend-bmat(1) is one source for such a matrix; see its usage info for specifics on how the coefficients of the B-matrix are ordered. An unadorned plain text file is a great way to specify the B-matrix.

OR

Can say just -B kvp to try to learn B matrices from key/value pair information in input images.

(string)

  • -b <b> β€” β€œb” diffusion-weighting factor (units of sec/mm^2) (double)
  • -knownB0 <bool> β€” Indicates if the B=0 non-diffusion-weighted reference image is known, or if it has to be estimated along with the tensor elements
    • if β€œtrue”: in the given list of diffusion gradients or B-matrices, there are one or more with zero norm, which are simply averaged to find the B=0 reference image value
    • if β€œfalse”: there may or may not be diffusion-weighted images among the input; the B=0 image value is going to be estimated along with the diffusion model

(bool)

  • -i <dwi0 dwi1 ...> β€” all the diffusion-weighted images (DWIs), as separate 3D nrrds, OR: One 4D nrrd of all DWIs stacked along axis 0 (1 or more nrrds); default: β€œ-”
  • -o <nout> β€” output tensor volume (string) default: β€œ-”

πŸ‘‘ SEE ALSO πŸ‘‘

tend(1) tend-bmat(1), tend-msim(1), tend-sim(1)

like, go read your sisters too, they're all iconic πŸ’œ


πŸŽ€ that's the whole page bestie, go estimate some tensors and slay πŸŽ€

April 2021 β€” that's the date on this one, and it came from the TEND-ESTIM(1) source, i.e. the User Commands manual. mwah, go forth and be linear-least-squares about it βœ¨πŸ’–πŸ¦‹

πŸ“¦ where this page comes from