Mantid::Algorithms::WeightingStrategy Class Reference

WeightingStrategy : More...

#include <WeightingStrategy.h>

Inheritance diagram for Mantid::Algorithms::WeightingStrategy:

Public Member Functions
virtual double	weightAt (const double &adjX, const double &ix, const double &adjY, const double &iy)=0
	Calculate the weight at distance from epicenter. More...
virtual double	weightAt (const Mantid::Kernel::V3D &distance)=0
	Calculate the weight at distance from epicenter. More...
	WeightingStrategy ()
	Constructor. More...
	WeightingStrategy (const double cutOff)
	Constructor. More...
virtual	~WeightingStrategy ()=default
	Destructor. More...

Protected Attributes
double	m_cutOff
	Cutoff member. More...

Detailed Description

WeightingStrategy :

Abstract weighting strategy, which can be applied to calculate individual weights for each pixel based upon disance from epicenter. Generated for use with SmoothNeighbours.

Date

2011-11-30

Definition at line 23 of file WeightingStrategy.h.

Constructor & Destructor Documentation

WeightingStrategy() [1/2]

Mantid::Algorithms::WeightingStrategy::WeightingStrategy

(

const double

cutOff

)

Constructor.

Parameters

cutOff

: radius cutoff

Definition at line 23 of file WeightingStrategy.cpp.

WeightingStrategy() [2/2]

Mantid::Algorithms::WeightingStrategy::WeightingStrategy

(

)

Constructor.

Definition at line 26 of file WeightingStrategy.cpp.

~WeightingStrategy()

virtual Mantid::Algorithms::WeightingStrategy::~WeightingStrategy ( )

virtualdefault

Destructor.

Member Function Documentation

weightAt() [1/2]

virtual double Mantid::Algorithms::WeightingStrategy::weightAt ( const double &  adjX, const double &  ix, const double &  adjY, const double &  iy  )

pure virtual

Calculate the weight at distance from epicenter.

Parameters

adjX	: The number of Y (vertical) adjacent pixels to average together
ix	: current index x
adjY	: The number of X (vertical) adjacent pixels to average together
iy	: current index y

Implemented in Mantid::Algorithms::FlatWeighting, Mantid::Algorithms::NullWeighting, Mantid::Algorithms::GaussianWeightingnD, Mantid::Algorithms::LinearWeighting, and Mantid::Algorithms::ParabolicWeighting.

weightAt() [2/2]

virtual double Mantid::Algorithms::WeightingStrategy::weightAt ( const Mantid::Kernel::V3D &  distance )

pure virtual

Calculate the weight at distance from epicenter.

Parameters

distance

: difference between the central detector location and the nearest neighbour

Returns

calculated weight

Implemented in Mantid::Algorithms::FlatWeighting, Mantid::Algorithms::LinearWeighting, Mantid::Algorithms::ParabolicWeighting, Mantid::Algorithms::NullWeighting, and Mantid::Algorithms::GaussianWeightingnD.

Member Data Documentation

m_cutOff

double Mantid::Algorithms::WeightingStrategy::m_cutOff

protected

Cutoff member.

Definition at line 50 of file WeightingStrategy.h.

Referenced by Mantid::Algorithms::LinearWeighting::weightAt(), Mantid::Algorithms::ParabolicWeighting::weightAt(), and Mantid::Algorithms::GaussianWeightingnD::weightAt().

---

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

• Framework/Algorithms/inc/MantidAlgorithms/WeightingStrategy.h
• Framework/Algorithms/src/WeightingStrategy.cpp