webknossos._nml.nml

class Nml(builtins.tuple):

Nml(meta, parameters, trees, branchpoints, comments, groups, volumes)

Create new instance of Nml(meta, parameters, trees, branchpoints, comments, groups, volumes)

meta: List[webknossos._nml.meta.Meta]

Alias for field number 0

Alias for field number 1

trees: List[webknossos._nml.tree.Tree]

Alias for field number 2

branchpoints: List[webknossos._nml.branchpoint.Branchpoint]

Alias for field number 3

comments: List[webknossos._nml.comment.Comment]

Alias for field number 4

groups: List[webknossos._nml.group.Group]

Alias for field number 5

volumes: List[webknossos._nml.volume.Volume]

Alias for field number 6

def get_meta(self, key: str) -> Union[str, NoneType]:

def write(self, file: <class 'BinaryIO'>) -> None:

Writes the NML object to a file on disk.

Arguments: file (BinaryIO): A Python file handle

Example:

with open("out.nml", "wb") as f:
    nml.write(f, nml)

@classmethod

def parse(cls, file: IO[bytes]) -> webknossos._nml.nml.Nml:

Reads a WEBKNOSSOS NML skeleton file from disk, _parses it and returns an NML Python object

Arguments: file (BinaryIO): A Python file handle

Return: NML: A WEBKNOSSOS skeleton annotation as Python NML object

Example:

with open("input.nml", "rb") as f:
    nml = Nml.parse(f)