Read a transform output using neurotransform — ni_read

Loads a spatial transform file using the output's declarative transform metadata. The metadata records the payload kind, on-disk convention, and the inputs that define its source and target image domains. This avoids guessing from a .mat suffix or tool name, both of which are ambiguous across FSL, ANTs/ITK, AFNI, and FreeSurfer.

Usage

ni_read_transform(
  result,
  output_name = NULL,
  type = NULL,
  source_image = NULL,
  target_image = NULL,
  source = NULL,
  target = NULL,
  ...
)

Arguments

result: An ni_result object.
output_name: Name of the transform output. May be omitted when exactly one resolved output is declared as a transform.
type: Optional explicit neurotransform type for an undeclared legacy output. Requires output_name; declared outputs use their spec metadata.
source_image, target_image: Optional image paths overriding the source and target images named in the spec metadata. These are mainly useful for FSL matrices, whose interpretation depends on both image geometries.
source, target: Optional source and target domain identifiers stored on the returned morphism. By default the corresponding image paths are used.
...: Additional arguments passed to the selected neurotransform reader.

Value

A neurotransform morphism object.