identifyImageFileNames: Resolve image paths

identifyImageFileNamesR Documentation

Resolve image paths

Description

This function identifies characteristics of an image on disk, including associated auxiliary files. Its functionality has essentially been superseded by methods of the ImageFileSet class, but it remains as an alternative interface to that functionality for backwards compatibility.

Usage

identifyImageFileNames(fileName, errorIfMissing = TRUE,
  auxiliaries = c("dirs", "lut", "tags"), ...)

Arguments

fileName

A character vector of image paths.

errorIfMissing

Logical value: raise an error if no suitable files were found?

auxiliaries

A character vector of auxiliary file suffixes to search for.

...

Additional arguments to resolvePath.

Value

A list with the following elements, describing the identified files:

fileStem

The file name without extension.

headerFile

The full header file name.

imageFile

The full image file name.

auxiliaryFiles

The full path to any auxiliary files.

format

The basic format of the files ("Nifti", "Analyze", etc.).

headerSuffix

The file suffix associated with the header file.

imageSuffix

The file suffix associated with the image file.

auxiliarySuffixes

The file suffixes associated with any auxiliary files.

Author(s)

Jon Clayden

References

Please cite the following reference when using TractoR in your work:

J.D. Clayden, S. Muñoz Maniega, A.J. Storkey, M.D. King, M.E. Bastin & C.A. Clark (2011). TractoR: Magnetic resonance imaging and tractography with R. Journal of Statistical Software 44(8):1-18. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.18637/jss.v044.i08")}.

See Also

imageFiles, resolvePath


tractor.base documentation built on Nov. 5, 2025, 6:18 p.m.