libatomprobe
Library for Atom Probe Tomography (APT) computation
Public Member Functions | List of all members
AtomProbe::ReconstructionSphereOnCone Class Reference

#include <reconstruction-simple.h>

Public Member Functions

 ReconstructionSphereOnCone ()
 Default constructor. More...
 
void setProjModel (AtomProbe::SphericPlaneProjection *model)
 Set a given projection model. More...
 
void setRadiusEvolutionMode (unsigned int evolutionMode)
 Set the method of evolution for the shank, as per EVOLUTION_MODE_ enum. More...
 
void setInitialRadius (float rInit)
 Set the initial tip radius. More...
 
void setShankAngle (float angle)
 Set initial angle, in radiians. More...
 
void setDetectorEfficiency (float detEff)
 Set detector efficiency in range (0,1]. More...
 
void setFlightPath (float detEff)
 Set flight path. Units must match detector units (eg mm) More...
 
void setReconFOV (float angle)
 Set the angle (between 0 and pi radiaans). This is. More...
 
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
 Using the current reconstruction model, reconstruct a detector sequence. More...
 

Detailed Description

Definition at line 35 of file reconstruction-simple.h.

Constructor & Destructor Documentation

◆ ReconstructionSphereOnCone()

AtomProbe::ReconstructionSphereOnCone::ReconstructionSphereOnCone ( )

Default constructor.

Definition at line 31 of file reconstruction-simple.cpp.

References AtomProbe::EVOLUTION_MODE_SHANKANGLE.

Member Function Documentation

◆ reconstruct()

bool AtomProbe::ReconstructionSphereOnCone::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

Using the current reconstruction model, reconstruct a detector sequence.

Uses the projection model given in ::setProjModel, to perform the reconstruction

  • This is a "shank" reconstruction
  • Detector sequence input should typically be centered around 0,0 - automatic recentring may not be desired, so this will not be performed
  • Sequence scale should match flight path (e.g. mm)
  • Ions may not be reconstructed if outside FOV, so |outputPts| < |detector events|

Definition at line 79 of file reconstruction-simple.cpp.

References ASSERT, AtomProbe::EVOLUTION_MODE_SHANKANGLE, AtomProbe::BoundCube::getSize(), AtomProbe::BoundCube::getVolume(), M_PI, reconstruct(), AtomProbe::reconstructTest(), AtomProbe::savePosFile(), AtomProbe::SphericPlaneProjection::scaleDown(), AtomProbe::BoundCube::setBounds(), setFlightPath(), setInitialRadius(), setProjModel(), setReconFOV(), setShankAngle(), TEST, AtomProbe::SphericPlaneProjection::thetaToEta(), and AtomProbe::SphericPlaneProjection::toAzimuthal().

Referenced by main(), and reconstruct().

Here is the call graph for this function:

◆ setDetectorEfficiency()

void AtomProbe::ReconstructionSphereOnCone::setDetectorEfficiency ( float  detEff)

Set detector efficiency in range (0,1].

Definition at line 48 of file reconstruction-simple.cpp.

References ASSERT.

Referenced by main().

◆ setFlightPath()

void AtomProbe::ReconstructionSphereOnCone::setFlightPath ( float  detEff)

Set flight path. Units must match detector units (eg mm)

Definition at line 54 of file reconstruction-simple.cpp.

References ASSERT.

Referenced by main(), and reconstruct().

◆ setInitialRadius()

void AtomProbe::ReconstructionSphereOnCone::setInitialRadius ( float  rInit)

Set the initial tip radius.

Definition at line 73 of file reconstruction-simple.cpp.

References ASSERT.

Referenced by main(), and reconstruct().

◆ setProjModel()

void AtomProbe::ReconstructionSphereOnCone::setProjModel ( AtomProbe::SphericPlaneProjection model)

Set a given projection model.

Definition at line 38 of file reconstruction-simple.cpp.

Referenced by main(), and reconstruct().

◆ setRadiusEvolutionMode()

void AtomProbe::ReconstructionSphereOnCone::setRadiusEvolutionMode ( unsigned int  evolutionMode)

Set the method of evolution for the shank, as per EVOLUTION_MODE_ enum.

Definition at line 43 of file reconstruction-simple.cpp.

◆ setReconFOV()

void AtomProbe::ReconstructionSphereOnCone::setReconFOV ( float  angle)

Set the angle (between 0 and pi radiaans). This is.

Definition at line 60 of file reconstruction-simple.cpp.

References ASSERT, and M_PI.

Referenced by main(), and reconstruct().

◆ setShankAngle()

void AtomProbe::ReconstructionSphereOnCone::setShankAngle ( float  angle)

Set initial angle, in radiians.

Definition at line 66 of file reconstruction-simple.cpp.

References ASSERT, and M_PI.

Referenced by main(), and reconstruct().


The documentation for this class was generated from the following files: