tomodrgn.starfile.is_starfile_optimisation_set

is_starfile_optimisation_set(star_path: str) → bool

Infer whether a star file on disk is a RELION optimisation set, or some other type of star file. Defining characteristics of an optimisation set star file:

• the data block name is data_

• the data block is a simple, two column, dictionary-style block

• the data block minimally contains the keys _rlnTomoTomogramsFile and _rlnTomoParticlesFile, as these are needed for tomodrgn

Parameters:

star_path – path to potential optimisation set star file on disk

Returns:

bool of whether the input star file matches characteristics of an optimisation set star file