===========
IMOD plugin
===========
This plugin provides wrappers for several programs of `IMOD <https://bio3d.colorado.edu/imod/>`_ software suite.
.. image:: https://img.shields.io/pypi/v/scipion-em-imod.svg
:target: https://pypi.python.org/pypi/scipion-em-imod
:alt: PyPI release
.. image:: https://img.shields.io/pypi/l/scipion-em-imod.svg
:target: https://pypi.python.org/pypi/scipion-em-imod
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/scipion-em-imod.svg
:target: https://pypi.python.org/pypi/scipion-em-imod
:alt: Supported Python versions
.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-imod?server=https%3A%2F%2Fsonarcloud.io
:target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-imod
:alt: SonarCloud quality gate
.. image:: https://img.shields.io/pypi/dm/scipion-em-imod
:target: https://pypi.python.org/pypi/scipion-em-imod
:alt: Downloads
Installation
------------
You will need to use `3.0+ <https://scipion-em.github.io/docs/release-3.0.0/docs/scipion-modes/how-to-install.html>`_ version of Scipion to be able to run these protocols.
Protocols
---------
* **Apply transformation** : Compute the interpolated tilt-series from its transform matrix. More info: `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__
* **CTF correction** : CTF correction of a set of input tilt-series using the IMOD procedure. More info: `ctfphaseflip doc <https://bio3d.colorado.edu/imod/doc/man/ctfphaseflip.html>`_
* **CTF estimation (auto)** : CTF estimation of a set of input tilt-series using the IMOD procedure. More info: `ctfplotter doc <https://bio3d.colorado.edu/imod/doc/man/ctfplotter.html>`_
* **CTF estimation (manual)** : CTF estimation of a set of input tilt-series using the IMOD procedure. Runs the protocol through the interactive GUI. The resulting defocus values MUST BE SAVED manually by the user. More info: `ctfplotter doc <https://bio3d.colorado.edu/imod/doc/man/ctfplotter.html>`_
* **Coarse prealignment** : Tilt-series cross correlation alignment based on the IMOD procedure. More info: `tiltxcorr doc <https://bio3d.colorado.edu/imod/doc/man/tiltxcorr.html>`_
* **Dose filter** : Tilt-series dose filtering based on the IMOD procedure. More info: `mtffilter doc <https://bio3d.colorado.edu/imod/doc/man/mtffilter.html>`_
* **Etomo interactive** : Simple wrapper around etomo to manually reconstruct a Tomogram. More info: `etomo tutorial <https://bio3d.colorado.edu/imod/doc/etomoTutorial.html>`_
* **Exclude views** : excludeviews - Reversibly remove views from a tilt series stack. If you use this protocol, make sure tis output tilt series is use for everything else CTF estimation, per particle per tilt, tomogram reconstruction....More info: `here <https://bio3d.colorado.edu/imod/doc/man/excludeviews.html>`_
* **Fiducial alignment** : Construction of a fiducial model and alignment of tilt-series based on the IMOD procedure. More info: `tiltalign doc <https://bio3d.colorado.edu/imod/doc/man/tiltalign.html>`_ , `model2point doc <https://bio3d.colorado.edu/imod/doc/man/model2point.html>`_, `imodtrans doc <https://bio3d.colorado.edu/imod/doc/man/imodtrans.html>`_, `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__, `ccderaser doc <https://bio3d.colorado.edu/imod/doc/man/ccderaser.html>`_
* **Generate fiducial model** : Construction of a fiducial model and alignment of tilt-series based on the IMOD procedure. More info: `autofidseed doc <https://bio3d.colorado.edu/imod/doc/man/autofidseed.html>`_, `beadtrack doc <https://bio3d.colorado.edu/imod/doc/man/beadtrack.html>`_, `model2point doc <https://bio3d.colorado.edu/imod/doc/man/model2point.html>`_
* **Gold bead picker 3D** : 3-dimensional gold bead picker using the IMOD procedure. More info: `findbeads3d doc <https://bio3d.colorado.edu/imod/doc/man/findbeads3d.html>`_
* **Import transformation matrix** : Import the transformation matrices assigned to an input set of tilt-series
* **Tilt-series preprocess** : Normalize input tilt-series and change its storing formatting. More info: `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__
* **Tomo preprocess** : Normalize input tomogram and change its storing formatting. More info: `newstack doc <https://bio3D.colorado.edu/imod/doc/newstack.html>`__, `binvol doc <https://bio3D.colorado.edu/imod/doc/binvol.html>`_
* **Tomo projection** : Re-project a tomogram given a geometric description (axis and angles). More info: `xyzproj doc <https://bio3d.colorado.edu/imod/doc/man/xyzproj.html>`_
* **Tomo reconstruction** : omogram reconstruction procedure based on the IMOD procedure. More info: `tilt doc <https://bio3d.colorado.edu/imod/doc/man/tilt.html>`_
* **X-rays eraser** : Erase X-rays from aligned tilt-series based on the IMOD procedure. More info: `ccderaser doc <https://bio3d.colorado.edu/imod/doc/man/ccderaser.html>`_
**Latest plugin versions**
==========================
If you want to check the latest version and release history go to `CHANGES <https://github.com/scipion-em/scipion-em-imod/imod/blob/master/CHANGES.txt>`_
**Installing the plugin**
=========================
In order to install the plugin follow these instructions:
.. code-block::
scipion installp -p scipion-em-imod
or through the **plugin manager** by launching Scipion and following **Configuration** >> **Plugins**
**To install in development mode**
Clone or download the plugin repository
.. code-block::
git clone -b devel https://github.com/scipion-em/scipion-em-imod.git
Install the plugin in developer mode.
.. code-block::
scipion installp -p local/path/to/scipion-em-imod --devel
IMOD binaries will be downloaded and installed automatically with the plugin, but you can also link an existing installation. Default installation path assumed is ``software/em/imod-4.11.24/IMOD``, if you want to change it, set ``IMOD_HOME`` in ``scipion.conf`` file to the folder where the IMOD is installed.
To check the installation, simply run one of the tests. A complete list of tests can be displayed by executing ``scipion test --show --grep imod``
**Changing the binning level for 3dmod**
========================================
For quick visualization purposes, it can be useful to bin images and tomograms on the fly using the ``ImodViewer`` provided by this plugin (i.e. ``3dmod``). For that, the user can define the ``IMOD_VIEWER_BINNING`` environment variable in ``scipion.conf`` as in the following example:
.. code-block::
[PLUGINS]
IMOD_HOME = %(EM_ROOT)s/imod-4.11.25/IMOD
IMOD_VIEWER_BINNING = 8
Supported versions
------------------
4.11.24, 4.11.25
References
----------
1. James R. Kremer, David N. Mastronarde, J.Richard McIntosh. Computer Visualization of Three-Dimensional Image Data Using IMOD. Journal of Structural Biology, Volume 116, Issue 1, 1996, Pages 71-76. https://doi.org/10.1006/jsbi.1996.0013
2. David N. Mastronarde, Susannah R. Held. Automated tilt series alignment and tomographic reconstruction in IMOD. Journal of Structural Biology, Volume 197, Issue 2, 2017, Pages 102-113, ISSN 1047-8477. https://doi.org/10.1016/j.jsb.2016.07.011
Buildbot status
---------------
Status devel version:
.. image:: http://scipion-test.cnb.csic.es:9980/badges/imod_devel.svg
Status production version:
.. image:: http://scipion-test.cnb.csic.es:9980/badges/imod_prod.svg
Raw data
{
"_id": null,
"home_page": "https://github.com/scipion-em/scipion-em-imod",
"name": "scipion-em-imod",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "scipion imod electron-microscopy cryo-em cryo-tomography subtomogram-averaging structural-biology image-processing scipion-3.0",
"author": "I2PC",
"author_email": "scipion@cnb.csic.es",
"download_url": "https://files.pythonhosted.org/packages/bb/e4/4df0ef99fc04d495c43068ea572812eae7861aa0f1e1d01579e993014c42/scipion-em-imod-3.6.tar.gz",
"platform": null,
"description": "===========\nIMOD plugin\n===========\n\nThis plugin provides wrappers for several programs of `IMOD <https://bio3d.colorado.edu/imod/>`_ software suite.\n\n.. image:: https://img.shields.io/pypi/v/scipion-em-imod.svg\n :target: https://pypi.python.org/pypi/scipion-em-imod\n :alt: PyPI release\n\n.. image:: https://img.shields.io/pypi/l/scipion-em-imod.svg\n :target: https://pypi.python.org/pypi/scipion-em-imod\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/scipion-em-imod.svg\n :target: https://pypi.python.org/pypi/scipion-em-imod\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/sonar/quality_gate/scipion-em_scipion-em-imod?server=https%3A%2F%2Fsonarcloud.io\n :target: https://sonarcloud.io/dashboard?id=scipion-em_scipion-em-imod\n :alt: SonarCloud quality gate\n\n.. image:: https://img.shields.io/pypi/dm/scipion-em-imod\n :target: https://pypi.python.org/pypi/scipion-em-imod\n :alt: Downloads\n\nInstallation\n------------\n\nYou will need to use `3.0+ <https://scipion-em.github.io/docs/release-3.0.0/docs/scipion-modes/how-to-install.html>`_ version of Scipion to be able to run these protocols.\n\nProtocols\n---------\n\n* **Apply transformation** : Compute the interpolated tilt-series from its transform matrix. More info: `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__\n* **CTF correction** : CTF correction of a set of input tilt-series using the IMOD procedure. More info: `ctfphaseflip doc <https://bio3d.colorado.edu/imod/doc/man/ctfphaseflip.html>`_\n* **CTF estimation (auto)** : CTF estimation of a set of input tilt-series using the IMOD procedure. More info: `ctfplotter doc <https://bio3d.colorado.edu/imod/doc/man/ctfplotter.html>`_\n* **CTF estimation (manual)** : CTF estimation of a set of input tilt-series using the IMOD procedure. Runs the protocol through the interactive GUI. The resulting defocus values MUST BE SAVED manually by the user. More info: `ctfplotter doc <https://bio3d.colorado.edu/imod/doc/man/ctfplotter.html>`_\n* **Coarse prealignment** : Tilt-series cross correlation alignment based on the IMOD procedure. More info: `tiltxcorr doc <https://bio3d.colorado.edu/imod/doc/man/tiltxcorr.html>`_\n* **Dose filter** : Tilt-series dose filtering based on the IMOD procedure. More info: `mtffilter doc <https://bio3d.colorado.edu/imod/doc/man/mtffilter.html>`_\n* **Etomo interactive** : Simple wrapper around etomo to manually reconstruct a Tomogram. More info: `etomo tutorial <https://bio3d.colorado.edu/imod/doc/etomoTutorial.html>`_\n* **Exclude views** : excludeviews - Reversibly remove views from a tilt series stack. If you use this protocol, make sure tis output tilt series is use for everything else CTF estimation, per particle per tilt, tomogram reconstruction....More info: `here <https://bio3d.colorado.edu/imod/doc/man/excludeviews.html>`_\n* **Fiducial alignment** : Construction of a fiducial model and alignment of tilt-series based on the IMOD procedure. More info: `tiltalign doc <https://bio3d.colorado.edu/imod/doc/man/tiltalign.html>`_ , `model2point doc <https://bio3d.colorado.edu/imod/doc/man/model2point.html>`_, `imodtrans doc <https://bio3d.colorado.edu/imod/doc/man/imodtrans.html>`_, `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__, `ccderaser doc <https://bio3d.colorado.edu/imod/doc/man/ccderaser.html>`_\n* **Generate fiducial model** : Construction of a fiducial model and alignment of tilt-series based on the IMOD procedure. More info: `autofidseed doc <https://bio3d.colorado.edu/imod/doc/man/autofidseed.html>`_, `beadtrack doc <https://bio3d.colorado.edu/imod/doc/man/beadtrack.html>`_, `model2point doc <https://bio3d.colorado.edu/imod/doc/man/model2point.html>`_\n* **Gold bead picker 3D** : 3-dimensional gold bead picker using the IMOD procedure. More info: `findbeads3d doc <https://bio3d.colorado.edu/imod/doc/man/findbeads3d.html>`_\n* **Import transformation matrix** : Import the transformation matrices assigned to an input set of tilt-series\n* **Tilt-series preprocess** : Normalize input tilt-series and change its storing formatting. More info: `newstack doc <https://bio3d.colorado.edu/imod/doc/man/newstack.html>`__\n* **Tomo preprocess** : Normalize input tomogram and change its storing formatting. More info: `newstack doc <https://bio3D.colorado.edu/imod/doc/newstack.html>`__, `binvol doc <https://bio3D.colorado.edu/imod/doc/binvol.html>`_\n* **Tomo projection** : Re-project a tomogram given a geometric description (axis and angles). More info: `xyzproj doc <https://bio3d.colorado.edu/imod/doc/man/xyzproj.html>`_\n* **Tomo reconstruction** : omogram reconstruction procedure based on the IMOD procedure. More info: `tilt doc <https://bio3d.colorado.edu/imod/doc/man/tilt.html>`_\n* **X-rays eraser** : Erase X-rays from aligned tilt-series based on the IMOD procedure. More info: `ccderaser doc <https://bio3d.colorado.edu/imod/doc/man/ccderaser.html>`_\n\n**Latest plugin versions**\n==========================\n\nIf you want to check the latest version and release history go to `CHANGES <https://github.com/scipion-em/scipion-em-imod/imod/blob/master/CHANGES.txt>`_\n\n\n**Installing the plugin**\n=========================\n\nIn order to install the plugin follow these instructions:\n\n.. code-block::\n\n scipion installp -p scipion-em-imod\n\n\nor through the **plugin manager** by launching Scipion and following **Configuration** >> **Plugins**\n\n\n**To install in development mode**\n\nClone or download the plugin repository\n\n.. code-block::\n\n git clone -b devel https://github.com/scipion-em/scipion-em-imod.git\n\nInstall the plugin in developer mode.\n\n.. code-block::\n\n scipion installp -p local/path/to/scipion-em-imod --devel\n\n\nIMOD binaries will be downloaded and installed automatically with the plugin, but you can also link an existing installation. Default installation path assumed is ``software/em/imod-4.11.24/IMOD``, if you want to change it, set ``IMOD_HOME`` in ``scipion.conf`` file to the folder where the IMOD is installed.\n\nTo check the installation, simply run one of the tests. A complete list of tests can be displayed by executing ``scipion test --show --grep imod``\n\n**Changing the binning level for 3dmod**\n========================================\nFor quick visualization purposes, it can be useful to bin images and tomograms on the fly using the ``ImodViewer`` provided by this plugin (i.e. ``3dmod``). For that, the user can define the ``IMOD_VIEWER_BINNING`` environment variable in ``scipion.conf`` as in the following example:\n\n.. code-block::\n [PLUGINS]\n\n IMOD_HOME = %(EM_ROOT)s/imod-4.11.25/IMOD\n IMOD_VIEWER_BINNING = 8\n\nSupported versions\n------------------\n\n4.11.24, 4.11.25\n\n\nReferences\n----------\n\n1. James R. Kremer, David N. Mastronarde, J.Richard McIntosh. Computer Visualization of Three-Dimensional Image Data Using IMOD. Journal of Structural Biology, Volume 116, Issue 1, 1996, Pages 71-76. https://doi.org/10.1006/jsbi.1996.0013\n2. David N. Mastronarde, Susannah R. Held. Automated tilt series alignment and tomographic reconstruction in IMOD. Journal of Structural Biology, Volume 197, Issue 2, 2017, Pages 102-113, ISSN 1047-8477. https://doi.org/10.1016/j.jsb.2016.07.011\n\n\nBuildbot status\n---------------\n\nStatus devel version:\n\n.. image:: http://scipion-test.cnb.csic.es:9980/badges/imod_devel.svg\n\n\nStatus production version:\n\n.. image:: http://scipion-test.cnb.csic.es:9980/badges/imod_prod.svg\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Plugin to use some of the Tomography tools from IMOD in Scipion",
"version": "3.6",
"project_urls": {
"Bug Reports": "https://github.com/scipion-em/scipion-em-imod/issues",
"Homepage": "https://github.com/scipion-em/scipion-em-imod",
"Source": "https://github.com/scipion-em/scipion-em-imod/"
},
"split_keywords": [
"scipion",
"imod",
"electron-microscopy",
"cryo-em",
"cryo-tomography",
"subtomogram-averaging",
"structural-biology",
"image-processing",
"scipion-3.0"
],
"urls": [
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "f7519abfc4abacdfdb491680daf2695c793bf23478a8bc3dfd8673258e8e2c91",
"md5": "063ab8220591404de6335aba7fdba1a0",
"sha256": "899c86c1d78a52f130385f6624ae9b7aa29516a4e00420fc12d814e984a29cac"
},
"downloads": -1,
"filename": "scipion_em_imod-3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "063ab8220591404de6335aba7fdba1a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 147721,
"upload_time": "2024-10-03T13:56:55",
"upload_time_iso_8601": "2024-10-03T13:56:55.297355Z",
"url": "https://files.pythonhosted.org/packages/f7/51/9abfc4abacdfdb491680daf2695c793bf23478a8bc3dfd8673258e8e2c91/scipion_em_imod-3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "scipion-3.0",
"digests": {
"blake2b_256": "bbe44df0ef99fc04d495c43068ea572812eae7861aa0f1e1d01579e993014c42",
"md5": "c2c151a30c6bb3565d6569560fdb8067",
"sha256": "84c16a2b22781d22e9e46cd02d911cc299b26222e6ab6f0fec9dbb643a8aa008"
},
"downloads": -1,
"filename": "scipion-em-imod-3.6.tar.gz",
"has_sig": false,
"md5_digest": "c2c151a30c6bb3565d6569560fdb8067",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 120812,
"upload_time": "2024-10-03T13:56:56",
"upload_time_iso_8601": "2024-10-03T13:56:56.916744Z",
"url": "https://files.pythonhosted.org/packages/bb/e4/4df0ef99fc04d495c43068ea572812eae7861aa0f1e1d01579e993014c42/scipion-em-imod-3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 13:56:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scipion-em",
"github_project": "scipion-em-imod",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "scipion-em-tomo",
"specs": [
[
">=",
"3.8.0"
]
]
}
],
"lcname": "scipion-em-imod"
}
JSON
