{"id":27241232,"url":"https://github.com/stevenwhitaker/stfr.jl","last_synced_at":"2026-02-08T13:36:18.085Z","repository":{"id":51138161,"uuid":"212605431","full_name":"StevenWhitaker/STFR.jl","owner":"StevenWhitaker","description":"STFR: Small-Tip Fast Recovery MRI","archived":false,"fork":false,"pushed_at":"2023-03-16T17:54:21.000Z","size":71,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-31T16:47:23.554Z","etag":null,"topics":["magnetic-resonance-imaging","small-tip-fast-recovery"],"latest_commit_sha":null,"homepage":null,"language":"Julia","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StevenWhitaker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-10-03T14:49:30.000Z","updated_at":"2023-08-15T03:27:44.000Z","dependencies_parsed_at":"2025-04-10T19:57:02.839Z","dependency_job_id":"4cb35c3f-87d3-4587-8df0-8bb78fbafce5","html_url":"https://github.com/StevenWhitaker/STFR.jl","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/StevenWhitaker/STFR.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenWhitaker%2FSTFR.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenWhitaker%2FSTFR.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenWhitaker%2FSTFR.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenWhitaker%2FSTFR.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StevenWhitaker","download_url":"https://codeload.github.com/StevenWhitaker/STFR.jl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenWhitaker%2FSTFR.jl/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269067455,"owners_count":24354280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magnetic-resonance-imaging","small-tip-fast-recovery"],"created_at":"2025-04-10T19:56:56.029Z","updated_at":"2026-02-08T13:36:12.954Z","avatar_url":"https://github.com/StevenWhitaker.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# STFR.jl\n\n[![action status](https://github.com/StevenWhitaker/STFR.jl/actions/workflows/runtests.yml/badge.svg)](https://github.com/StevenWhitaker/STFR.jl/actions)\n[![codecov](https://codecov.io/gh/StevenWhitaker/STFR.jl/branch/main/graph/badge.svg?token=7OQodIVYIV)](https://codecov.io/gh/StevenWhitaker/STFR.jl)\n\nThis package provides functionality for simulating the signal acquired from a\nsmall-tip fast recovery (STFR) MRI scan. The function `stfr` implements the\nsignal equations found in the following papers:\n\n- [J.-F. Nielsen, D. Yoon, and D. C. Noll. Small-tip fast recovery imaging using non-slice-selective tailored tip-up pulses and radiofrequency-spoiling. Mag. Res. Med., 69(3):657-66, March 2013.](https://onlinelibrary.wiley.com/doi/full/10.1002/mrm.24289)\n    - For RF spoiled STFR.\n- [H. Sun, J. A. Fessler, D. C. Noll, and J.-F. Nielsen. Strategies for improved 3D small-tip fast recovery imaging. Mag. Res. Med., 72(2):389-98, August 2014.](https://onlinelibrary.wiley.com/doi/abs/10.1002/mrm.24947)\n    - For RF unspoiled STFR.\n    - Note that the paper has an error; the corrected equations were used in\n      this package.\n\nThe function `stfr` can be used for either a single-compartment model or a\ntwo-compartment model without exchange.\n\nThis package also provides a Bloch simulation implementation of STFR\n(`STFRBlochSim`) that allows for modeling different RF pulses and spoiling\nschemes. (See [BlochSim.jl](https://github.com/StevenWhitaker/BlochSim.jl) for\ndifferent subtypes of `AbstractRF` and `AbstractSpoiling`.) In addition,\n`STFRBlochSim` can be used for spins with an arbitrary number of compartments\nwith exchange (see `Spin` and `SpinMC` in\n[BlochSim.jl](https://github.com/StevenWhitaker/BlochSim.jl)).\n\n## Getting Started\n\nFirst, type `]` at the Julia REPL to enter the package prompt.\nNext, there are two ways to add this package to your Julia environment.\n1. **Add via PublicRegistry**: Type\n   `registry add https://github.com/StevenWhitaker/PublicRegistry` to add\n   PublicRegistry to the list of Julia package registries. Now you can type\n   `add STFR` to install the most recent version of STFR as if it were\n   registered in Julia's General registry. Furthermore, running `up` to update\n   your packages will automatically update STFR as updates become available.\n1. **Add via URL**: Type `add https://github.com/StevenWhitaker/STFR.jl#v2.0.0`\n   to add STFR v2.0.0 (note that `v2.0.0` can be replaced with whatever version\n   is needed). When an update becomes available, you will need to manually add\n   the updated version of STFR (e.g., with\n   `add https://github.com/StevenWhitaker/STFR.jl#v2.0.1`).\n\nAfter the package has been installed, hit backspace to return to the normal\nJulia prompt, and then type `using STFR` to load the package.\n\n## Examples\n\nBelow are some concrete examples of how to use this package.\n\n```julia\njulia\u003e using STFR\n\njulia\u003e sig = stfr(1, 1000, 100, 3.75 * 2π, 1, 8, 3, π/12, π/12, 0, 4) # Spoiled STFR\n0.1587855247046399 - 0.01500965127299392im\n\njulia\u003e stfr(1, 1000, 100, 3.75 * 2π, 1, 8, 3, π/12, π/12, 0, 4, Val(false)) # No RF spoiling\n0.009194809492086849 + 0.16021302758102335im\n\njulia\u003e spin = Spin(1, 1000, 100, 3.75) # From BlochSim.jl\nSpin{Float64}:\n M = Magnetization(0.0, 0.0, 1.0)\n M0 = 1.0\n T1 = 1000.0 ms\n T2 = 100.0 ms\n Δf = 3.75 Hz\n pos = Position(0.0, 0.0, 0.0) cm\n\njulia\u003e stfr! = STFRBlochSim(8, 3, 4, π/12, π/12, 0) # Create an object to simulate an STFR scan\nSmall-Tip Fast Recovery (STFR) Bloch Simulation:\n Tfree = 8 ms\n Tg = 3 ms\n TE = 4 ms\n rftipdown (tip-down excitation pulse) = Instantaneous RF pulse with eltype Float64:\n α = 0.2617993877991494 rad\n θ = 0.0 rad\n rftipup (tip-up RF pulse) = Instantaneous RF pulse with eltype Float64:\n α = -0.2617993877991494 rad\n θ = 0.0 rad\n spoiling = IdealSpoiling()\n steady-state\n\njulia\u003e stfr!(spin) # Simulate a steady-state STFR scan applied to the given spin\n\njulia\u003e spin.M # Steady-state magnetization\nMagnetization vector with eltype Float64:\n Mx = 0.15878552470463958\n My = -0.015009651272993887\n Mz = 0.6210482688962908\n\njulia\u003e signal(spin) ≈ sig\ntrue\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevenwhitaker%2Fstfr.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstevenwhitaker%2Fstfr.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevenwhitaker%2Fstfr.jl/lists"}