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

Node Class for storing point. More...

#include <K3DTree-approx.h>

Public Member Functions

Point3D getLoc () const
 Return the point data from the ndoe. More...
 
const Point3DgetLocRef () const
 Return a pointer to the point from the node. More...
 
void setLeft (K3DNodeApprox *node)
 Set the left child node. More...
 
void setRight (K3DNodeApprox *node)
 Set the right child node. More...
 
void setLoc (const Point3D &)
 Set the point data associated with this node. More...
 
void setAxis (unsigned int newAxis)
 Set the axis that this node operates on. More...
 
unsigned int getAxis () const
 Retrieve the axis that this node operates on. More...
 
float getAxisVal () const
 retrieve the value associated with this axis More...
 
float getLocVal (unsigned int pos) const
 Obtain the coordinates at dimension "pos". More...
 
float sqrDist (const Point3D &pt) const
 Obtain the distance between this node and another point. More...
 
K3DNodeApproxleft () const
 Obtain pointer to left child. More...
 
K3DNodeApproxright () const
 Obtain pointer to right child. More...
 
void deleteChildren ()
 Recursively delete this node and all children. More...
 
void dump (std::ostream &, unsigned int) const
 print the node data out to a given stream More...
 

Detailed Description

Node Class for storing point.

Definition at line 53 of file K3DTree-approx.h.

Member Function Documentation

◆ deleteChildren()

void AtomProbe::K3DNodeApprox::deleteChildren ( )

Recursively delete this node and all children.

Definition at line 63 of file K3DTree-approx.cpp.

Referenced by AtomProbe::K3DTreeApprox::kill().

◆ dump()

void AtomProbe::K3DNodeApprox::dump ( std::ostream &  strm,
unsigned int  depth 
) const

print the node data out to a given stream

Definition at line 83 of file K3DTree-approx.cpp.

Referenced by AtomProbe::K3DTreeApprox::dump().

◆ getAxis()

unsigned int AtomProbe::K3DNodeApprox::getAxis ( ) const
inline

Retrieve the axis that this node operates on.

Definition at line 79 of file K3DTree-approx.h.

◆ getAxisVal()

float AtomProbe::K3DNodeApprox::getAxisVal ( ) const
inline

retrieve the value associated with this axis

Definition at line 81 of file K3DTree-approx.h.

References AtomProbe::Point3D::getValue().

Here is the call graph for this function:

◆ getLoc()

Point3D AtomProbe::K3DNodeApprox::getLoc ( ) const

Return the point data from the ndoe.

Definition at line 58 of file K3DTree-approx.cpp.

◆ getLocRef()

const Point3D* AtomProbe::K3DNodeApprox::getLocRef ( ) const
inline

Return a pointer to the point from the node.

Definition at line 68 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::findNearest().

◆ getLocVal()

float AtomProbe::K3DNodeApprox::getLocVal ( unsigned int  pos) const
inline

Obtain the coordinates at dimension "pos".

Definition at line 83 of file K3DTree-approx.h.

References AtomProbe::Point3D::getValue().

Referenced by AtomProbe::K3DTreeApprox::findNearest().

Here is the call graph for this function:

◆ left()

K3DNodeApprox* AtomProbe::K3DNodeApprox::left ( ) const
inline

Obtain pointer to left child.

Definition at line 87 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::findNearest().

◆ right()

K3DNodeApprox* AtomProbe::K3DNodeApprox::right ( ) const
inline

Obtain pointer to right child.

Definition at line 89 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::findNearest().

◆ setAxis()

void AtomProbe::K3DNodeApprox::setAxis ( unsigned int  newAxis)
inline

Set the axis that this node operates on.

Definition at line 77 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::buildByRef().

◆ setLeft()

void AtomProbe::K3DNodeApprox::setLeft ( K3DNodeApprox node)
inline

Set the left child node.

Definition at line 70 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::buildByRef().

◆ setLoc()

void AtomProbe::K3DNodeApprox::setLoc ( const Point3D locNew)

Set the point data associated with this node.

Definition at line 53 of file K3DTree-approx.cpp.

Referenced by AtomProbe::K3DTreeApprox::buildByRef().

◆ setRight()

void AtomProbe::K3DNodeApprox::setRight ( K3DNodeApprox node)
inline

Set the right child node.

Definition at line 72 of file K3DTree-approx.h.

Referenced by AtomProbe::K3DTreeApprox::buildByRef().

◆ sqrDist()

float AtomProbe::K3DNodeApprox::sqrDist ( const Point3D pt) const
inline

Obtain the distance between this node and another point.

Definition at line 85 of file K3DTree-approx.h.

References AtomProbe::Point3D::sqrDist().

Referenced by AtomProbe::K3DTreeApprox::findNearest().

Here is the call graph for this function:

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