# **************************************************************************
# *
# * Authors: Federico P. de Isidro Gomez (fp.deisidro@cnb.csi.es) [1]
# *
# * [1] Centro Nacional de Biotecnologia, CSIC, Spain
# *
# * This program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 2 of the License, or
# * (at your option) any later version.
# *
# * This program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with this program; if not, write to the Free Software
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# * 02111-1307 USA
# *
# * All comments concerning this program package may be sent to the
# * e-mail address 'scipion@cnb.csic.es'
# *
# **************************************************************************
import os
import numpy as np
import math
import csv
import pwem.objects as data
from pyworkflow import BETA
import pyworkflow.protocol.params as params
import pyworkflow.utils.path as path
from pwem.protocols import EMProtocol
import tomo.objects as tomoObj
from tomo.protocols import ProtTomoBase
[docs]class XmippProtMisalignTiltSeries(EMProtocol, ProtTomoBase):
"""
Introduce misalignment in the transformation matrix of a tilt-series
"""
_label = 'misalign tilt-series '
_devStatus = BETA
def __init__(self, **kwargs):
EMProtocol.__init__(self, **kwargs)
# -------------------------- DEFINE param functions -----------------------
def _defineParams(self, form):
form.addSection('Input')
form.addParam('inputSetOfTiltSeries',
params.PointerParam,
pointerClass='SetOfTiltSeries',
important=True,
label='Input set of tilt-series')
""" Options to introduce misalignment in the X axis shift"""
form.addParam('shiftXNoiseToggle',
params.EnumParam,
choices=['Yes', 'No'],
default=1,
label='Introduce misalignment in shift X?',
important=True,
display=params.EnumParam.DISPLAY_HLIST,
help='Introduce noise in the shift alignment value in the X axis. Characterize the noise '
'behaviour through the parameters in the following formula:\n'
'\n'
'dx = a0 + a1 * i + a2 * sin((i + a3) / S * pi) + a4 * sin((i + a5) / S * 2 * pi) '
'+ N(0,a6)\n'
'\n'
'Being i the index position of the image inside the tilt-series, S the size of it and N a '
'normal distribution.'
'These parameters characterize the following behaviours:\n'
'- Constant (a0): an offset error (a0) is introduced in every image of the tilt-series.\n'
'- Incremental (a1): a constant incremental error (a1) is propagated through the '
'tilt-series.\n'
'- Sine lobe (a2, a3): the introduced error presents a half sine shape, characterized by '
'the error amplitude (a2) and the phase to displace the error function a given number of '
'images inside the tilt-series (a3).\n'
'- Sine cycle (a4, a5): the introduced error presents a full sine cycle shape, '
'characterized by the error amplitude (a4) and the phase to displace the error function a '
'given number of images inside the tilt-series (a5).\n'
'- Random (a6): a random error is introduced in every image of the tilt-series given a '
'sigma value (a6).\n')
groupShiftX = form.addGroup('Misalignment parameters in shift X',
condition='shiftXNoiseToggle==0')
groupShiftX.addParam('a0param',
params.FloatParam,
default=0.0,
label='Offset error (a0)',
help='Offset shift error introduced in the X axis for every image of the tilt-series.')
groupShiftX.addParam('a1param',
params.FloatParam,
default=0.0,
label='Incremental error (a1)',
help='Incremental shift error introduced in the X axis for every image of the '
'tilt-series.')
groupShiftX.addParam('a2param',
params.FloatParam,
default=0.0,
label='Sine lobe error amplitude (a2)',
help='Maximum amplitude of the sine lobe error function introduced in the X axis.')
groupShiftX.addParam('a3param',
params.IntParam,
default=0,
label='Sine lobe error phase (a3)',
help='Phase (displacement) of the sine lobe error function. The introduced number '
'corresponds to the number of images from the tilt-series that the origin of the '
'error function will be displaced.')
groupShiftX.addParam('a4param',
params.FloatParam,
default=0.0,
label='Sine error amplitude (a4)',
help='Maximum amplitude of the sine error function introduced in the X axis.')
groupShiftX.addParam('a5param',
params.IntParam,
default=0,
label='Sine error phase (a5)',
help='Phase (displacement) of the sine error function. The introduced number corresponds '
'to the number of images from the tilt-series that the origin of the error function '
'will be displaced.')
groupShiftX.addParam('a6param',
params.FloatParam,
default=0.0,
label='Random error sigma (a6)',
help='Sigma value for the random error introduced in the shift X.')
""" Options to introduce misalignment in the Y axis shift"""
form.addParam('shiftYNoiseToggle',
params.EnumParam,
choices=['Yes', 'No'],
default=1,
label='Introduce misalignment in shift Y?',
important=True,
display=params.EnumParam.DISPLAY_HLIST,
help='Introduce noise in the shift alignment value in the Y axis. Characterize the noise '
'behaviour through the parameters in the following formula:\n'
'\n'
'dY = b0 + b1 * i + b2 * sin((i + b3) / S * pi) + b4 * sin((i + b5) / S * 2 * pi) '
'+ N(0,b6)\n'
'\n'
'Being i the index position of the image inside the tilt-series, S the size of it and N a '
'normal distribution.'
'These parameters characterize the following behaviours:\n'
'- Constant (b0): an offset error (b0) is introduced in every image of the tilt-series.\n'
'- Incremental (b1): a constant incremental error (b1) is propagated through the '
'tilt-series.\n'
'- Sine lobe (b2, b3): the introduced error presents a half sine shape, characterized by '
'the error amplitude (b2) and the phase to displace the error function a given number of '
'images inside the tilt-series (b3).\n'
'- Sine cycle (b4, b5): the introduced error presents a full sine cycle shape, '
'characterized by the error amplitude (b4) and the phase to displace the error function a '
'given number of images inside the tilt-series (b5).\n'
'- Random (b6): a random error is introduced in every image of the tilt-series given a '
'sigma value (b6).\n')
groupShiftY = form.addGroup('Misalignment parameters in shift Y',
condition='shiftYNoiseToggle==0')
groupShiftY.addParam('b0param',
params.FloatParam,
default=0.0,
label='Offset error (b0)',
help='Offset shift error introduced in the Y axis for every image of the tilt-series.')
groupShiftY.addParam('b1param',
params.FloatParam,
default=0.0,
label='Incremental error (b1)',
help='Incremental shift error introduced in the Y axis for every image of the '
'tilt-series.')
groupShiftY.addParam('b2param',
params.FloatParam,
default=0.0,
label='Sine lobe error amplitude (b2)',
help='Maximum amplitude of the sine lobe error function introduced in the Y axis.')
groupShiftY.addParam('b3param',
params.IntParam,
default=0,
label='Sine lobe error phase (b3)',
help='Phase (displacement) of the sine lobe error function. The introduced number '
'corresponds to the number of images from the tilt-series that the origin of the '
'error function will be displaced.')
groupShiftY.addParam('b4param',
params.FloatParam,
default=0.0,
label='Sine error amplitude (b4)',
help='Maximum amplitude of the sine error function introduced in the Y axis.')
groupShiftY.addParam('b5param',
params.IntParam,
default=0,
label='Sine error phase (b5)',
help='Phase (displacement) of the sine error function. The introduced number corresponds '
'to the number of images from the tilt-series that the origin of the error function '
'will be displaced.')
groupShiftY.addParam('b6param',
params.FloatParam,
default=0.0,
label='Random error sigma (b6)',
help='Sigma value for the random error introduced in the shift Y.')
""" Options to introduce misalignment in the angle"""
form.addParam('angleNoiseToggle',
params.EnumParam,
choices=['Yes', 'No'],
default=1,
label='Introduce misalignment in angle?',
important=True,
display=params.EnumParam.DISPLAY_HLIST,
help='Introduce noise in the angle alignment value. Characterize the noise behaviour through the '
'parameters in the following formula:\n'
'\n'
'dA = c0 + c1 * i + c2 * sin((i + c3) / S * pi) + c4 * sin((i + c5) / S * 2 * pi) '
'+ N(0,c6)\n'
'\n'
'Being i the index position of the image inside the tilt-series, S the size of it and N a '
'normal distribution.'
'These parameters characterize the following behaviours:\n'
'- Constant (c0): an offset error (c0) is introduced in every image of the tilt-series.\n'
'- Incremental (c1): a constant incremental error (c1) is propagated through the '
'tilt-series.\n'
'- Sine lobe (c2, c3): the introduced error presents a half sine shape, characterized by '
'the error amplitude (c2) and the phase to displace the error function a given number of '
'images inside the tilt-series (c3).\n'
'- Sine cycle (c4, c5): the introduced error presents a full sine cycle shape, '
'characterized by the error amplitude (c4) and the phase to displace the error function a '
'given number of images inside the tilt-series (c5).\n'
'- Random (c6): a random error is introduced in every image of the tilt-series given a '
'sigma value (c6).\n')
groupAngle = form.addGroup('Misalignment parameters in angle',
condition='angleNoiseToggle==0')
groupAngle.addParam('c0param',
params.FloatParam,
default=0.0,
label='Offset error (c0)',
help='Constant angle error to add for every image of the tilt-series. Angles are measured '
'in degrees.')
groupAngle.addParam('c1param',
params.FloatParam,
default=0.0,
label='Incremental error (c1)',
help='Initial angle error value for the first image (lowest angle) of the tilt-series. '
'Angles are measured in degrees.')
groupAngle.addParam('c2param',
params.FloatParam,
default=0.0,
label='Sine lobe error amplitude (c2)',
help='Maximum amplitude of the sine lobe error function introduced in the angle. Angles '
'are measured in degrees.')
groupAngle.addParam('c3param',
params.IntParam,
default=0,
label='Sine lobe error phase (c3)',
help='Phase (displacement) of the sine lobe error function. The introduced number '
'corresponds to the number of images from the tilt-series that the origin of the '
'error function will be displaced.')
groupAngle.addParam('c4param',
params.FloatParam,
default=0.0,
label='Sine error amplitude (c4)',
help='Maximum amplitude of the sine error function introduced in the angle. Angles are '
'measured in degrees.')
groupAngle.addParam('c5param',
params.IntParam,
default=0,
label='Sine error phase (c5)',
help='Phase (displacement) of the sine error function. The introduced number corresponds '
'to the number of images from the tilt-series that the origin of the error function '
'will be displaced.')
groupAngle.addParam('c6param',
params.FloatParam,
default=0.0,
label='Random error sigma (c6)',
help='Sigma value for random error introduced in the angle. Angles are measured in '
'degrees.')
""" Options for misalignment interpolation"""
form.addParam('computeAlignment', params.EnumParam,
choices=['Yes', 'No'],
default=1,
label='Generate interpolated tilt-series',
important=True,
display=params.EnumParam.DISPLAY_HLIST,
help='Generate and save the interpolated tilt-series applying the'
'obtained transformation matrix.')
# -------------------------- INSERT steps functions ---------------------
def _insertAllSteps(self):
for ts in self.inputSetOfTiltSeries.get():
self._insertFunctionStep('introduceRandomMisalignment', ts.getObjId())
if self.computeAlignment.get() == 0:
self._insertFunctionStep('interpolateTiltSeries', ts.getObjId())
# --------------------------- STEPS functions ----------------------------
[docs] def introduceRandomMisalignment(self, tsObjId):
ts = self.inputSetOfTiltSeries.get()[tsObjId]
tsId = ts.getTsId()
outputMisalignedSetOfTiltSeries = self.getOutputMisalignedSetOfTiltSeries()
missAliTs = tomoObj.TiltSeries(tsId=tsId)
missAliTs.copyInfo(ts)
outputMisalignedSetOfTiltSeries.append(missAliTs)
for index, ti in enumerate(ts):
missAliTi = tomoObj.TiltImage()
missAliTi.copyInfo(ti, copyId=True)
missAliTi.setLocation(ti.getLocation())
if ti.hasTransform():
transformMat = ti.getTransform().getMatrix()
else:
transformMat = np.identity(3)
newTransformMat = self.modifyTransformMatrix(transformMat, index, ts.getSize(), tsId)
newTransform = data.Transform()
newTransform.setMatrix(newTransformMat)
missAliTi.setTransform(newTransform)
missAliTs.append(missAliTi)
missAliTs.write()
outputMisalignedSetOfTiltSeries.update(missAliTs)
outputMisalignedSetOfTiltSeries.write()
self._store()
[docs] def interpolateTiltSeries(self, tsObjId):
missAliTs = self.outputMisalignedSetOfTiltSeries[tsObjId]
tsId = missAliTs.getTsId()
outputInterpolatedSetOfTiltSeries = self.getOutputInterpolatedSetOfTiltSeries()
extraPrefix = self._getExtraPath(tsId)
outputTsFileName = os.path.join(extraPrefix, "%s_missAli.st" % tsId)
"""Apply the transformation form the input tilt-series"""
missAliTs.applyTransform(outputTsFileName)
missAliInterTs = tomoObj.TiltSeries(tsId=tsId)
missAliInterTs.copyInfo(missAliTs)
outputInterpolatedSetOfTiltSeries.append(missAliInterTs)
for index, tiltImage in enumerate(missAliTs):
missAliInterTi = tomoObj.TiltImage()
missAliInterTi.copyInfo(tiltImage, copyId=True)
missAliInterTi.setLocation(index + 1, outputTsFileName)
missAliInterTs.append(missAliInterTi)
missAliInterTs.write()
outputInterpolatedSetOfTiltSeries.update(missAliInterTs)
outputInterpolatedSetOfTiltSeries.write()
self._store()
# --------------------------- UTILS functions ----------------------------
[docs] def getOutputMisalignedSetOfTiltSeries(self):
if not hasattr(self, "outputMisalignedSetOfTiltSeries"):
outputMisalignedSetOfTiltSeries = self._createSetOfTiltSeries(suffix='Misaligned')
outputMisalignedSetOfTiltSeries.copyInfo(self.inputSetOfTiltSeries.get())
outputMisalignedSetOfTiltSeries.setDim(self.inputSetOfTiltSeries.get().getDim())
self._defineOutputs(outputMisalignedSetOfTiltSeries=outputMisalignedSetOfTiltSeries)
self._defineSourceRelation(self.inputSetOfTiltSeries, outputMisalignedSetOfTiltSeries)
return self.outputMisalignedSetOfTiltSeries
[docs] def getOutputInterpolatedSetOfTiltSeries(self):
if not hasattr(self, "outputInterpolatedSetOfTiltSeries"):
outputInterpolatedSetOfTiltSeries = self._createSetOfTiltSeries(suffix='Interpolated')
outputInterpolatedSetOfTiltSeries.copyInfo(self.inputSetOfTiltSeries.get())
outputInterpolatedSetOfTiltSeries.setDim(self.inputSetOfTiltSeries.get().getDim())
self._defineOutputs(outputInterpolatedSetOfTiltSeries=outputInterpolatedSetOfTiltSeries)
self._defineSourceRelation(self.inputSetOfTiltSeries, outputInterpolatedSetOfTiltSeries)
return self.outputInterpolatedSetOfTiltSeries
# --------------------------- INFO functions ----------------------------
def _summary(self):
summary = []
if not hasattr(self, 'outputInterpolatedSetOfTiltSeries'):
summary.append("Input Tilt-Series: %d.\nTransformation matrices calculated: %d.\n"
% (self.inputSetOfTiltSeries.get().getSize(),
self.outputMisalignedSetOfTiltSeries.getSize()))
elif hasattr(self, 'outputInterpolatedSetOfTiltSeries'):
summary.append("Input Tilt-Series: %d.\nTransformation matrices calculated: %d.\n"
"Interpolated Tilt-Series: %d.\n"
% (self.outputMisalignedSetOfTiltSeries.getSize(),
self.outputMisalignedSetOfTiltSeries.getSize(),
self.outputInterpolatedSetOfTiltSeries.getSize()))
else:
summary.append("Output classes not ready yet.")
return summary
def _methods(self):
methods = []
if not hasattr(self, 'outputInterpolatedSetOfTiltSeries'):
methods.append("New transformation matrices has been calculated for %d Tilt-series.\n"
% (self.outputMisalignedSetOfTiltSeries.getSize()))
elif hasattr(self, 'outputInterpolatedSetOfTiltSeries'):
methods.append("New transformation matrices has been calculated for %d Tilt-series.\n"
"Also, interpolation has been completed for %d Tilt-series.\n"
% (self.outputMisalignedSetOfTiltSeries.getSize(),
self.outputInterpolatedSetOfTiltSeries.getSize()))
else:
methods.append("Output classes not ready yet.")
return methods