reconstructor_tools.h

Go to the documentation of this file.

/*
 * Author: David Woolford, 07/25/2007 (woolford@bcm.edu)
 * Copyright (c) 2000-2007 Baylor College of Medicine
 *
 * This software is issued under a joint BSD/GNU license. You may use the
 * source code in this file under either license. However, note that the
 * complete EMAN2 and SPARX software packages have some GPL dependencies,
 * so you are responsible for compliance with the licenses of these packages
 * if you opt to use BSD licensing. The warranty disclaimer below holds
 * in either instance.
 *
 * This complete copyright notice must be included in any revised version of the
 * source code. Additional authorship citations may be added, but existing
 * author citations must be preserved.
 *
 * 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
 *
 * */
//#define RECONDEBUG            // This is used to add some data objects for debugging reconstructors, it should normally be commented out!
 
#ifndef eman_reconstructor_toosl_h__
#define eman_reconstructor_tools_h__ 1
 
#include "emdata.h"
#include "interp.h"
 
#include <string>
using std::string;
 
#include <cstdlib>
 
//debug
#include <iostream>
using std::cout;
using std::endl;
 
 
namespace EMAN
{
 
        class FourierPixelInserter3D : public FactoryBase
        {
                public:
                FourierPixelInserter3D() : norm(0), data(0), nx(0), ny(0), nz(0), nxyz(0)
                {}
 
                virtual ~FourierPixelInserter3D()
                {
                        free_memory();
                }
 
                TypeDict get_param_types() const
                {
                        TypeDict d;
                        d.put("data", EMObject::EMDATA);
                        d.put("norm", EMObject::FLOAT_POINTER);
                        return d;
                }
 
                virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0) = 0;
 
 
                virtual void init();
 
#ifdef RECONDEBUG
                double *ddata;
                double *dnorm;
#endif
 
                protected:
                        float * norm;
                        EMData * data;
 
                        int nx, ny, nz,nxyz;
                        int nx2,ny2,nz2;
                        int subx0,suby0,subz0,fullnx,fullny,fullnz;
 
                private:
                // Disallow copy and assignment by default
                        FourierPixelInserter3D( const FourierPixelInserter3D& );
                        FourierPixelInserter3D& operator=( const FourierPixelInserter3D& );
 
                        void free_memory()
                        {
                        }
        };
 
        class FourierInserter3DMode1 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode1() {}
                        virtual ~FourierInserter3DMode1() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode1();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion using nearest neighbor";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode1( const FourierInserter3DMode1& );
                        FourierInserter3DMode1& operator=( const FourierInserter3DMode1& );
        };
 
        class FourierInserter3DMode2 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode2() {}
                        virtual ~FourierInserter3DMode2() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode2();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion using interpolation and the nearest 8 voxels";
                        }
 
                        static const string NAME;
 
                // Disallow copy and assignment by default
                        FourierInserter3DMode2( const FourierInserter3DMode2& );
                        FourierInserter3DMode2& operator=( const FourierInserter3DMode2& );
        };
 
        class FourierInserter3DMode2l : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode2l() {}
                        virtual ~FourierInserter3DMode2l() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode2l();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion 2x2x2 with trilinear interpolation";
                        }
 
                        static const string NAME;
 
                // Disallow copy and assignment by default
                        FourierInserter3DMode2l( const FourierInserter3DMode2l& );
                        FourierInserter3DMode2l& operator=( const FourierInserter3DMode2l& );
        };
 
        
        class FourierInserter3DMode3 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode3() {}
                        virtual ~FourierInserter3DMode3() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode3();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion using a 3x3x3 Gaussian kernel";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode3( const FourierInserter3DMode3& );
                        FourierInserter3DMode3& operator=( const FourierInserter3DMode3& );
        };
 
        class FourierInserter3DMode5 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode5()
                        {
//                              gimx = EMAN::Interp::get_gimx();
                        }
 
                        virtual ~FourierInserter3DMode5()
                        {
                                // Don't delete gimx it causes a seg fault
//                              if ( gimx != 0 )
//                              {
//                                      delete gimx;
//                                      gimx = 0;
//                              }
                        }
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode5();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion mode 5";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode5( const FourierInserter3DMode5& );
                        FourierInserter3DMode5& operator=( const FourierInserter3DMode5& );
 
//                      float * gimx;
        };
 
        class FourierInserter3DMode6 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode6() {}
                        virtual ~FourierInserter3DMode6() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode6();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "More exact version of gauss_5";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode6( const FourierInserter3DMode6& );
                        FourierInserter3DMode6& operator=( const FourierInserter3DMode6& );
        };
 
        class FourierInserter3DMode7 : public FourierPixelInserter3D
        {
 
        public:
                        static const float kernel[9][9][9];
                        
                        FourierInserter3DMode7() {}
                        virtual ~FourierInserter3DMode7() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode7();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "5x5x5 gridding kernel with numerically computed kernel";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode7( const FourierInserter3DMode7& );
                        FourierInserter3DMode7& operator=( const FourierInserter3DMode7& );
        };
        
 
        class FourierInserter3DMode8 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode8() : W(0)
                        {
 
                        }
                        virtual ~FourierInserter3DMode8()
                        {
                                if ( W != 0 )
                                        delete [] W;
                        }
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode8();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Fourier pixel insertion mode 8";
                        }
 
                        virtual void init();
 
                        static const string NAME;
 
                private:
                        int mFreqCutoff;
                        float mDFreq;
                // Disallow copy and assignment by default
                        FourierInserter3DMode8( const FourierInserter3DMode8& );
                        FourierInserter3DMode8& operator=( const FourierInserter3DMode8& );
 
                        float* W;
        };
 
        class FourierInserter3DMode9 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode9() {}
                        virtual ~FourierInserter3DMode9() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode9();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "Kaiser-bessel (KB) kernel 4x4x4";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode9( const FourierInserter3DMode9& );
                        FourierInserter3DMode9& operator=( const FourierInserter3DMode9& );
        };
 
        class FourierInserter3DMode10 : public FourierPixelInserter3D
        {
                public:
                        FourierInserter3DMode10() {}
                        virtual ~FourierInserter3DMode10() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode10();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "(imprecise) Kaiser-bessel derived (KBD) kernel 8x8x8";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode10( const FourierInserter3DMode10& );
                        FourierInserter3DMode10& operator=( const FourierInserter3DMode10& );
        };
 
        // Factory for FourierPixelInserter3D
        template <> Factory < FourierPixelInserter3D >::Factory();
 
        class FourierInserter3DMode11 : public FourierPixelInserter3D
        {
 
        public:
                        static const float kernel[12][12][12];
                        
                        FourierInserter3DMode11() {}
                        virtual ~FourierInserter3DMode11() {}
 
                        virtual bool insert_pixel(const float& xx, const float& yy, const float& zz, const std::complex<float> dt, const float& weight=1.0);
 
                        static FourierPixelInserter3D *NEW()
                        {
                                return new FourierInserter3DMode11();
                        }
 
                        virtual string get_name() const
                        {
                                return NAME;
                        }
 
                        virtual string get_desc() const
                        {
                                return "7x7x7 gridding kernel with numerically computed kernel";
                        }
 
                        static const string NAME;
 
                private:
                // Disallow copy and assignment by default
                        FourierInserter3DMode11( const FourierInserter3DMode11& );
                        FourierInserter3DMode11& operator=( const FourierInserter3DMode11& );
        };
 
} // namespace EMAN
 
#endif // eman_reconstructor_tools_h__