susan.data.Reference

class susan.data.Reference(filename=None, n_refs=0)

Bases: object

Container for one or more reference maps used in STA alignment.

Each reference entry holds paths to four MRC files: the full map, a soft mask, and the two independent half-maps. The half-maps are used for FSC-based resolution estimation and as N2N training pairs.

File format: plain-text .refstxt.

Attributes

ref

Paths to the full reference maps.

Type:

list of str

msk

Paths to the soft masks (same box size as the references).

Type:

list of str

h1

Paths to half-map 1 for each reference.

Type:

list of str

h2

Paths to half-map 2 for each reference.

Type:

list of str

Properties

property n_refs

Return the number of references stored.

Static Methods

static load(filename)

Load a Reference from a .refstxt file.

Parameters:

filename (str) – Path to a .refstxt file.

Return type:

Reference

Methods

save(filename)

Save to a .refstxt file.

Parameters:

filename (str) – Output path; must have a .refstxt extension.