reconstruction-simple.h

Go to the documentation of this file.

/* reconstruction-simple.h : Sphere-on-cone reconstruction model 
 * Copyright (C) 2017  Daniel Haley
 * 
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef ATOMPROBE_RECONSTRUCT_SIMPLE_H
#define ATOMPROBE_RECONSTRUCT_SIMPLE_H

#include "atomprobe/primitives/point3D.h"
#include "atomprobe/primitives/ionHit.h"
#include "atomprobe/projection/projection.h"

#include <vector>

namespace AtomProbe{

//enum that states supported shank evolution mode
enum
{
    EVOLUTION_MODE_SHANKANGLE,
};

//Convert a 2D series of detector positions to a 3D reconstructed point cloud
class ReconstructionSphereOnCone
{
    private:
        //The plane projection model (converts detector coordinates to angular ones)
                AtomProbe::SphericPlaneProjection *projectionModel;

        unsigned int evolutionMode;
    
        // can be between 0 and M_PI    
        float reconFOV;
    
        float initialRadius;

        float flightPath;
        
        float shankAngle;
        
        float detEfficiency;    
    public:
        ReconstructionSphereOnCone(); 

        void setProjModel(AtomProbe::SphericPlaneProjection *model);

        void setRadiusEvolutionMode(unsigned int evolutionMode);

        void setInitialRadius(float rInit);

        void setShankAngle(float angle);
        
        void setDetectorEfficiency(float detEff);
        
        void setFlightPath(float detEff);

        // the angle between +Z and the maximum detectable point
        // on a circle 
        void setReconFOV(float angle);


        bool reconstruct(const std::vector<float> &detectorX, 
                const std::vector<float> &detectorY,
                const std::vector<float> &timeOfFlight,
                const std::vector<float> &ionVolume,
                std::vector<IonHit> &outputPts) const ;

};


//Run the unit tests for this module
bool reconstructTest();


}

#endif