This is a data holding class for POS file ions, from. More...

#include <ionHit.h>

Public Member Functions
	IonHit ()

	IonHit (float *)

	IonHit (const IonHit &)

	IonHit (const Point3D &p, float massToCharge)

	IonHit (float x, float y, float z, float mass)

void	setHit (float *arr)

void	setMassToCharge (float newMassToCharge)

void	setPos (const Point3D &pos)

void	setPos (unsigned int idx, float pos)

void	setPos (float fX, float fY, float fZ)

Point3D	getPos () const

const Point3D &	getPosRef () const

bool	hasNaN ()

float	getMassToCharge () const

const IonHit &	operator= (const IonHit &obj)

bool	operator== (const IonHit &obj) const

float	operator[] (unsigned int ui) const

float &	operator[] (unsigned int ui)

IonHit	operator+ (const Point3D &obj)

Static Public Member Functions
static void	getPoints (const std::vector< IonHit > &ions, std::vector< Point3D > &pts)

static void	getBoundCube (const std::vector< IonHit > &p, BoundCube &b)

static void	getCentroid (const std::vector< IonHit > &points, Point3D &centroid)

static BoundCube	getIonDataLimits (const std::vector< IonHit > &points)

Friends
std::ostream &	operator<< (std::ostream &stream, const IonHit &)
	Output streaming operator. Users (x,y,z,m) as format for output. More...

Detailed Description

This is a data holding class for POS file ions, from.

Definition at line 36 of file ionHit.h.

Constructor & Destructor Documentation

◆ IonHit() [1/5]

AtomProbe::IonHit::IonHit ( )

Definition at line 38 of file ionhit.cpp.

◆ IonHit() [2/5]

AtomProbe::IonHit::IonHit ( float * buffer )

Definition at line 44 of file ionhit.cpp.

◆ IonHit() [3/5]

AtomProbe::IonHit::IonHit ( const IonHit & obj2 )

Definition at line 52 of file ionhit.cpp.

◆ IonHit() [4/5]

AtomProbe::IonHit::IonHit	(	const Point3D &	p,
		float	massToCharge
	)

Definition at line 56 of file ionhit.cpp.

◆ IonHit() [5/5]

AtomProbe::IonHit::IonHit	(	float	x,
		float	y,
		float	z,
		float	mass
	)

Definition at line 48 of file ionhit.cpp.

Member Function Documentation

◆ getBoundCube()

void AtomProbe::IonHit::getBoundCube	(	const std::vector< IonHit > &	p,
		BoundCube &	b
	)

static

Definition at line 153 of file ionhit.cpp.

References ASSERT, AtomProbe::Point3D::getValue(), and AtomProbe::BoundCube::setBounds().

Referenced by getPosRef(), and AtomProbe::EPOS_ENTRY::operator==().

Here is the call graph for this function:

◆ getCentroid()

void AtomProbe::IonHit::getCentroid	(	const std::vector< IonHit > &	points,
		Point3D &	centroid
	)

static

Definition at line 128 of file ionhit.cpp.

References getPos().

Referenced by getPosRef().

Here is the call graph for this function:

◆ getIonDataLimits()

BoundCube AtomProbe::IonHit::getIonDataLimits ( const std::vector< IonHit > & points )

static

Definition at line 188 of file ionhit.cpp.

References ASSERT, AtomProbe::Point3D::getValue(), and AtomProbe::BoundCube::setInverseLimits().

Referenced by getPosRef(), and AtomProbe::K3DTreeExact::resetPts().

Here is the call graph for this function:

◆ getMassToCharge()

float AtomProbe::IonHit::getMassToCharge ( ) const

Definition at line 65 of file ionhit.cpp.

Referenced by AtomProbe::RangeFile::getIonID(), AtomProbe::RangeFile::getName(), getPosRef(), AtomProbe::MultiRange::isRanged(), AtomProbe::RangeFile::isRanged(), main(), and AtomProbe::operator<<().

◆ getPoints()

void AtomProbe::IonHit::getPoints	(	const std::vector< IonHit > &	ions,
		std::vector< Point3D > &	pts
	)

static

Definition at line 109 of file ionhit.cpp.

References getPosRef().

Referenced by getPosRef().

Here is the call graph for this function:

◆ getPos()

Point3D AtomProbe::IonHit::getPos ( ) const

Definition at line 117 of file ionhit.cpp.

Referenced by getCentroid(), main(), AtomProbe::operator<<(), and setPos().

◆ getPosRef()

const Point3D& AtomProbe::IonHit::getPosRef ( ) const

inline

Definition at line 65 of file ionHit.h.

References getBoundCube(), getCentroid(), getIonDataLimits(), getMassToCharge(), getPoints(), hasNaN(), operator+(), operator<<, operator=(), operator==(), and operator[]().

Referenced by getPoints().

Here is the call graph for this function:

◆ hasNaN()

bool AtomProbe::IonHit::hasNaN ( )

Definition at line 122 of file ionhit.cpp.

Referenced by getPosRef(), and AtomProbe::loadPosFile().

◆ operator+()

IonHit AtomProbe::IonHit::operator+ ( const Point3D & obj )

Definition at line 103 of file ionhit.cpp.

Referenced by getPosRef().

◆ operator=()

const IonHit & AtomProbe::IonHit::operator= ( const IonHit & obj )

Definition at line 90 of file ionhit.cpp.

Referenced by getPosRef().

◆ operator==()

bool AtomProbe::IonHit::operator== ( const IonHit & obj ) const

Definition at line 98 of file ionhit.cpp.

Referenced by AtomProbe::EPOS_ENTRY::getHitMultiplicity(), and getPosRef().

◆ operator[]() [1/2]

float AtomProbe::IonHit::operator[] ( unsigned int ui ) const

Definition at line 251 of file ionhit.cpp.

References ASSERT.

Referenced by getPosRef().

◆ operator[]() [2/2]

float & AtomProbe::IonHit::operator[] ( unsigned int ui )

Definition at line 260 of file ionhit.cpp.

References ASSERT.

◆ setHit()

void AtomProbe::IonHit::setHit ( float * arr )

inline

Definition at line 50 of file ionHit.h.

References setMassToCharge(), setPos(), and AtomProbe::Point3D::setValueArr().

Here is the call graph for this function:

◆ setMassToCharge()

void AtomProbe::IonHit::setMassToCharge ( float newMassToCharge )

Definition at line 60 of file ionhit.cpp.

Referenced by AtomProbe::FaceCentredCubicGen::generateLattice(), AtomProbe::BodyCentredCubicGen::generateLattice(), AtomProbe::loadPosFile(), AtomProbe::loadTapsimBinFile(), AtomProbe::EPOS_ENTRY::operator==(), and setHit().

◆ setPos() [1/3]

void AtomProbe::IonHit::setPos ( const Point3D & pos )

Definition at line 76 of file ionhit.cpp.

References floatSwapBytes().

Referenced by AtomProbe::SimpleCubicGen::generateLattice(), AtomProbe::FaceCentredCubicGen::generateLattice(), AtomProbe::BodyCentredCubicGen::generateLattice(), AtomProbe::loadPosFile(), AtomProbe::loadTapsimBinFile(), AtomProbe::EPOS_ENTRY::operator==(), and setHit().

Here is the call graph for this function:

◆ setPos() [2/3]

void AtomProbe::IonHit::setPos	(	unsigned int	idx,
		float	pos
	)

Definition at line 70 of file ionhit.cpp.

References ASSERT.

◆ setPos() [3/3]

void AtomProbe::IonHit::setPos	(	float	fX,
		float	fY,
		float	fZ
	)

inline

Definition at line 59 of file ionHit.h.

References getPos().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	stream,
		const IonHit &	ion
	)

friend

Output streaming operator. Users (x,y,z,m) as format for output.

Definition at line 181 of file ionhit.cpp.

Referenced by getPosRef().

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

include/atomprobe/primitives/ionHit.h
src/primitives/ionhit.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IonHit() [1/5]

◆ IonHit() [2/5]

◆ IonHit() [3/5]

◆ IonHit() [4/5]

◆ IonHit() [5/5]

Member Function Documentation

◆ getBoundCube()

◆ getCentroid()

◆ getIonDataLimits()

◆ getMassToCharge()

◆ getPoints()

◆ getPos()

◆ getPosRef()

◆ hasNaN()

◆ operator+()

◆ operator=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ setHit()

◆ setMassToCharge()

◆ setPos() [1/3]

◆ setPos() [2/3]

◆ setPos() [3/3]

Friends And Related Function Documentation

◆ operator<<