Skip to content

Commit

Permalink
refs #6449 Doxygen and minor stylistic changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
abuts committed Apr 16, 2013
1 parent 17f5ff5 commit 0378210
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 43 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,7 @@ namespace MDEvents
void addEvent(const MDE & event);
void addEventUnsafe(const MDE & event);
void addAndTraceEvent(const MDE & point,size_t index);
// unhide MDBoxBase methods
virtual size_t addEvents(const std::vector<MDE> & events);
virtual size_t addEventsUnsafe(const std::vector<MDE> & events);



/*---------------> EVENTS from event data <-------------------------------------------------------------*/
virtual void buildAndAddEvent(const signal_t Signal,const signal_t errorSq,const std::vector<coord_t> &point, uint16_t runIndex,uint32_t detectorId);
Expand Down
6 changes: 3 additions & 3 deletions Code/Mantid/Framework/MDEvents/src/MDEventWorkspace.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -640,9 +640,9 @@ namespace MDEvents
// /** Add a large number of events to this MDEventWorkspace.
// * This will use a ThreadPool/OpenMP to allocate events in parallel.
// *
// * @param events :: vector of events to be copied.
// * @param prog :: optional Progress object to report progress back to GUI/algorithms.
// * @return the number of events that were rejected (because of being out of bounds)
// * param events :: vector of events to be copied.
// * param prog :: optional Progress object to report progress back to GUI/algorithms.
// * return the number of events that were rejected (because of being out of bounds)
// */
// TMDE(
// void MDEventWorkspace)::addManyEvents(const std::vector<MDE> & events, Mantid::Kernel::ProgressBase * prog)
Expand Down
22 changes: 3 additions & 19 deletions Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,10 @@ namespace Mantid
namespace MDEvents
{

////===============================================================================================
////===============================================================================================
////-----------------------------------------------------------------------------------------------
///** Empty constructor. Used when loading from NXS files.
// * */
//TMDE(MDGridBox)::MDGridBox()
// : MDBoxBase<MDE, nd>(), numBoxes(0), nPoints(0)
//{
//}
template<typename MDE,size_t nd>
size_t MDGridBox<MDE,nd>::addEvents(const std::vector<MDE> & events)
{
return MDBoxBase<MDE,nd>::addEvents(events);
}
template<typename MDE,size_t nd>
size_t MDGridBox<MDE,nd>::addEventsUnsafe(const std::vector<MDE> & events)
{
return MDBoxBase<MDE,nd>::addEventsUnsafe( events);
}
////===============================================================================================
////===============================================================================================


//-----------------------------------------------------------------------------------------------
/** Constructor with a box controller.
* @param bc :: poineter to the BoxController, owned by workspace
Expand Down
30 changes: 16 additions & 14 deletions Code/Mantid/Framework/MDEvents/src/MDTransfModQ.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,27 @@ namespace Mantid


/**Convert single point of matrix workspace into reciprocal space and (optionally) modify signal and error
as function of reciprocal space (e.g. Lorents corrections)
@param x -- the x-coordinate of matix workspace. Often can be a time of flight though the unit conversion is availible
@param Coord -- converted MD coordinates of the point x calculated for particular workspace position (detector)
as function of reciprocal space (e.g. Lorents corrections)
@param x -- the x-coordinate of matix workspace. Often can be a time of flight though the unit conversion is availible
@param Coord -- converted MD coordinates of the point x calculated for particular workspace position (detector)
@param signal -- the signal in the point
@param error -- the signal in the point
no signal or error transformation is performed by this particular method.
@param signal -- the signal in the point
@param ErrSq -- the signal in the point
No signal or error transformation is performed by this particular method.
@return Coord -- the calculated coordinate of the point in the reciprocal space.
@return Coord -- the calculated coordinate of the point in the reciprocal space.
*/
bool MDTransfModQ::calcMatrixCoord(const double& x,std::vector<coord_t> &Coord, double & /*signal*/,double &/*ErrSq*/)const
bool MDTransfModQ::calcMatrixCoord(const double& x,std::vector<coord_t> &Coord, double & signal,double & ErrSq)const
{
if(m_Emode == Kernel::DeltaEMode::Elastic)
{
return calcMatrixCoordElastic(x,Coord);
}else{
return calcMatrixCoordInelastic(x,Coord);
}
UNUSED_ARG(signal);
UNUSED_ARG(ErrSq);
if(m_Emode == Kernel::DeltaEMode::Elastic)
{
return calcMatrixCoordElastic(x,Coord);
}else{
return calcMatrixCoordInelastic(x,Coord);
}
}

/** Method fills-in all additional properties requested by user and not defined by matrix workspace itselt.
Expand Down
7 changes: 4 additions & 3 deletions Code/Mantid/Framework/MDEvents/src/MDTransfQ3D.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,14 @@ namespace Mantid
/** Calculates 3D transformation of the variable coordinates and (if applicable) signal and error depending on 3D coordinates
* (e.g. Lorents corrections)
*@param x -- the transformed values
*@param Coord -- 3 or 4D coordinate of the resulting event
*@param s -- the signal
*@param err --the error
*
*@return converted 3D coordinates corresponding to given detector and X-vale
*@return Coord -- converted 3D coordinates corresponding to given detector and X-vale
Optionally:
@return s -- corrected signal
@return err -- corrected error
@return s -- Lorentz corrected signal
@return err -- Lorentz corrected error
*/
bool MDTransfQ3D::calcMatrixCoord(const double& x,std::vector<coord_t> &Coord,double &s, double &err)const
{
Expand Down

0 comments on commit 0378210

Please sign in to comment.