Skip to content

Commit

Permalink
refs #10384 fixing GCC warning and optimizing memory usage
Browse files Browse the repository at this point in the history 
by taking unit conversion allocator out of the loop.
  • Loading branch information
@abuts
abuts committed Oct 30, 2014
1 parent 3795090 commit 9d171c9
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 19 deletions.
17 changes: 10 additions & 7 deletions Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/BackgroundHelper.h
View file
Expand Up @@ -43,15 +43,16 @@ namespace Algorithms
{
public:
BackgroundHelper();
void initialize(const API::MatrixWorkspace_const_sptr &bkgWS,const API::MatrixWorkspace_sptr &sourceWS,int emode);
~BackgroundHelper();
void initialize(const API::MatrixWorkspace_const_sptr &bkgWS,const API::MatrixWorkspace_sptr &sourceWS,int emode,int nTreads=1);

void removeBackground(int hist,const MantidVec &XValues,MantidVec &y_data,MantidVec &e_data)const;
void removeBackground(int hist,const MantidVec &XValues,MantidVec &y_data,MantidVec &e_data,int tread_num=0)const;

//returns the list of the failing detectors
std::list<int> & getFailingSpectrsList()const{return FailingSpectraList;}
private:
// pointer to the units conversion class for the working workspace;
Kernel::Unit_sptr m_WSUnit;
//vector of pointers to the units conversion class for the working workspace;
std::vector<Kernel::Unit *> m_WSUnit;

// shared pointer to the workspace containing background
API::MatrixWorkspace_const_sptr m_bgWs;
Expand All @@ -74,12 +75,14 @@ namespace Algorithms
double m_Efix;
// shared pointer to the sample
Geometry::IComponent_const_sptr m_Sample;
// get Ei attached to direct or indirect instrument workspace
double getEi(const API::MatrixWorkspace_const_sptr &inputWS)const;


// list of the spectra numbers for which detectors retrieval has been unsuccessful
mutable std::list<int> FailingSpectraList;

// get Ei attached to direct or indirect instrument workspace
double getEi(const API::MatrixWorkspace_const_sptr &inputWS)const;
// the procedure user to delete existing unit converter pointers
void deleteUnitsConverters();
};

}
Expand Down
47 changes: 38 additions & 9 deletions Code/Mantid/Framework/Algorithms/src/BackgroundHelper.cpp
View file
Expand Up @@ -8,36 +8,57 @@ namespace Mantid

/// Constructor
BackgroundHelper::BackgroundHelper():
m_WSUnit(),m_bgWs(),m_wkWS(),
m_WSUnit(),
m_bgWs(),m_wkWS(),
m_singleValueBackground(false),
m_NBg(0),m_dtBg(1), //m_ErrSq(0),
m_Emode(0),
m_L1(0),m_Efix(0),
m_Sample(),
FailingSpectraList()
{};
BackgroundHelper::~BackgroundHelper()
{
this->deleteUnitsConverters();
}

/** The method deletes all units converter allocated*/
void BackgroundHelper::deleteUnitsConverters()
{
for(size_t i=0;i<m_WSUnit.size();i++)
{
if(m_WSUnit[i])
{
delete m_WSUnit[i];
m_WSUnit[i]=NULL;
}
}

}

/** Initialization method:
@param bkgWS -- shared pointer to the workspace which contains background
@param sourceWS -- shared pointer to the workspace to remove background from
@param emode -- energy conversion mode used during internal units conversion (0 -- elastic, 1-direct, 2 indirect, as defined in
@param emode -- energy conversion mode used during internal units conversion (0 -- elastic, 1-direct, 2 indirect, as defined in Units conversion
@param nThreads -- number of threads to be used for background removal
*/
void BackgroundHelper::initialize(const API::MatrixWorkspace_const_sptr &bkgWS,const API::MatrixWorkspace_sptr &sourceWS,int emode)
void BackgroundHelper::initialize(const API::MatrixWorkspace_const_sptr &bkgWS,const API::MatrixWorkspace_sptr &sourceWS,int emode,int nThreads)
{
m_bgWs = bkgWS;
m_wkWS = sourceWS;
m_Emode = emode;
FailingSpectraList.clear();


std::string bgUnits = bkgWS->getAxis(0)->unit()->unitID();
if(bgUnits!="TOF")
throw std::invalid_argument(" Background Workspace: "+bkgWS->getName()+" should be in the units of TOF");

if(!(bkgWS->getNumberHistograms() == 1 || sourceWS->getNumberHistograms()==bkgWS->getNumberHistograms()))
throw std::invalid_argument(" Background Workspace: "+bkgWS->getName()+" should have the same number of spectra as source workspace or be a single histogram workspace");

m_WSUnit = sourceWS->getAxis(0)->unit();
if(!m_WSUnit)
auto WSUnit = sourceWS->getAxis(0)->unit();
if(!WSUnit)
throw std::invalid_argument(" Source Workspace: "+sourceWS->getName()+" should have units");

Geometry::IComponent_const_sptr source = sourceWS->getInstrument()->getSource();
Expand All @@ -46,6 +67,14 @@ namespace Mantid
throw std::invalid_argument("Instrument on Source workspace:"+sourceWS->getName()+"is not sufficiently defined: failed to get source and/or sample");
m_L1 = source->getDistance(*m_Sample);

// just in case.
this->deleteUnitsConverters();
// allocate the array of units converters to avoid units reallocation within a loop
m_WSUnit.assign(nThreads,NULL);
for(int i=0;i<nThreads;i++)
{
m_WSUnit[i]=WSUnit->clone();
}

m_singleValueBackground = false;
if(bkgWS->getNumberHistograms()==0)
Expand All @@ -65,8 +94,9 @@ namespace Mantid
* @param XValues -- the spectra x-values (presumably not in TOF units)
* @param y_data -- the spectra signal
* @param e_data -- the spectra errors
* @param threadNum--number of thread doing conversion
*/
void BackgroundHelper::removeBackground(int nHist,const MantidVec &XValues,MantidVec &y_data,MantidVec &e_data)const
void BackgroundHelper::removeBackground(int nHist,const MantidVec &XValues,MantidVec &y_data,MantidVec &e_data,int threadNum)const
{

double dtBg,IBg;
Expand All @@ -85,7 +115,7 @@ namespace Mantid
IBg = dataY[0];
//ErrSq= dataE[0]*dataE[0]; // Needs further clarification
}
Kernel::Unit * unitConv;

try
{
auto detector = m_wkWS->getDetector(nHist);
Expand All @@ -94,7 +124,7 @@ namespace Mantid
double L2 = detector->getDistance(*m_Sample);
double delta(std::numeric_limits<double>::quiet_NaN());
// clone unit conversion to avoid multithreading issues
unitConv = m_WSUnit->clone();
Kernel::Unit * unitConv = m_WSUnit[threadNum];
unitConv->initialize(m_L1, L2,twoTheta, m_Emode, m_Efix,delta);
double tof1 = unitConv->singleToTOF(XValues[0]);
for(size_t i=0;i<y_data.size();i++)
Expand All @@ -115,7 +145,6 @@ namespace Mantid
// no background removal for this spectra as it does not have a detector or other reason; How should it be reported?
FailingSpectraList.push_front(nHist);
}
delete unitConv;

}
/** Method returns the efixed or Ei value stored in properties of the input workspace.
Expand Down
11 changes: 8 additions & 3 deletions Code/Mantid/Framework/Algorithms/src/Rebin.cpp
View file
Expand Up @@ -152,7 +152,10 @@ namespace Mantid
API::MatrixWorkspace_const_sptr bkgWS = checkRemoveBackgroundParameters(inputWS,eMode,PreserveEvents);
const bool remove_background = bool(bkgWS);
if(remove_background)
m_BackgroundHelper.initialize(bkgWS,inputWS,eMode);
{
int nThreads = omp_get_max_threads();
m_BackgroundHelper.initialize(bkgWS,inputWS,eMode,nThreads);
}
//-------------------------------------------------------

bool fullBinsOnly = getProperty("FullBinsOnly");
Expand Down Expand Up @@ -227,7 +230,8 @@ namespace Mantid
el.generateHistogram(*XValues_new, y_data, e_data);
if(remove_background)
{
m_BackgroundHelper.removeBackground(i,*XValues_new,y_data,e_data);
int id = omp_get_thread_num();
m_BackgroundHelper.removeBackground(i,*XValues_new,y_data,e_data,id);
}


Expand Down Expand Up @@ -304,7 +308,8 @@ namespace Mantid
VectorHelper::rebin(XValues,YValues,YErrors,*XValues_new,YValues_new,YErrors_new, dist);
if(remove_background)
{
m_BackgroundHelper.removeBackground(hist,*XValues_new,YValues_new,YErrors_new);
int id = omp_get_thread_num();
m_BackgroundHelper.removeBackground(hist,*XValues_new,YValues_new,YErrors_new,id);
}
} catch (std::exception& ex)
{
Expand Down

0 comments on commit 9d171c9

Please sign in to comment.