| abfit_opts | Return a list of options for an ABfit analysis. |
| acquire | Simulate pulse sequence acquisition. |
| align | Align spectra to a reference frequency using a convolution... |
| apodise_xy | Apodise MRSI data in the x-y direction with a k-space hamming... |
| append_basis | Combine a pair of basis set objects. |
| append_coils | Append MRS data across the coil dimension, assumes they... |
| append_dyns | Append MRS data across the dynamic dimension, assumes they... |
| apply_axes | Apply a function over specified array axes. |
| apply_mrs | Apply a function across given dimensions of a MRS data... |
| apply_pvc | Convert default LCM/TARQUIN concentration scaling to molal... |
| Arg.mrs_data | Apply Arg operator to an MRS dataset. |
| array2mrs_data | Convert a 7 dimensional array in into a mrs_data object. The... |
| auto_phase | Perform zeroth-order phase correction based on the... |
| back_extrap | Back extrapolate time-domain points using the Burg... |
| basis2mrs_data | Convert a basis object to an mrs_data object - where basis... |
| bbase | Generate a spline basis, slightly adapted from : "Splines,... |
| bc_als | Baseline correction using the ALS method. |
| bc_constant | Remove a constant baseline offset based on a reference... |
| beta2lw | Covert a beta value in the time-domain to an equivalent... |
| calc_coil_noise_cor | Calculate the noise correlation between coil elements. |
| calc_coil_noise_sd | Calculate the noise standard deviation for each coil element. |
| calc_ed_from_lambda | Calculate the effective dimensions of a spline smoother from... |
| calc_peak_info_vec | Calculate the FWHM of a peak from a vector of intensity... |
| calc_sd_poly | Perform a polynomial fit, subtract and return the standard... |
| calc_spec_diff | Calculate the sum of squares differences between two mrs_data... |
| calc_spec_snr | Calculate the spectral SNR. |
| check_lcm | Check LCModel can be run |
| check_tqn | Check the TARQUIN binary can be run |
| collapse_to_dyns | Collapse MRS data by concatenating spectra along the dynamic... |
| comb_coils | Combine coil data based on the first data point of a... |
| comb_coils_fp_pc | Combine coil data following phase correction based on the... |
| comb_csv_results | Combine the results from multiple csv format files into a... |
| comb_fits | Combine a list of fit_result objects into a single fit object... |
| comb_metab_ref | Combine a reference and metabolite mrs_data object. |
| Conj.mrs_data | Apply Conj operator to an MRS dataset. |
| conv_mrs | Convolve two MRS data objects. |
| crop_spec | Crop 'mrs_data' object based on a frequency range. |
| crop_td_pts | Crop 'mrs_data' object data points in the time-domain. |
| crop_xy | Crop an MRSI dataset in the x-y direction |
| crossprod_3d | Compute the vector cross product between vectors x and y.... |
| decimate_mrs | Decimate an MRS signal by a factor. |
| def_acq_paras | Return (and optionally modify using the input arguments) a... |
| def_fs | Return the default sampling frequency in Hz. |
| def_ft | Return the default transmitter frequency in Hz. |
| def_N | Return the default number of data points in the spectral... |
| def_nuc | Return the default nucleus. |
| def_ref | Return the default reference value for ppm scale. |
| diff_mrs | Apply the diff operator to an MRS dataset in the FID/spectral... |
| downsample_mrs | Downsample an MRS signal by a factor of 2 using an FFT... |
| ecc | Eddy current correction. |
| est_noise_sd | Estimate the standard deviation of the noise from a segment... |
| fd2td | Transform frequency-domain data to the time-domain. |
| fd_conv_filt | Frequency-domain convolution based filter. |
| fit_amps | Extract the fit amplitudes from an object of class... |
| fit_diags | Calculate diagnostic information for object of class... |
| fit_mrs | Perform a fit based analysis of MRS data. |
| fit_res2csv | Write fit results table to a csv file. |
| fp_phase | Return the phase of the first data point in the time-domain. |
| fp_phase_correct | Perform a zeroth order phase correction based on the phase of... |
| fs | Return the sampling frequency in Hz of an MRS dataset. |
| ft_shift | Perform a fft and ffshift on a vector. |
| ft_shift_mat | Perform a fft and fftshift on a matrix with each column... |
| gen_F | Generate the F product operator. |
| gen_F_xy | Generate the Fxy product operator with a specified phase. |
| get_1h_brain_basis_paras | Return a list of 'mol_parameter' objects suitable for 1H... |
| get_1h_brain_basis_paras_v1 | Return a list of 'mol_parameter' objects suitable for 1H... |
| get_1h_brain_basis_paras_v2 | Return a list of 'mol_parameter' objects suitable for 1H... |
| get_1h_brain_basis_paras_v3 | Return a list of 'mol_parameter' objects suitable for 1H... |
| get_2d_psf | Get the point spread function (PSF) for a 2D phase encoded... |
| get_acq_paras | Return acquisition parameters from a MRS data object. |
| get_dyns | Extract a subset of dynamic scans. |
| get_even_dyns | Return even numbered dynamic scans starting from 1... |
| get_fh_dyns | Return the first half of a dynamic series. |
| get_fit_map | Get a data array from a fit result. |
| get_fit_table | Combine all fitting data points into a single dataframe. |
| get_fp | Return the first time-domain data point. |
| get_guassian_pulse | Generate a gaussian pulse shape. |
| get_metab | Extract the metabolite component from an mrs_data object. |
| get_mol_names | Return a character array of names that may be used with the... |
| get_mol_paras | Get a 'mol_parameters' object for a named molecule. |
| get_mrsi2d_seg | Calculate the partial volume estimates for each voxel in a 2D... |
| get_mrsi_voi | Generate a MRSI VOI from an 'mrs_data' object. |
| get_mrsi_voxel | Generate a MRSI voxel from an 'mrs_data' object. |
| get_mrsi_voxel_xy_psf | Generate a MRSI voxel PSF from an 'mrs_data' object. |
| get_odd_dyns | Return odd numbered dynamic scans starting from 1 (1,3,5...). |
| get_ref | Extract the reference component from an mrs_data object. |
| get_seg_ind | Get the indices of data points lying between two values (end... |
| get_sh_dyns | Return the second half of a dynamic series. |
| get_slice | Return a single slice from a larger MRSI dataset. |
| get_subset | Extract a subset of MRS data. |
| get_svs_voi | Generate a SVS acquisition volume from an 'mrs_data' object. |
| get_td_amp | Return an array of amplitudes derived from fitting the... |
| get_uncoupled_mol | Generate a 'mol_parameters' object for a simple spin system... |
| get_voi_cog | Calculate the centre of gravity for an image containing 0 and... |
| get_voi_seg | Return the white matter, gray matter and CSF composition of a... |
| get_voi_seg_psf | Return the white matter, gray matter and CSF composition of a... |
| get_voxel | Return a single voxel from a larger mrs dataset. |
| grid_shift_xy | Grid shift MRSI data in the x/y dimension. |
| hsvd_filt | HSVD based signal filter. |
| hz | Return the frequency scale of an MRS dataset in Hz. |
| ift_shift | Perform an iffshift and ifft on a vector. |
| ift_shift_mat | Perform an ifft and ifftshift on a matrix with each column... |
| image.mrs_data | Image plot method for objects of class mrs_data. |
| Im.mrs_data | Apply Im operator to an MRS dataset. |
| interleave_dyns | Interleave the first and second half of a dynamic series. |
| int_spec | Integrate a spectral region. |
| inv_even_dyns | Invert even numbered dynamic scans starting from 1... |
| inv_odd_dyns | Invert odd numbered dynamic scans starting from 1 (1,3,5...). |
| is_fd | Check if the chemical shift dimension of an MRS data object... |
| l2_reg | Perform l2 regularisation artefact suppression using the... |
| lb | Apply line-broadening (apodisation) to MRS data or basis... |
| lw2alpha | Covert a linewidth in Hz to an equivalent alpha value in the... |
| lw2beta | Covert a linewidth in Hz to an equivalent beta value in the... |
| mask_xy | Mask an MRSI dataset in the x-y direction |
| mask_xy_mat | Mask a 2D MRSI dataset in the x-y dimension. |
| mat2mrs_data | Convert a matrix (with spectral points in the row dimension... |
| max_mrs | Apply the max operator to an MRS dataset. |
| max_mrs_interp | Apply the max operator to an interpolated MRS dataset. |
| mean_dyn_blocks | Calculate the mean of adjacent dynamic scans. |
| mean_dyn_pairs | Calculate the pairwise means across a dynamic data set. |
| mean_dyns | Calculate the mean dynamic data. |
| mean.mrs_data | Calculate the mean spectrum from an mrs_data object. |
| median_dyns | Calculate the median dynamic data. |
| Mod.mrs_data | Apply Mod operator to an MRS dataset. |
| mrs_data2basis | Convert an mrs_data object to basis object - where basis... |
| mrs_data2mat | Convert mrs_data object to a matrix, with spectral points in... |
| mrs_data2vec | Convert mrs_data object to a vector. |
| mrsi2d_img2kspace | Transform 2D MRSI data to k-space in the x-y direction. |
| mrsi2d_kspace2img | Transform 2D MRSI data from k-space to image space in the x-y... |
| mvfftshift | Perform a fftshift on a matrix, with each column replaced by... |
| mvifftshift | Perform an ifftshift on a matrix, with each column replaced... |
| n2coord | Print fit coordinates from a single index. |
| Ncoils | Return the total number of coil elements in an MRS dataset. |
| Ndyns | Return the total number of dynamic scans in an MRS dataset. |
| nifti_flip_lr | Flip the x data dimension order of a nifti image. This... |
| norm_mrs | Normalise mrs_data to a spectral region. |
| Npts | Return the number of data points in an MRS dataset. |
| Nspec | Return the total number of spectra in an MRS dataset. |
| Nx | Return the total number of x locations in an MRS dataset. |
| Ny | Return the total number of y locations in an MRS dataset. |
| Nz | Return the total number of z locations in an MRS dataset. |
| ortho3 | Display an orthographic projection plot of a nifti object. |
| ortho3_int | Display an interactive orthographic projection plot of a... |
| peak_info | Search for the highest peak in a spectral region and return... |
| phase | Apply phasing parameters to MRS data. |
| plot_bc | Convenience function to plot a baseline estimate with the... |
| plot.fit_result | Plot the fitting results of an object of class 'fit_result'. |
| plot.mrs_data | Plotting method for objects of class mrs_data. |
| plot_slice_fit | Plot a 2D slice from an MRSI fit result object. |
| plot_slice_fit_inter | Plot a 2D slice from an MRSI fit result object. |
| plot_slice_map | Plot a slice from a 7 dimensional array. |
| plot_slice_map_inter | Plot an interactive slice map from a data array where voxels... |
| plot_voi_overlay | Plot a volume as an image overlay. |
| plot_voi_overlay_seg | Plot a volume as an overlay on a segmented brain volume. |
| ppm | Return the ppm scale of an MRS dataset or fit result. |
| print.fit_result | Print a summary of an object of class 'fit_result'. |
| print.mrs_data | Print a summary of mrs_data parameters. |
| qn_states | Get the quantum coherence matrix for a spin system. |
| rats | Robust Alignment to a Target Spectrum (RATS). |
| read_basis | Read a basis file in LCModel .basis format. |
| read_ima_coil_dir | Read a directory containing Siemens MRS IMA files and combine... |
| read_ima_dyn_dir | Read a directory containing Siemens MRS IMA files and combine... |
| read_lcm_coord | Read an LCModel formatted coord file containing fit... |
| read_mrs | Read MRS data from a file. |
| read_mrs_dpt | Read MRS data stored in dangerplot (dpt) v3 format. |
| read_mrs_tqn | Read MRS data using the TARQUIN software package. |
| read_siemens_txt_hdr | Read the text format header found in Siemens IMA and TWIW... |
| read_tqn_fit | Reader for csv fit results generated by TARQUIN. |
| read_tqn_result | Reader for csv results generated by TARQUIN. |
| reexports | Objects exported from other packages |
| Re.mrs_data | Apply Re operator to an MRS dataset. |
| rep_array_dim | Repeat an array over a given dimension. |
| rep_dyn | Replicate a scan in the dynamic dimension. |
| rep_mrs | Replicate a scan over a given dimension. |
| resample_img | Resample an image to match a target image space. |
| resample_voi | Resample a VOI to match a target image space using... |
| reslice_to_mrs | Reslice a nifti object to match the orientation of mrs data. |
| re_weighting | Apply a weighting to the FID to enhance spectral resolution. |
| rm_dyns | Remove a subset of dynamic scans. |
| scale_amp_molal_pvc | Apply partial volume correction to a fitting result object. |
| scale_amp_molar | Apply water reference scaling to a fitting results object to... |
| scale_amp_ratio | Scale fitted amplitudes to a ratio of signal amplitude. |
| scale_amp_water_ratio | Scale metabolite amplitudes as a ratio to the unsuppressed... |
| sd | Standard Deviation |
| sd.mrs_data | Calculate the standard deviation spectrum from an mrs_data... |
| seconds | Return a time scale vector to match the FID of an MRS data... |
| seq_cpmg_ideal | CPMG style sequence with ideal pulses. |
| seq_mega_press_ideal | MEGA-PRESS sequence with ideal localisation pulses and... |
| seq_press_ideal | PRESS sequence with ideal pulses. |
| seq_pulse_acquire | Simple pulse and acquire sequence with ideal pulses. |
| seq_pulse_acquire_31p | Simple pulse and acquire sequence with ideal pulses. |
| seq_slaser_ideal | sLASER sequence with ideal pulses. |
| seq_spin_echo_ideal | Spin echo sequence with ideal pulses. |
| seq_spin_echo_ideal_31p | Spin echo sequence with ideal pulses. |
| seq_steam_ideal | STEAM sequence with ideal pulses. |
| set_def_acq_paras | Set the default acquisition parameters. |
| set_lcm_cmd | Set the command to run the LCModel command-line program. |
| set_lw | Apply line-broadening to an mrs_data object to achieve a... |
| set_ref | Set the ppm reference value (eg ppm value at 0Hz). |
| set_td_pts | Set the number of time-domain data points, truncating or... |
| set_tqn_cmd | Set the command to run the TARQUIN command-line program. |
| shift | Apply a frequency shift to MRS data. |
| sim_basis | Simulate a basis set object. |
| sim_basis_1h_brain | Simulate a basis-set suitable for 1H brain MRS analysis... |
| sim_basis_1h_brain_press | Simulate a basis-set suitable for 1H brain MRS analysis... |
| sim_basis_tqn | Simulate a basis file using TARQUIN. |
| sim_brain_1h | Simulate MRS data with a similar appearance to normal brain... |
| sim_mol | Simulate a 'mol_parameter' object. |
| sim_noise | Simulate a time-domain mrs_data object containing simulated... |
| sim_resonances | Simulate a MRS data object containing a set of simulated... |
| spant_mpress_drift | Example MEGA-PRESS data with significant B0 drift. |
| spant-package | spant: spectroscopy analysis tools. |
| spin_sys | Create a spin system object for pulse sequence simulation. |
| spm_pve2categorical | Convert SPM style segmentation files to a single categorical... |
| stackplot | Produce a plot with multiple traces. |
| stackplot.fit_result | Plot the fitting results of an object of class 'fit_result'... |
| stackplot.mrs_data | Stackplot plotting method for objects of class mrs_data. |
| sum_coils | Calculate the sum across receiver coil elements. |
| sum_dyns | Calculate the sum of data dynamics. |
| td2fd | Transform time-domain data to the frequency-domain. |
| td_conv_filt | Time-domain convolution based filter. |
| tdsr | Time-domain spectral registration. |
| varpro_3_para_opts | Return a list of options for VARPRO based fitting with 3 free... |
| varpro_opts | Return a list of options for VARPRO based fitting. |
| vec2mrs_data | Convert a vector into a mrs_data object. |
| write_basis | Write a basis object to an LCModel .basis formatted file. |
| write_basis_tqn | Generate a basis file using TARQUIN. |
| write_mrs | Write MRS data object to file. |
| write_mrs_nifti | Write MRS data object to file in NIFTI format. |
| zero_nzoc | Zero all non-zero-order coherences. |
| zf | Zero-fill MRS data in the time domain. |
| zf_xy | Zero-fill MRSI data in the k-space x-y direction. |
