aslprep.interfaces.reference module

Interfaces for building reference images.

class SelectHighestContrastVolumes(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SimpleInterface

Select the highest-contrast volume type for reference volume generation.

This interface selects the highest-contrast volume type from the ASL context file and returns a file containing the highest-contrast volumes. The choice of volume type is based on a hard-coded priority list: - Included M0 scan (if prioritized) - Separate M0 scan (if prioritized) - CBF - DeltaM - Included M0 scan (if not prioritized) - Separate M0 scan (if not prioritized) - Control

Mandatory Inputs:

  • asl_file (a pathlike object or string representing an existing file) – ASL file.

  • aslcontext (a pathlike object or string representing an existing file) – ASL context file.

  • prioritize_m0 (a boolean) – Whether to prioritize the M0 scan (useful for GE data) or not.

Optional Inputs:

m0scan (a pathlike object or string representing an existing file) – M0 scan file. Only provided if M0Type is ‘separate’.

Outputs:

selected_volumes_file (a pathlike object or string representing a file) – File containing the highest-contrast available volumes.