Orientations.from_file#

classmethod Orientations.from_file(filename, file_format=None, **kwargs)[source]#

Create an instance of Orientations from a file.

Parameters:
filenamestr

The name of the file from which to read the orientations.

file_formattype, optional

The format of the file. Defaults to None and infers the file_format from the typical extension. Supported formats are

tsv

Read pytme’s tab-separated orientations file

star

Read a STAR file of orientations

dynamo

Read a dynamo table

**kwargs

Additional keyword arguments specific to the file format.

Returns:
Orientations

An instance of Orientations populated with data from the file.

Raises:
ValueError

If an unsupported file format is specified.