susan

susan.read(filename)[source]

Read a SUSAN-supported file and return the appropriate object.

The file format is inferred from the extension.

Parameters:

filename (str) – Path to the file to read.

Returns:

The type depends on the file extension:

Extension(s)

Format

Returned type

.mrc .map

MRC volume

numpy.ndarray

.ali .st

.rec

.ptclsraw

SUSAN particles

susan.data.Particles

.refstxt

SUSAN references

susan.data.Reference

.tomostxt

SUSAN tomograms

susan.data.Tomograms

Return type:

numpy.ndarray or susan.data.Particles or susan.data.Tomograms or susan.data.Reference

Raises:

ValueError – If the file extension is not recognised.

Submodules