fw_gear_petsurfer_mc 0.1.5

No project description provided

petsurfer-mc

Overview

Summary

Motion correction of PET volumes (Petsurfer pipeline).

Cite

https://surfer.nmr.mgh.harvard.edu/fswiki/PetSurfer Other

Classification

Category: analysis

Gear Level:

• Project
• Subject
• Session
• Acquisition
• Analysis

---

[[TOC]]

---

Inputs

• petfile
  • Name: petfile
  • Type: nifti
  • Optional: false
  • Classification: PT
  • Description: Input NIfTI file for the Motion correction

Config

• debug

  • Name: debug
  • Type: string
  • Description: Log debug messages.
  • Default: false

• freeview_license_key

  • Name: freeview_license_key
  • Type: string
  • Description: Text from license file generated during FreeSurfer registration. Entries should be space separated.
  • Default: **

• frame_pattern

  • Name: frame_pattern
  • Type: string
  • Description: Text regular expression that will be used to get the frames to be aligned. For example if the pattern will be '^(ID01|Frame)$', the gear will look for ID01 and Frame to get the PET volumes for the template creation. It is case Insensitive.
  • Default: false

• template_creation

  • Name: template_creation
  • Type: string
  • Description: Select a method for PET template creation that will be used as target image for motion correction of PET dynamic volumes. The template can be generated by extracting a single frame ('sinlge_frame') or averaging all the time frames together ('mean').
  • Default: **

• ref_frame

  • Name: ref_frame
  • Type: string
  • Description: If the PET data only have one frame (eg, an uptake image), then that will be the template. If the PET data has multiple frames (ie, dynamic), then the template will be created from the dynamic data. In this case, this option can be used to specify which frame will be used as reference.
  • Default: "0"

Outputs

Files

Average PET volume

• *_avg.nii.g
  • Name: *_avg.nii.gz
  • Type: nifti
  • Optional: **
  • Classification: **
  • Description: Averaged PET volumes compute after intra-subject motion correction process.
  • Notes: This file will be used as template space for coregistration (petsurfer-coreg).

Motion correction parameters

• *_avg.dat
  • Name: *_avg.dat
  • Type: dat
  • Optional: false
  • Classification: **
  • Description: data file including motion correction parameters

Plots of motion correction parameters (displacement and rotation)

• displacement and rotation
  • Name: * mc_displacement.png, mc_rotation.png*
  • Type: png
  • Optional: false
  • Classification: **
  • Description: Plots for visualize displacement and rotation corrections.
  • Notes: For QC usage.

Metadata

Motion correction metadata (mean and variance) are store as custom information on the Analysis container. Dataview can be used to report on those metrics.

Pre-requisites

None

Prerequisite Gear Runs

None

Prerequisite Files

None

Prerequisite Metadata

None

Usage

Description

*This gear will get the PET volumes converted by dcm2nxx and run the motion correction process to correct for displacement and rotations occurred during the acquisition. The average PET volume is computed and used as reference template for the PetSurfer pipeline. *

File Specifications

This section contains specifications on any input files that the gear may need

{Input-File}

A description of the input file

Workflow

Description of workflow

1. Upload file to container
2. Set up the gear rules
3. Geat places output in Analysis

Use Cases

Use Case 1

*Conditions*:

• Possibly a list of check boxes indicating things that are absent
• and things that are present

There are no use cases. This gear will run upon setting the gear rules at project level.

Logging

It throws the log from the registration system.

FAQ

FAQ.md

Contributing

[For more information about how to get started contributing to that gear, checkout CONTRIBUTING.md.]