Skip to content

Commit

Permalink
refs #9502 Spelling errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
abuts committed Jun 3, 2014
1 parent ccefe54 commit c0ad6e5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 16 deletions.
16 changes: 10 additions & 6 deletions Code/Mantid/Framework/MDAlgorithms/src/ConvertToMD.cpp
Expand Up @@ -315,24 +315,28 @@ namespace Mantid
else // setup existing MD workspace as workspace target.
m_OutWSWrapper->setMDWS(spws);

// copy the necessary methadata and get the unique number, that identifies the run, the source workspace came from.
copyMetaData(spws,targWSDescr);
// preprocess detectors;
// preprocess detectors;
targWSDescr.m_PreprDetTable = this->preprocessDetectorsPositions(m_InWS2D,dEModReq,getProperty("UpdateMasks"), std::string(getProperty("PreprocDetectorsWS")));


//DO THE JOB:
// get pointer to appropriate algorithm, (will throw if logic is wrong and ChildAlgorithm is not found among existing)

// get pointer to appropriate ConverttToMD plugin from the CovertToMD plugins factory, (will throw if logic is wrong and ChildAlgorithm is not found among existing)
ConvToMDSelector AlgoSelector;
this->m_Convertor = AlgoSelector.convSelector(m_InWS2D,this->m_Convertor);
// copy the necessary methadata and get the unique number, that identifies the run, the source workspace came from.
copyMetaData(spws,targWSDescr);



bool ignoreZeros = getProperty("IgnoreZeroSignals");
// initiate conversion and estimate amount of job to do
size_t n_steps = this->m_Convertor->initialize(targWSDescr,m_OutWSWrapper,ignoreZeros);


// progress reporter
m_Progress.reset(new API::Progress(this,0.0,1.0,n_steps));

g_log.information()<<" conversion started\n";
//DO THE JOB:
this->m_Convertor->runConversion(m_Progress.get());


Expand Down
12 changes: 6 additions & 6 deletions Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h
Expand Up @@ -23,7 +23,7 @@ namespace Mantid
{
namespace MDEvents
{
/** class describes the inteface to the methods, which perform conversion from usual workspaces to MDEventWorkspace
/** class describes the interface to the methods, which perform conversion from usual workspaces to MDEventWorkspace
*
* See http://www.mantidproject.org/Writing_custom_ConvertTo_MD_transformation for detailed description of this
* class place in the algorithms hierarchy.
Expand Down Expand Up @@ -58,7 +58,7 @@ namespace MDEvents
// constructor;
ConvToMDBase();

///method which initates all main class variables
///method which initiates all main class variables
virtual size_t initialize(const MDWSDescription &WSD, boost::shared_ptr<MDEventWSWrapper> inWSWrapper, bool ignoreZeros);
/// method which starts the conversion procedure
virtual void runConversion(API::Progress *)=0;
Expand All @@ -71,9 +71,9 @@ namespace MDEvents
API::MatrixWorkspace_const_sptr m_InWS2D;
// pointer to the class, which keeps target workspace and provides functions adding additional MD events to it.
boost::shared_ptr<MDEvents::MDEventWSWrapper> m_OutWSWrapper;
// shared pointer to the converter, which convertd WS coordinates to MD coordinates
// shared pointer to the converter, which converts WS coordinates to MD coordinates
MDTransf_sptr m_QConverter;
/// number of target ws dimesnions
/// number of target ws dimensions
size_t m_NDims;
// index of current run(workspace). Used for MD WS combining
uint16_t m_RunIndex;
Expand All @@ -92,7 +92,7 @@ namespace MDEvents
UnitsConversionHelper m_UnitConversion;
// the parameter, which control if algorithm should run multithreaded.
// On multiprocessor machine the algorithm should run and utilizes all cores (see Kernel::Threadpool),
// but this can be chenged setting this parameter to 0 (no multithreading) or positive number specifying the requested nymber of threads
// but this can be changed setting this parameter to 0 (no multithreading) or positive number specifying the requested number of threads
int m_NumThreads;
// Flag which indicates that data with 0 signal should be ignored
bool m_ignoreZeros;
Expand All @@ -102,7 +102,7 @@ namespace MDEvents
/** internal function which do one peace of work, which should be performed by one thread
*
*@param job_ID -- the identifier which specifies, what part of the work on the workspace this job has to do.
Oftern it is a spectra number
Often it is a spectra number
*
*/
virtual size_t conversionChunk(size_t job_ID)=0;
Expand Down
Expand Up @@ -62,7 +62,7 @@ namespace MDEvents
class MDTransfInterface
{
public:
/**The method returns the name, under which the transformation would be known to a user. Its overloaded and implemented in */
/**The method returns the name, under which the transformation would be known to a user. Its overloaded and implemented in subscriptions */
virtual const std::string transfID()const=0;
/** MD transformation can often be used together with energy analysis mode; This function should be overloaded
if the transformation indeed can do the energy analysis */
Expand Down Expand Up @@ -142,16 +142,16 @@ class MDTransfInterface

//***************> the methods below are mainly involved in defining the target workspace properties.
// They also can be involved in the preparation to calculations of MD coordinates
// WARNING!!!! THESE METHODS ARE USED BEFORE INITIALIZE IS EXECUTED SO THEY CAN NOT RELY ON THE CONTENTS OF THE CLASS TO BE DEFINED (THEY ARE VIRTUAL STATIC METHODS)
// WARNING!!!! THESE METHODS ARE USED BEFORE INITIALIZE IS EXECUTED SO THEY CAN NOT RELY ON THE CONTENTS OF THE CLASS TO BE DEFINED (THEY ARE "VIRTUAL STATIC METHODS")

/** returns the unit ID for the input units, the particular transformation expects.
if one wants the transformation to be meaningful, the X-coordinates of input workspace
used by the transformation have to be expressed in the uinits with ID, returned by this method */
used by the transformation have to be expressed in the units with ID, returned by this method */
virtual const std::string inputUnitID(Kernel::DeltaEMode::Type dEmode, API::MatrixWorkspace_const_sptr inWS)const=0;
/** The transformation generates output MD events in particular units. This method returns these Units ID-s */
virtual std::vector<std::string> outputUnitID(Kernel::DeltaEMode::Type dEmode, API::MatrixWorkspace_const_sptr inWS)const = 0;

/** when one builds MD workspace, he needs a dimension names/ID-s which can be different for different Q-transformatons and in different E-mode
/** when one builds MD workspace, he needs a dimension names/ID-s which can be different for different Q-transformations and in different E-mode
The position of each dimID in the output vector should correspond the position of each coordinate in the Coord vector */
virtual std::vector<std::string> getDefaultDimID(Kernel::DeltaEMode::Type dEmode, API::MatrixWorkspace_const_sptr inWS)const = 0;

Expand Down

0 comments on commit c0ad6e5

Please sign in to comment.