parallel_forward_art_zernike3d.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Authors:    David Herreros Calero dherreros@cnb.csic.es
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * 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 'xmipp@cnb.csic.es'
 ***************************************************************************/


#ifndef _PROG_PARALLEL_FORWARD_ART_ZERNIKE3D
#define _PROG_PARALLEL_FORWARD_ART_ZERNIKE3D

#include <core/xmipp_metadata_program.h>
#include <core/matrix1d.h>
#include <core/xmipp_image.h>
#include <data/fourier_filter.h>
#include <data/fourier_projection.h>
#include <core/xmipp_error.h>
#include <data/blobs.h>
#include <CTPL/ctpl_stl.h>
// #include <atomic>


class ProgParallelForwardArtZernike3D: public XmippMetadataProgram
{
public:
    FileName fnVolR;
    FileName fnMaskRF, fnMaskRB;
    FileName fnVolO;
    FileName fnOutDir;
    int L1, L2;
    Matrix1D<int> vL1, vN, vL2, vM;
    double Ts;
    int RmaxDef;
    // Phase Flipped
    bool phaseFlipped;
    // Ignore CTF
    bool ignoreCTF;
    // Regularization ART
    double lambda;
    // Save each # iter
    int save_iter;
    // Correct CTF
    bool useCTF;
    // Apply Zernike
    bool useZernike;
    // Flag for enable/disabled image
    int flagEnabled;

public:
    bool resume;
    // Number of ART iterations
    int niter;
    // Sort last N projections
    int sort_last_N;
    // 2D and 3D masks in real space
    MultidimArray<int> mask2D;
    // Volume size
    size_t Xdim;
    // Input image
    Image<double> V, Vrefined, Vout, Ifilteredp;
    // INput image
    Image<double> I;
    // Spherical mask
    MultidimArray<int> VRecMaskF, VRecMaskB;
    // Theoretical projection
    std::vector<Image<double>> P;
    // Weight Image
    std::vector<Image<double>> W;
    // Atomic mutex
    std::vector<std::unique_ptr<std::atomic<double*>>> p_busy_elem;
    std::vector<std::unique_ptr<std::atomic<double*>>> w_busy_elem;
    // std::atomic<double*> v_busy_elem{ nullptr };
    // Difference Image
    Image<double> Idiff;
    // Transformation matrix
    Matrix2D<double> A;
    // Original angles
    double rot, tilt, psi;
    // Original shift
    double shiftX, shiftY;
    // Original flip
    bool flip;
    // CTF Check
    bool hasCTF;
    // Original defocus
    double defocusU, defocusV, defocusAngle;
    // CTF
    CTFDescription ctf;
    // CTF filter
    FourierFilter FilterCTF;
    // Vector Size
    int vecSize;
    // Vector containing the degree of the spherical harmonics
    std::vector<double> clnm;
    // Show optimization
    bool showOptimization;
    // Row ids ordered in a orthogonal fashion
    MultidimArray<size_t> ordered_list;
    // Save iter counter
    int current_save_iter;
    // Image counter
    size_t num_images, current_image;
    // Current ART iteration
    int current_iter;
    // Volume dimensions
    int initX, endX, initY, endY, initZ, endZ;
    // Loop step
    int loop_step;
    // Sigma
    std::vector<double> sigma;

    // Filter
    FourierFilter filter, filter2;

    // Parallelization
    ctpl::thread_pool m_threadPool;
    int threads;

public:
    enum class Mode { Proj, Vol };

    ProgParallelForwardArtZernike3D();

    ~ProgParallelForwardArtZernike3D();

    void readParams();

    void show();

    void defineParams();

    void preProcess();

    void processImage(const FileName &fnImg, const FileName &fnImgOut, const MDRow &rowIn, MDRow &rowOut);

    void numCoefficients(int l1, int l2, int &vecSize);

    void fillVectorTerms(int l1, int l2, Matrix1D<int> &vL1, Matrix1D<int> &vN, 
                         Matrix1D<int> &vL2, Matrix1D<int> &vM);

    void deformVol(MultidimArray<double> &mP, MultidimArray<double> &mW,
                   const MultidimArray<double> &mV,
                   double rot, double tilt, double psi);
    
    void recoverVol();
    virtual void finishProcessing();

  private:
    enum class Direction { Forward, Backward };

    // ART algorithm
    template <Direction DIRECTION>
    void artModel();

    // Apply Zernike codeformation
    template<bool USESZERNIKE, Direction DIRECTION>
    void zernikeModel();

    // Spaltting at position r
    void splattingAtPos(std::array<double, 2> r, double weight, 
                        MultidimArray<double> &mP, MultidimArray<double> &mW, 
                        MultidimArray<double> &mV, double &sg);

    virtual void run();

    // Sort images in an orthogonal fashion
    void sortOrthogonal();

    void forwardModel(int k, bool usesZernike);
    void backwardModel(int k, bool usesZernike);

};
#endif