Skip to main content

Toolkit for working with EMDB-SFF and other segmentation file formats

Project description

Introduction

sfftk is a set of utilities that facilitate creation, conversion and modification of Electron Microscopy Data Bank - Segmentation File Format (EMDB-SFF) files. EMDB-SFF is an open, community-driven file format to handle annotated segmentations and subtomogram averages that facilitates segmentation file interchange. It is written in Python and provides both a command-line suite of commands and a Python API.

Audience

sfftk is primarily targeted but not restricted to biological electron microscopists and developers of image segmentation software.

License

sfftk is free and open source software released under the terms of the Apache License, Version 2.0. Source code is copyright EMBL-European Bioinformatics Institute (EMBL-EBI) 2017.

Data Model

sfftk is built to handle EMDB-SFF files. The corresponding schema (v0.8.0.dev1) may be found at https://emdb-empiar.github.io/EMDB-SFF. Changes to the schema are welcome for discussion at the Segmentation Working Group at https://listserver.ebi.ac.uk/mailman/listinfo/segtrans-wg.

Supported Formats

The following file formats are currently supported (in alphabetical order of extensions):

  • Amira Mesh (.am)

  • SuRVoS (.h5; experimental support)

  • CCP4 Masks (.map)

  • IMOD (.mod)

  • Segger (.seg)

  • STAR (.star) for subtomogram averages produced using RELION

  • Stereolithography (.stl)

  • Amira HyperSurface (.surf)

Contact

Any questions or comments should be addressed to pkorir at ebi dot ac dot uk.

Publications

The EMDB-SFF data model is the result of various community consultations which are published in the following articles:

Getting Started

Obtaining and Installing sfftk

Dependencies

As with any Python software, we recommend installing it in a virtual environment (of your choice). The only dependency that may be needed is numpy which can be installed with

pip install numpy

PyPI

sfftk is available on PyPI meaning that all that one needs to do is run:

pip install sfftk

Source

The sfftk source is available from Github https://github.com/emdb-empiar/sfftk.

Features

sfftk has two principal functions:

  • convert application-specific segmentation file format (AS-SFF) files to EMDB-SFF;

  • annotate EMDB-SFF files against known ontologies.

Conversion

Segmentation files may be converted to EMDB-SFF files using the convert command.

sff convert file.am -o file.sff

For a full description of how to perform conversion, please see the guide to format conversion.

Annotation

Annotation is performed using the notes utility on EMDB-SFF files.

sff notes show -H file.sff

sfftk provides a simple set of tools to allow viewing, searching and modifying annotations associated with the segmentation and individual segments. The added annotations should be either from a public ontology or be an accession from a public database.

See the guide to annotating segmentations for a full treatment.

Miscellaneous

sfftk may also be used for several miscellaneous operations such as:

More information on this can be found in the guide to miscellaneous operations.

Developing with sfftk

sfftk is developed as a set of decoupled packages providing the various functionality. The main classes involved are found in the sfftkrw package. There is also a guide to developing with sfftk which provides useful instructions.

Extending sfftk

sfftk has built with extensibility in mind. It is anticipated that most extension will take the form of supporting additional file formats. Please read the guide to extending sfftk to learn how to do this.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sfftk-0.10.3.tar.gz (143.9 kB view details)

Uploaded Source

Built Distribution

sfftk-0.10.3-py3-none-any.whl (327.7 kB view details)

Uploaded Python 3

File details

Details for the file sfftk-0.10.3.tar.gz.

File metadata

  • Download URL: sfftk-0.10.3.tar.gz
  • Upload date:
  • Size: 143.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.4

File hashes

Hashes for sfftk-0.10.3.tar.gz
Algorithm Hash digest
SHA256 a5ab957c0affd2828e5fdb5d4e860ffd747e865ca2da7e7257c36d3a170ba4a6
MD5 b237d3f8a815b4e6ae67926a8237d315
BLAKE2b-256 cc7a9f147c7aee86b622c68d405c6a8cdcce121369973a36ff9a4ad036a55b53

See more details on using hashes here.

File details

Details for the file sfftk-0.10.3-py3-none-any.whl.

File metadata

  • Download URL: sfftk-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 327.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.4

File hashes

Hashes for sfftk-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6a9f47a91d1af3596b9fcd84e795d4e356fcc97089cc2b68e25c6603ac100bf4
MD5 8d19392c189985a40841323450b5c575
BLAKE2b-256 6dd927609b33895aae673de323dabf631c7ac7a46c9a4c92e821b389af96266b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page