qsirecon.interfaces.scalar_mapping module

class qsirecon.interfaces.scalar_mapping.BundleMapper(from_file=None, resource_monitor=None, **inputs)[source]

Bases: ScalarMapper

Optional Inputs:

  • bundle_names (a list of items which are a string)

  • dwiref_image (a pathlike object or string representing an existing file)

  • mapping_metadata (a dictionary with keys which are any value and with values which are any value) – Info about the upstream workflow that created the anatomical mapping units.

  • recon_scalars (a list of items which are any value)

  • scalars_from (a list of items which are a string)

  • tck_files (a list of items which are a pathlike object or string representing an existing file) – Paths to tck files.

Outputs:

  • bundle_summary (a pathlike object or string representing an existing file)

  • mapped_scalars (a list of items which are a pathlike object or string representing an existing file)

  • tdi_stats (a pathlike object or string representing an existing file)

class qsirecon.interfaces.scalar_mapping.ScalarMapper(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SimpleInterface

Optional Inputs:

  • dwiref_image (a pathlike object or string representing an existing file)

  • mapping_metadata (a dictionary with keys which are any value and with values which are any value) – Info about the upstream workflow that created the anatomical mapping units.

  • recon_scalars (a list of items which are any value)

  • scalars_from (a list of items which are a string)

Outputs:

mapped_scalars (a list of items which are a pathlike object or string representing an existing file)

class qsirecon.interfaces.scalar_mapping.TemplateMapper(from_file=None, resource_monitor=None, **inputs)[source]

Bases: ScalarMapper

Mandatory Inputs:

  • template_reference_image (a pathlike object or string representing an existing file)

  • template_space (a string)

  • to_template_transform (a pathlike object or string representing an existing file)

Optional Inputs:

  • dwiref_image (a pathlike object or string representing an existing file)

  • interpolation (a string) – (Nipype default value: NearestNeighbor)

  • mapping_metadata (a dictionary with keys which are any value and with values which are any value) – Info about the upstream workflow that created the anatomical mapping units.

  • recon_scalars (a list of items which are any value)

  • scalars_from (a list of items which are a string)

Outputs:

  • mapped_scalars (a list of items which are a pathlike object or string representing an existing file)

  • template_space (a string) – Output space.

  • template_space_scalar_info (a list of items which are any value)

  • template_space_scalars (a list of items which are any value)

qsirecon.interfaces.scalar_mapping.calculate_mask_stats(masker, mask_name, mask_variable_name, recon_scalar, weighting_vector=None)[source]