qsmToTable: Import a QSM File Into a Single Data Frame

Description Usage Arguments Value Author(s)

View source: R/qsmToTable.R

Description

Import a QSM file located in a folder into a single data frame.

Usage

1
qsmToTable(inputqsm, export=NULL)

Arguments

inputqsm

A character string specifying the path to the QSM file.

export

A character string specifying the path to the folder in which the returned table should be exported.

Value

Returns a qsmToTable object. Each line of the data frame gives the attributes of one segment. The data frame includes the following columns:

file: the name of the QSM file located in inputqsm.

branch: the branch identification number.

parentbranch: the identification number of the parent branch.

order: the branching order.

bran: the branching state (‘true’ denotes a branching link while ‘false’ denotes a continuing link).

apic: the apical state (‘true’ denotes a segment ending a branch).

x1: the X coordinate of the node starting the segment.

y1: the Y coordinate of the node starting the segment.

z1: the Z coordinate of the node starting the segment.

x2: the X coordinate of the node ending the segment.

y2: the Y coordinate of the node ending the segment.

z2: the Z coordinate of the node ending the segment.

length: the length of the segment.

blength: the cumulative length measured along each branch.

geodesic: the geodesic distance measured along the branches.

radius: the radius of the cylinder.

volume: the volume of the cylinder.

surface: the lateral surface area of the cylinder.

Author(s)

Benjamin M. Delory


BenjaminDelory/topotree documentation built on Sept. 28, 2019, 7:15 a.m.