diff --git a/previews/PR12/GIRFApplier/index.html b/previews/PR12/GIRFApplier/index.html index 941dead..6f22be4 100644 --- a/previews/PR12/GIRFApplier/index.html +++ b/previews/PR12/GIRFApplier/index.html @@ -2,4 +2,4 @@ GIRFApplier · MRIGradients Documentation
Edit on GitHub
MRIGradients.apply_girf — Method
apply_girf(g::GirfApplier, gradient_in, time_in, time_out, direction)
 
 Function for predicting the gradient by applying the GIRF
-This is done in one dimension only. Repeat this function for multiple dimensions

Arguments

  • g::GirfApplier - GirfApplier containing GIRF data
  • gradient_in - input gradient waveform corresponding to time_in vector
  • time_in - time vector corresponding to input gradient waveform
  • time_out - output time vector desired (decimation)
  • direction - direction of the GIRF to use (x,y,z etc...)

Outputs:

  • grad_OUT_resampled - Vector, gradient waveform with GIRF applied, in the time points of time_out.
source
+This is done in one dimension only. Repeat this function for multiple dimensions

Arguments

Outputs:

source diff --git a/previews/PR12/GIRFEssential/index.html b/previews/PR12/GIRFEssential/index.html index f417526..8a47083 100644 --- a/previews/PR12/GIRFEssential/index.html +++ b/previews/PR12/GIRFEssential/index.html @@ -1,2 +1,2 @@ -GIRFEssential · MRIGradients Documentation
Edit on GitHub
MRIGradients.GirfEssential — Method
GirfEssential(data::AbstractVecOrMat, vect::AbstractVector, isFreq::Bool, inChannels, outBasis)

Function to create a girf structure with the same interface as the constructor in the MATLAB implementation.

Arguments

  • data::AbstractVecOrMat - [nSamples x nOutBasis x nInChannels] Full GIRF data.
  • vect::AbstractVector - [nSamples] Frequency vector indicating the frequency range, in unit of Hz.
  • isFreq::Bool - True for GIRF in frequency domain, false for GIRF in temporal domain.
  • inChannels - Input gradient and shim channel names.
  • outBasis - Output field basis.

Outputs

  • g::GirfEssential - Constructed GirfEssential object.
source
MRIGradients.convertDomain! — Method
convertDomain!(g::GirfEssential)

Convert frequency-domain GIRF to time domain and vice versa. Also calculates dependent parameters.

Arguments

  • g::GirfEssential - The input GirfEssential object; conversion type is determined by g.isFreqDomainGirf

Outputs

  • g::GirfEssential - Modified GirfEssential object with converted/calculated fields.

This function was created from part of a code package for GIRF computation and application in MATLAB. The package is available under a BSD 3-clause license. Further info see: https://github.com/MRI-gradient/girf Original MATLAB Author: Johanna Vannesjo (johanna.vannesjo@gmail.com) Copyright (C) 2014 IBT, University of Zurich and ETH Zurich, 2016 FMRIB centre, University of Oxford

source
MRIGradients.displayGirf — Method
displayGirf(g::GirfEssential)

Function to print out the girf data in a human-readable format as a summary to make sure data is loaded properly

Arguments

  • g::GirfEssential - GirfEssential structure containing GIRF data
source
MRIGradients.loadGIRFMatlabTim — Function

GIRFfreq, GIRFdata, GIRF_length = loadGIRFTimMatlab() loads different measured GIRFs from Siemens Prisma, as computed in Matlab (Zhe "Tim" Wu's code)

Arguments

  • idGirf - identifier for selected GIRF 0 = example GIRF in this repo 1 = Nov 2020 pos blips 2 = June 2021 pos blips 3 = June 2021 pos/neg blips (4 averages) 4 = November 2021, pos/neg blips (4 averages)

Outputs

  • GIRF_freq -
  • GIRF_data - x 3 data
  • GIRF_length -
source
MRIGradients.loadGirf — Function
loadGirf(degree, id)

Function to load girf with specified id according to hardcoded file structure (internal use only)

Arguments

  • degree - specifies degree of the girf (1st or 0th order correction)
  • id - specifies girf measurement id since there have been multiple measurements
source
MRIGradients.readGIRFFile — Method
readGIRFFile(g::GirfEssential, pathX::String, pathY::String, pathZ::String, varName::String, doFilter::Bool)

Function to read GIRF files with specific variable name and return a corresponding GIRFEssential object.

Arguments

  • pathX::String - Full path for GIRF MAT-file on X axis
  • pathY::String - Full path for GIRF MAT-file on Y axis
  • pathZ::String - Full path for GIRF MAT-file on Z axis
  • varName::String - Variable name that needs to be read as GIRF data from the MAT-files.
  • doFilter::Bool - Whether we filter the GIRF data using Tukey filter

Outputs

  • g::GirfEssential - Constructed GirfEssential object with read-in data.
source
MRIGradients.setIdentifier! — Method
setIdentifier!(g::GirfEssential, identifier::String)

Function to name the GIRF with an identifier

Arguments

  • g::GirfEssential - GirfEssential object needs the identifier to be set.
  • identifier::String - Input identifier.

Outputs

  • g::GirfEssential - GirfEssential object with the identifier set as the input.
source
+GIRFEssential · MRIGradients Documentation
Edit on GitHub
MRIGradients.GirfEssential — Method
GirfEssential(data::AbstractVecOrMat, vect::AbstractVector, isFreq::Bool, inChannels, outBasis)

Function to create a girf structure with the same interface as the constructor in the MATLAB implementation.

Arguments

  • data::AbstractVecOrMat - [nSamples x nOutBasis x nInChannels] Full GIRF data.
  • vect::AbstractVector - [nSamples] Frequency vector indicating the frequency range, in unit of Hz.
  • isFreq::Bool - True for GIRF in frequency domain, false for GIRF in temporal domain.
  • inChannels - Input gradient and shim channel names.
  • outBasis - Output field basis.

Outputs

  • g::GirfEssential - Constructed GirfEssential object.
source
MRIGradients.convertDomain! — Method
convertDomain!(g::GirfEssential)

Convert frequency-domain GIRF to time domain and vice versa. Also calculates dependent parameters.

Arguments

  • g::GirfEssential - The input GirfEssential object; conversion type is determined by g.isFreqDomainGirf

Outputs

  • g::GirfEssential - Modified GirfEssential object with converted/calculated fields.

This function was created from part of a code package for GIRF computation and application in MATLAB. The package is available under a BSD 3-clause license. Further info see: https://github.com/MRI-gradient/girf Original MATLAB Author: Johanna Vannesjo (johanna.vannesjo@gmail.com) Copyright (C) 2014 IBT, University of Zurich and ETH Zurich, 2016 FMRIB centre, University of Oxford

source
MRIGradients.displayGirf — Method
displayGirf(g::GirfEssential)

Function to print out the girf data in a human-readable format as a summary to make sure data is loaded properly

Arguments

  • g::GirfEssential - GirfEssential structure containing GIRF data
source
MRIGradients.loadGIRFMatlabTim — Function

GIRFfreq, GIRFdata, GIRF_length = loadGIRFTimMatlab() loads different measured GIRFs from Siemens Prisma, as computed in Matlab (Zhe "Tim" Wu's code)

Arguments

  • idGirf - identifier for selected GIRF 0 = example GIRF in this repo 1 = Nov 2020 pos blips 2 = June 2021 pos blips 3 = June 2021 pos/neg blips (4 averages) 4 = November 2021, pos/neg blips (4 averages)

Outputs

  • GIRF_freq -
  • GIRF_data - x 3 data
  • GIRF_length -
source
MRIGradients.loadGirf — Function
loadGirf(degree, id)

Function to load girf with specified id according to hardcoded file structure (internal use only)

Arguments

  • degree - specifies degree of the girf (1st or 0th order correction)
  • id - specifies girf measurement id since there have been multiple measurements
source
MRIGradients.readGIRFFile — Method
readGIRFFile(g::GirfEssential, pathX::String, pathY::String, pathZ::String, varName::String, doFilter::Bool)

Function to read GIRF files with specific variable name and return a corresponding GIRFEssential object.

Arguments

  • pathX::String - Full path for GIRF MAT-file on X axis
  • pathY::String - Full path for GIRF MAT-file on Y axis
  • pathZ::String - Full path for GIRF MAT-file on Z axis
  • varName::String - Variable name that needs to be read as GIRF data from the MAT-files.
  • doFilter::Bool - Whether we filter the GIRF data using Tukey filter

Outputs

  • g::GirfEssential - Constructed GirfEssential object with read-in data.
source
MRIGradients.setIdentifier! — Method
setIdentifier!(g::GirfEssential, identifier::String)

Function to name the GIRF with an identifier

Arguments

  • g::GirfEssential - GirfEssential object needs the identifier to be set.
  • identifier::String - Input identifier.

Outputs

  • g::GirfEssential - GirfEssential object with the identifier set as the input.
source
diff --git a/previews/PR12/Utilities/index.html b/previews/PR12/Utilities/index.html index dec516a..c30ca75 100644 --- a/previews/PR12/Utilities/index.html +++ b/previews/PR12/Utilities/index.html @@ -1,2 +1,2 @@ -Utilities · MRIGradients Documentation
Edit on GitHub
MRIGradients.gradients_to_nodes — Method
gradients_to_nodes(gradients::Matrix; gamma=42577478, dwellTime=2e-6, FOV=[220,220,1],reconSize=[200,200,1])

Function to calculate the k-space nodes from an applied gradient train

Arguments

  • gradients::Matrix - input gradients played out, acquired with constant dwell time. Size: (2 x N) where N is the number of gradient samples
  • gamma - gyromagnetic ratio [Hz]
  • dwellTime - the dwell time of the trajectory [s]
  • FOV - spatial field of view in [mm] [1 x 3]
  • reconSize - reconstruction matrix size [1 x 3]

Outputs

  • nodes::Matrix - k-space nodes corresponding to applied gradient train. Size: (2 x N) where N is the number of gradient samples
source
MRIGradients.nodes_to_gradients — Method
nodes_to_gradients(nodes::Matrix; gamma=42577478, dwellTime=2e-6, FOV=[220,220,1],reconSize=[200,200,1])

Function to calculate the gradient train used to acquire k-space data

Arguments

  • nodes::Matrix - input k-space nodes traversed in order, acquired with constant dwell time. Size: (2 x N) where N is the number of nodes
  • gamma - gyromagnetic ratio [Hz]
  • dwellTime - the dwell time of the trajectory [s]
  • FOV - spatial field of view in [mm] [1 x 3]
  • reconSize - reconstruction matrix size [1 x 3]

Outputs

  • gradients::Matrix - gradients corresponding to k-space samples. Size: (2 x N) where N is the number of k-space samples
source
MRIGradients.time2freq — Method
time2freq(t)

converts time domain vector into a vector of frequencies according to the Nyquist criterion Port of Johanna Vannesjo's time2freq method: https://github.com/MRI-gradient/GIRF/blob/main/utils/time2freq.m

Arguments

  • t - input time vector

Outputs

  • f - Calculated requency axis, vector with [length(t)]
  • df - Frequency resolution
  • f_max - Full frequency range. The frequency axis range is [-fmax/2, fmax/2].
source
+Utilities · MRIGradients Documentation
Edit on GitHub
MRIGradients.gradients_to_nodes — Method
gradients_to_nodes(gradients::Matrix; gamma=42577478, dwellTime=2e-6, FOV=[220,220,1],reconSize=[200,200,1])

Function to calculate the k-space nodes from an applied gradient train

Arguments

  • gradients::Matrix - input gradients played out, acquired with constant dwell time. Size: (2 x N) where N is the number of gradient samples
  • gamma - gyromagnetic ratio [Hz]
  • dwellTime - the dwell time of the trajectory [s]
  • FOV - spatial field of view in [mm] [1 x 3]
  • reconSize - reconstruction matrix size [1 x 3]

Outputs

  • nodes::Matrix - k-space nodes corresponding to applied gradient train. Size: (2 x N) where N is the number of gradient samples
source
MRIGradients.nodes_to_gradients — Method
nodes_to_gradients(nodes::Matrix; gamma=42577478, dwellTime=2e-6, FOV=[220,220,1],reconSize=[200,200,1])

Function to calculate the gradient train used to acquire k-space data

Arguments

  • nodes::Matrix - input k-space nodes traversed in order, acquired with constant dwell time. Size: (2 x N) where N is the number of nodes
  • gamma - gyromagnetic ratio [Hz]
  • dwellTime - the dwell time of the trajectory [s]
  • FOV - spatial field of view in [mm] [1 x 3]
  • reconSize - reconstruction matrix size [1 x 3]

Outputs

  • gradients::Matrix - gradients corresponding to k-space samples. Size: (2 x N) where N is the number of k-space samples
source
MRIGradients.time2freq — Method
time2freq(t)

converts time domain vector into a vector of frequencies according to the Nyquist criterion Port of Johanna Vannesjo's time2freq method: https://github.com/MRI-gradient/GIRF/blob/main/utils/time2freq.m

Arguments

  • t - input time vector

Outputs

  • f - Calculated requency axis, vector with [length(t)]
  • df - Frequency resolution
  • f_max - Full frequency range. The frequency axis range is [-fmax/2, fmax/2].
source
diff --git a/previews/PR12/index.html b/previews/PR12/index.html index 51e078b..9707d2d 100644 --- a/previews/PR12/index.html +++ b/previews/PR12/index.html @@ -1,2 +1,2 @@ -Home · MRIGradients Documentation
Edit on GitHub
+Home · MRIGradients Documentation
Edit on GitHub
diff --git a/previews/PR12/search/index.html b/previews/PR12/search/index.html index 56bc2a2..40a7da6 100644 --- a/previews/PR12/search/index.html +++ b/previews/PR12/search/index.html @@ -1,2 +1,2 @@ -Search · MRIGradients Documentation

Loading search...

    +Search · MRIGradients Documentation

    Loading search...