diff --git a/Framework/Algorithms/inc/MantidAlgorithms/DeleteLog.h b/Framework/Algorithms/inc/MantidAlgorithms/DeleteLog.h index 63495faafd4f646617749752c61b7d2c8570df63..35bf4200a4eaf21f6777155285b994366e56cffa 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/DeleteLog.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/DeleteLog.h @@ -38,7 +38,7 @@ public: int version() const override; const std::vector<std::string> seeAlso() const override { - return {"AddSampleLog", "RenameLog", "RenameLogs"}; + return {"AddSampleLog", "RenameLog"}; } const std::string category() const override; diff --git a/Framework/Algorithms/inc/MantidAlgorithms/FindCenterOfMassPosition2.h b/Framework/Algorithms/inc/MantidAlgorithms/FindCenterOfMassPosition2.h index 8dd5491547f6280893dce1903cf03a2fd68ac103..f5893103918f5e05ce15bce4d93bfe82df6c9f46 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/FindCenterOfMassPosition2.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/FindCenterOfMassPosition2.h @@ -50,9 +50,7 @@ public: /// Algorithm's version int version() const override { return (2); } - const std::vector<std::string> seeAlso() const override { - return {"SANSBeamCentreFinderMassMethod", "SANSBeamCentreFinder"}; - } + /// Algorithm's category for identification const std::string category() const override { return "SANS"; } diff --git a/Framework/Algorithms/inc/MantidAlgorithms/MagFormFactorCorrection.h b/Framework/Algorithms/inc/MantidAlgorithms/MagFormFactorCorrection.h index 82749345affe2922ba2c0cb8a65c328142d7d0b3..3d4402c3ebb12c7f215409a95ef9375b6c5b3a5a 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/MagFormFactorCorrection.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/MagFormFactorCorrection.h @@ -57,7 +57,7 @@ public: /// Algorithm's version int version() const override { return (1); } const std::vector<std::string> seeAlso() const override { - return {"SofQW", "SofQW2", "SofQW3"}; + return {"SofQW"}; } /// Algorithm's category for identification const std::string category() const override { return "CorrectionFunctions"; } diff --git a/Framework/Algorithms/inc/MantidAlgorithms/MonteCarloAbsorption.h b/Framework/Algorithms/inc/MantidAlgorithms/MonteCarloAbsorption.h index 4e1d44502840e05578afca734030a908cf5fb28f..2d627213fc7646f145c00c5b2be2deb4c2932f6d 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/MonteCarloAbsorption.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/MonteCarloAbsorption.h @@ -50,7 +50,7 @@ public: /// Algorithm's version int version() const override { return 1; } const std::vector<std::string> seeAlso() const override { - return {"MayersSampleAbsorption", "MultipleScatteringCylinderAbsorption", + return {"MayersSampleCorrection", "MultipleScatteringCylinderAbsorption", "PearlMCAbsorption", "VesuvioCalculateMS"}; } /// Algorithm's category for identification diff --git a/Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/MayersSampleCorrection.h b/Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/MayersSampleCorrection.h index 91878a844d6eb9b8f2cac1e8675d7fa0650f1cf0..19719ae48c055eb4b7f33bc770d7c4225719cec8 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/MayersSampleCorrection.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/MayersSampleCorrection.h @@ -40,8 +40,7 @@ public: const std::string category() const override; const std::string summary() const override; const std::vector<std::string> seeAlso() const override { - return {"MonteCarloAbsorption", "MultipleScatteringCylinderAbsorption", - "PearlMCAbsorption,VesuvioCalculateMS"}; + return {"MonteCarloAbsorption", "MultipleScatteringCylinderAbsorption"}; } private: diff --git a/Framework/Algorithms/inc/MantidAlgorithms/UnwrapSNS.h b/Framework/Algorithms/inc/MantidAlgorithms/UnwrapSNS.h index 7b4898d578710dbb425c61c2a423af0d4c53a65e..51d555418235a8ead93763737a79c74d49bf9fea 100644 --- a/Framework/Algorithms/inc/MantidAlgorithms/UnwrapSNS.h +++ b/Framework/Algorithms/inc/MantidAlgorithms/UnwrapSNS.h @@ -60,9 +60,7 @@ public: } int version() const override { return 1; } - const std::vector<std::string> seeAlso() const override { - return {"UnwrapMonitorsInTOF", "UnwrapMonitors"}; - } + const std::string category() const override { return "CorrectionFunctions\\InstrumentCorrections"; } diff --git a/Framework/Crystal/inc/MantidCrystal/OptimizeLatticeForCellType.h b/Framework/Crystal/inc/MantidCrystal/OptimizeLatticeForCellType.h index 0a71620245982576cd616b94fea68377ed68b445..6a96a5e364c242899d59091d15668f6da18beb21 100644 --- a/Framework/Crystal/inc/MantidCrystal/OptimizeLatticeForCellType.h +++ b/Framework/Crystal/inc/MantidCrystal/OptimizeLatticeForCellType.h @@ -56,7 +56,7 @@ public: /// Algorithm's version for identification overriding a virtual method int version() const override { return 1; } const std::vector<std::string> seeAlso() const override { - return {"FindUBUsingFFT", "FindUBUsinIndexedPeaks", + return {"FindUBUsingFFT", "FindUBUsingIndexedPeaks", "FindUBUsingLatticeParameters"}; } /// Algorithm's category for identification overriding a virtual method diff --git a/Framework/Crystal/inc/MantidCrystal/SelectCellOfType.h b/Framework/Crystal/inc/MantidCrystal/SelectCellOfType.h index 094cf9ca50be126c70caa232d5e737040cf7b11a..1e448ee097ba8dc5b392c62be72b69a601b4e1ed 100644 --- a/Framework/Crystal/inc/MantidCrystal/SelectCellOfType.h +++ b/Framework/Crystal/inc/MantidCrystal/SelectCellOfType.h @@ -44,7 +44,7 @@ public: /// Algorithm's version for identification int version() const override { return 1; }; const std::vector<std::string> seeAlso() const override { - return {"FindUBUsingFFT", "FindUBUsinIndexedPeaks", + return {"FindUBUsingFFT", "FindUBUsingIndexedPeaks", "FindUBUsingLatticeParameters"}; } diff --git a/Framework/Crystal/inc/MantidCrystal/SelectCellWithForm.h b/Framework/Crystal/inc/MantidCrystal/SelectCellWithForm.h index 7178f09ecf0916f67828f7191f4c4692379bad02..2254043d5c438c0af70b766746679fe1fb43fea1 100644 --- a/Framework/Crystal/inc/MantidCrystal/SelectCellWithForm.h +++ b/Framework/Crystal/inc/MantidCrystal/SelectCellWithForm.h @@ -45,7 +45,7 @@ public: /// Algorithm's version for identification int version() const override { return 1; }; const std::vector<std::string> seeAlso() const override { - return {"FindUBUsingFFT", "FindUBUsinIndexedPeaks", + return {"FindUBUsingFFT", "FindUBUsingIndexedPeaks", "FindUBUsingLatticeParameters"}; } diff --git a/Framework/Crystal/inc/MantidCrystal/ShowPossibleCells.h b/Framework/Crystal/inc/MantidCrystal/ShowPossibleCells.h index 3f5237c8fe202cba977a8da7ff8625d034bfdf2f..977cbaa4e2cfd5bf1b7c55f9cf4f055c74544eed 100644 --- a/Framework/Crystal/inc/MantidCrystal/ShowPossibleCells.h +++ b/Framework/Crystal/inc/MantidCrystal/ShowPossibleCells.h @@ -44,7 +44,7 @@ public: /// Algorithm's version for identification int version() const override { return 1; }; const std::vector<std::string> seeAlso() const override { - return {"FindUBUsingFFT", "FindUBUsinIndexedPeaks", + return {"FindUBUsingFFT", "FindUBUsingIndexedPeaks", "FindUBUsingLatticeParameters"}; } diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/Fit.h b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/Fit.h index d1ba558c108eabedf6c8f0d8dbda7805219acb8a..028f6d76fee69f5393548e6712dbcea39a46e18d 100644 --- a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/Fit.h +++ b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/Fit.h @@ -105,7 +105,7 @@ public: int version() const override { return (1); } const std::vector<std::string> seeAlso() const override { return {"FitGaussian", "UserFunction1D", "PlotPeakByLogValue", - "SplineBackground ", "EvaluateFunction"}; + "SplineBackground", "EvaluateFunction"}; } private: diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadBBY.h b/Framework/DataHandling/inc/MantidDataHandling/LoadBBY.h index 73d979450ab0462d56fcff8c0ffa9f2a59bac0a9..8cbf569c98753fb78ded5af4ad1c72dc9501a8f1 100644 --- a/Framework/DataHandling/inc/MantidDataHandling/LoadBBY.h +++ b/Framework/DataHandling/inc/MantidDataHandling/LoadBBY.h @@ -92,7 +92,7 @@ public: // description int version() const override { return 1; } const std::vector<std::string> seeAlso() const override { - return {"Load", "PatchBBY", "LoadQKK"}; + return {"Load", "LoadQKK"}; } const std::string name() const override { return "LoadBBY"; } const std::string category() const override { return "DataHandling\\ANSTO"; } diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadNexus.h b/Framework/DataHandling/inc/MantidDataHandling/LoadNexus.h index c4abf718ca574d34a749b7f6da076ea156dc3892..5f377952ec8f2e9284a76fab50b593dfbe4edf8c 100644 --- a/Framework/DataHandling/inc/MantidDataHandling/LoadNexus.h +++ b/Framework/DataHandling/inc/MantidDataHandling/LoadNexus.h @@ -71,7 +71,7 @@ public: /// Algorithm's version for identification overriding a virtual method int version() const override { return 1; }; const std::vector<std::string> seeAlso() const override { - return {"LoadMcStasNexus", "LoadNexusMonitors", "LoadNexusProceed", + return {"LoadMcStasNexus", "LoadNexusMonitors", "LoadNexusProcessed", "LoadTOFRawNexus", "LoadILLDiffraction", "LoadILLTOF", "LoadILLIndirect", "LoadILLReflectometry", "LoadILLSANS", "LoadMuonNexus", "LoadFlexiNexus"}; diff --git a/Framework/DataHandling/inc/MantidDataHandling/SaveCSV.h b/Framework/DataHandling/inc/MantidDataHandling/SaveCSV.h index 469c63d5fbaad4f286d78e984473193a1b762079..5fad0d6a2a7b08bdc82c32baee56a4d0551b0576 100644 --- a/Framework/DataHandling/inc/MantidDataHandling/SaveCSV.h +++ b/Framework/DataHandling/inc/MantidDataHandling/SaveCSV.h @@ -94,7 +94,7 @@ public: /// Algorithm's version for identification overriding a virtual method int version() const override { return 1; }; const std::vector<std::string> seeAlso() const override { - return {"LoadCSV", "SaveAscii"}; + return {"SaveAscii"}; } /// Algorithm's category for identification overriding a virtual method const std::string category() const override { return "DataHandling\\Text"; } diff --git a/Framework/ICat/inc/MantidICat/CatalogDownloadDataFiles.h b/Framework/ICat/inc/MantidICat/CatalogDownloadDataFiles.h index 570614009ee06277200cebe0522dce4716ca2910..8f157930e97d7a497bbea7c1e763e8842433e66b 100644 --- a/Framework/ICat/inc/MantidICat/CatalogDownloadDataFiles.h +++ b/Framework/ICat/inc/MantidICat/CatalogDownloadDataFiles.h @@ -61,7 +61,7 @@ public: /// Algorithm's version for identification overriding a virtual method int version() const override { return 1; } const std::vector<std::string> seeAlso() const override { - return {"DownloadFile", "CatalogGetDataFiles", "CatalogDataSets", + return {"DownloadFile", "CatalogGetDataFiles", "CatalogLogin"}; } /// Algorithm's category for identification overriding a virtual method diff --git a/Framework/ICat/inc/MantidICat/CatalogSearch.h b/Framework/ICat/inc/MantidICat/CatalogSearch.h index 0962af4bb155bc503f984b59c00a7c051832412c..354b29f63e053a21c34f5e34b6beac1b5f826503 100644 --- a/Framework/ICat/inc/MantidICat/CatalogSearch.h +++ b/Framework/ICat/inc/MantidICat/CatalogSearch.h @@ -69,7 +69,7 @@ public: /// Algorithm's version for identification overriding a virtual method int version() const override { return 1; } const std::vector<std::string> seeAlso() const override { - return {"CatalogMyDataSearch", "CatalogGetDataFiles", "CatalogDataSets", + return {"CatalogMyDataSearch", "CatalogGetDataFiles", "CatalogLogin", "CatalogPublish"}; } /// Algorithm's category for identification overriding a virtual method diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/AndMD.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/AndMD.h index 02e18a2a7d79e53ae7deb4b16d0cc80883e20ce0..6a2ac1cef7a32b6ae3f2afc180b4b9f151a3d0f5 100644 --- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/AndMD.h +++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/AndMD.h @@ -39,7 +39,7 @@ public: const std::string name() const override; int version() const override; const std::vector<std::string> seeAlso() const override { - return {"XOrMD", "OrMD", "NotMD"}; + return {"XorMD", "OrMD", "NotMD"}; } private: diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadSQW2.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadSQW2.h index b044906fe861bb66ae30fa322e403c94fda39130..b4936899c25fd9bf811c1f3d33765ccbb3a81193 100644 --- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadSQW2.h +++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/LoadSQW2.h @@ -48,7 +48,7 @@ public: const std::string name() const override; int version() const override; const std::vector<std::string> seeAlso() const override { - return {"LoadNXSPE", "SaveNXSPE", "SaveProcessedNexus"}; + return {"LoadNXSPE", "SaveNXSPE"}; } const std::string category() const override; const std::string summary() const override; diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/NotMD.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/NotMD.h index eca2e6adb5aea21e532762ab26189884ad5fd901..c855fbcbcc7b9a2fc590851a9e3da6b6ce0fe014 100644 --- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/NotMD.h +++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/NotMD.h @@ -43,7 +43,7 @@ public: int version() const override; const std::vector<std::string> seeAlso() const override { - return {"AndMD", "OrMD", "XOrMD"}; + return {"AndMD", "OrMD", "XorMD"}; } private: diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/OrMD.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/OrMD.h index 66df2e686c5e22c40834755a49c58bd0978bf8f4..5cbf604ad4153e12855d9a2e1735e853893efd0a 100644 --- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/OrMD.h +++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/OrMD.h @@ -38,7 +38,7 @@ public: const std::string name() const override; int version() const override; const std::vector<std::string> seeAlso() const override { - return {"AndMD", "XOrMD", "NotMD"}; + return {"AndMD", "XorMD", "NotMD"}; } private: diff --git a/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h b/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h index 77523023f82991d6ad0f478e60cc221ed307b6b7..fd629644542c71120d670d1e110e34c25ec3fbde 100644 --- a/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h +++ b/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h @@ -48,9 +48,7 @@ public: } /// Algorithm's version int version() const override { return (1); } - const std::vector<std::string> seeAlso() const override { - return {"RefReduction"}; - } + /// Algorithm's category for identification const std::string category() const override { return "Workflow\\Reflectometry"; diff --git a/buildconfig/class_maker.py b/buildconfig/class_maker.py index e6af905d450a487f268b76b8939dc06449ae8739..5c02dcada8e8c8e333ebff8101e7ee094f1c1257 100755 --- a/buildconfig/class_maker.py +++ b/buildconfig/class_maker.py @@ -254,7 +254,7 @@ def write_rst(subproject, classname, filename, args): .. summary:: -.. seeAlso:: +.. relatedalgorithms:: .. properties:: diff --git a/docs/source/algorithms/BASISDiffraction-v1.rst b/docs/source/algorithms/BASISDiffraction-v1.rst index 9341ca8dd5423edca9273a98062c977da9e2bfbe..138a4783f1884e71d92b0203c68ed21f3951bb85 100644 --- a/docs/source/algorithms/BASISDiffraction-v1.rst +++ b/docs/source/algorithms/BASISDiffraction-v1.rst @@ -43,7 +43,7 @@ and isotropic scattering to determine instrument efficiency per detector. If no vanadium is provided, all detectors are assumed to have the same efficiency Determine Single Crystal Diffraction -==================================== +#################################### Creates a diffraction pattern from a set of runs implementing a rotational scan of the sample around the vertical axis. The @@ -52,7 +52,7 @@ corresponding goniometer's rotation should be logged under log name angle. Sample orientation -~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^ **VectorU**: Vector along k_i, when goniometer is at offset. @@ -60,7 +60,7 @@ Sample orientation offset. Diffraction preferences -~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^ Most of the scattering occurs in the plane defined by VectorU and VectorV. Please choose Uproj and Vproj defining a plane that is as close as possible diff --git a/docs/source/algorithms/BASISReduction311-v1.rst b/docs/source/algorithms/BASISReduction311-v1.rst index 81e8c5e3f03e873904006c71e8a04142bd6ac6ec..6ca9c90a26815ee27b1598428ad97708ba850505 100644 --- a/docs/source/algorithms/BASISReduction311-v1.rst +++ b/docs/source/algorithms/BASISReduction311-v1.rst @@ -32,7 +32,7 @@ lower boundary the bin with the minimum momentum, the bin width, and the upper boundary ofthe bin with the maximum momentum. Reflection Selector -=================== +################### There are typical values for the properties of the 311 reflection: diff --git a/docs/source/algorithms/CalculateChiSquared-v1.rst b/docs/source/algorithms/CalculateChiSquared-v1.rst index fd49f8d1430781193d6e0cc924f3defa954775cc..e96c3a6b10ef2af55cd50f433b4d741f5c7cd61a 100644 --- a/docs/source/algorithms/CalculateChiSquared-v1.rst +++ b/docs/source/algorithms/CalculateChiSquared-v1.rst @@ -34,7 +34,7 @@ Finally, ChiSquaredWeightedDividedByDOF is :math:`\chi_{4}^{2} = \chi_{3}^{2} / DOF` Parameter errors -================ +################ Setting the Output property to a non-empty string makes the algorithm explore the surface of the :math:`\chi^{2}` around its minimum and estimate the standard deviations for the parameters. The value of the property is a base name diff --git a/docs/source/algorithms/CompressEvents-v1.rst b/docs/source/algorithms/CompressEvents-v1.rst index 04d419d727b1d80b82158e5e7ce3d1918dd0c25d..31d04b4c265e2f995c8f80969bcdf73b55368e3a 100644 --- a/docs/source/algorithms/CompressEvents-v1.rst +++ b/docs/source/algorithms/CompressEvents-v1.rst @@ -16,7 +16,7 @@ resolution. This switch is made by specifying a Without pulsetime resolution -============================ +############################ This algorithm starts by sorting the event lists by TOF (or whatever the independent axis is) and ignoring the pulsetime. Therefore you may @@ -43,7 +43,7 @@ changes to its X values (unit conversion for example), you have to use your best judgement for the Tolerance value. With pulsetime resolution -========================= +######################### Similar to the version without pulsetime resolution with a few key differences: diff --git a/docs/source/algorithms/CreateSampleWorkspace-v1.rst b/docs/source/algorithms/CreateSampleWorkspace-v1.rst index 1daa57d346f5680e6d5ab603b8c67724b0499243..088a661ce73ae44f711343fb99f382db15915c68 100644 --- a/docs/source/algorithms/CreateSampleWorkspace-v1.rst +++ b/docs/source/algorithms/CreateSampleWorkspace-v1.rst @@ -37,7 +37,7 @@ important set Random to false or uncheck the box. values should be set to a range symmetrical around x=0. Instrument -~~~~~~~~~~ +########## The instrument created by CreateSample workspace is very simple and looks like this. diff --git a/docs/source/algorithms/CutMD-v1.rst b/docs/source/algorithms/CutMD-v1.rst index 0594fbcb5d3ef1588945d6633935e99f91dfbb58..ee98fac154f646c824904ad91b6c1a63db495960 100644 --- a/docs/source/algorithms/CutMD-v1.rst +++ b/docs/source/algorithms/CutMD-v1.rst @@ -22,19 +22,19 @@ is that the same number of output workspaces are also given so that CutMD knows what to call each output workspace created. MDEventWorkspaces -~~~~~~~~~~~~~~~~~~~ +################# For input of type :ref:`MDEventWorkspace <MDWorkspace>` the algorithm uses :ref:`algm-BinMD` or :ref:`algm-SliceMD` to achieve the binning of the data. The choice of child algorithm used for slicing in this case is controlled by the NoPix option. MDHistoWorkspaces -~~~~~~~~~~~~~~~~~~~ +################# If the input is an :ref:`MDHistoWorkspace <MDHistoWorkspace>` :ref:`algm-BinMD` and :ref:`algm-SliceMD` are not made available as they needto get hold of the original MDEvents associated with an :ref:`MDEventWorkspace <MDWorkspace>` in order to perform the rebinning. As this information is missing from the MDHistoWorkspace images, those operations are forbidden. Instead, a limited subset of the operations are allowed, and are performed via :ref:`algm-IntegrateMDHistoWorkspace`. In this case, the Projection and NoPix properties are ignored. See :ref:`algm-IntegrateMDHistoWorkspace` for how the binning parameters are used. Projection Binning -~~~~~~~~~~~~~~~~~~ +################## The 'PnBin' property, where n is between 1 and 5, is used to specify the binning for the nth dimension of the output workspace. The dimension will be truncated to have extents 'minimum' and 'maximum', with 'stepsize' specifying the size of the bins inbetween. @@ -64,7 +64,7 @@ For ease of use, when using the python interface only, the 'PBins' keyword can b PBins accepts a tuple, or list, of PnBins parameters. The position in the list determines the dimension it corresponds to. See the Usage_ examples below. Creating Projections -~~~~~~~~~~~~~~~~~~~~ +#################### Projections are used by CutMD to transform the multidimensional data prior to cutting it. Projections are provided to CutMD in the form of a :ref:`TableWorkspace <Table Workspaces>`. @@ -124,7 +124,7 @@ call the created workspace: CutMD(..., Projection=proj.createWorkspace(), ...) Workflow -~~~~~~~~ +######## .. diagram:: CutMD-v1_wkflw.dot diff --git a/docs/source/algorithms/ExportSampleLogsToCSVFile-v1.rst b/docs/source/algorithms/ExportSampleLogsToCSVFile-v1.rst index 1b0301672db9a1eea343b8098235b91d722c739c..085c78f0e285edac366f336693663985c2356ec8 100644 --- a/docs/source/algorithms/ExportSampleLogsToCSVFile-v1.rst +++ b/docs/source/algorithms/ExportSampleLogsToCSVFile-v1.rst @@ -15,7 +15,7 @@ The header for the sample log csv file can also be created by this algorithm in a seperate *header* file. CSV File format -=============== +############### Sample logs are written to a csv file. A tab separates any two adjacent values. @@ -35,7 +35,7 @@ Here is the definition for the columns. *SampleLogNames* Header file -=========== +########### A sample log header file can be generated optionally. It contains theree lines described as below. @@ -46,7 +46,7 @@ It contains theree lines described as below. Usually it is the column names in the .csv file Time Zone -========= +######### The time stamps of sample logs are recorded as UTC time in SNS. Some users wants to see the exported sample log as the neutron facility's local time. diff --git a/docs/source/algorithms/IndirectILLReductionQENS-v1.rst b/docs/source/algorithms/IndirectILLReductionQENS-v1.rst index a2c31fdfd6d6eb086ab8978e12888cbef0d4cbfe..5910b816835020f5d5a48cfa627cea5191dc5348 100644 --- a/docs/source/algorithms/IndirectILLReductionQENS-v1.rst +++ b/docs/source/algorithms/IndirectILLReductionQENS-v1.rst @@ -13,7 +13,7 @@ Performs a multiple-file QENS (Quasi-Elastic Neutron Scattering) data reduction It uses internally the :ref:`IndirectILLEnergyTransfer <algm-IndirectILLEnergyTransfer>` algorithm. Multiple File Reduction -~~~~~~~~~~~~~~~~~~~~~~~ +####################### The algorithm is capable of running over multiple files. Run property needs to be specified following the syntax in :py:obj:`MultipleFileProperty <mantid.api.MultipleFileProperty>`. @@ -24,7 +24,7 @@ ignored. Use **Added Range** and **Added Stepped Range** instead (see ``CalibrationRun``, ``CalibrationBackgroundRun`` and ``AlignmentRun`` all the runs will be automatically summed. Unmirror Options -~~~~~~~~~~~~~~~~ +################ **IN16B** can record data with mirror sense, where the spectra for the acceleration and deceleration phase of the Doppler drive are recorded separately, or without. @@ -62,7 +62,7 @@ Options 5 and 7 require the ``AlignmentRun`` (vanadium) to determine the peak po Note, that both detector calibration and background subtraction are performed wing-by-wing, i.e. unmirroring is the very final step. Vanadium Calibration -~~~~~~~~~~~~~~~~~~~~ +#################### Integration range can be specified to integrate over spectra in ``CalibrationRun``. Note, that before integration, the spectra will be centered at 0-energy transfer (see Unmirror Option 6 above) for the calibration run. diff --git a/docs/source/algorithms/IntegrateMDHistoWorkspace-v1.rst b/docs/source/algorithms/IntegrateMDHistoWorkspace-v1.rst index 86ac713b20e2a980cfad848ea0686037d7efb07a..40bd6a3c80b4e2ae817a8ef751c88d7b6fd4db8c 100644 --- a/docs/source/algorithms/IntegrateMDHistoWorkspace-v1.rst +++ b/docs/source/algorithms/IntegrateMDHistoWorkspace-v1.rst @@ -13,12 +13,12 @@ Description Provides limited integration of a :ref:`MDHistoWorkspace <MDHistoWorkspace>` in n-dimensions. Integration is always axis-aligned. Dimensions can only be integrated out, but no finer rebinning is permitted. Dimensions that do not require further rebinning will be left intact provided that the the binning parameters for those dimensions are not specified. For dimensions that are integrated, limits should be provided to give the range of the data to keep. Binning -~~~~~~~ +####### The *P1Bin* corresponds to the first dimension of the MDHistoWorkspace, *P2Bin* to the second and so on. *P1Bin=[-1, 1]* indicates that we will integrate this dimension between -1 and 1. *P1Bins=[]* indicates that the shape of this dimension should be unchanged from the input. *P1Bins=[-1,0,1]* is a special case, the zero indicates that the same bin width as the input dimension would be used, but the minimum and maximum will also be used to crop the dimension. In this latter form, the limits may be expanded to ensure that there is no partial bins in the non-integrated dimension (see warning messages). Weights -~~~~~~~ +####### The algorithm works by creating the *OutputWorkspace* in the correct shape. Each bin in the OutputWorkspace is treated in turn. For each bin in the OutputWorkspace, we find those bins in the *InputWorkspace* that overlap and therefore could contribute to the OutputBin. For any contributing bin, we calculate the fraction overlap and treat this a weighting factor. For each contributing bin *Signal*, and :math:`Error^{2}`, and *Number of Events* values are extracted and multiplied by the weight. These values are summed for all contributing input bins before being assigned to the corresponding output bin. For plotting the *OutputWorkspace*, it is important to select the Number of Events normalization option to correctly account for the weights. diff --git a/docs/source/algorithms/LoadHKL-v1.rst b/docs/source/algorithms/LoadHKL-v1.rst index 9b9535af05e06177eba717864da4cae07aeea374..6222531baef2c1a9d2b811a0d35fc6a28fb930f6 100644 --- a/docs/source/algorithms/LoadHKL-v1.rst +++ b/docs/source/algorithms/LoadHKL-v1.rst @@ -12,7 +12,7 @@ Description Loads an ASCII .hkl file to a PeaksWorkspace. HKL File Format -*************** +############### File has same format that works successfully in GSAS and SHELX from ISAW: diff --git a/docs/source/algorithms/LoadNexusMonitors-v2.rst b/docs/source/algorithms/LoadNexusMonitors-v2.rst index afa1a0d11ae2ef2434dddff1e65d0ef2569de95b..d115c204cc94e705f047b4f61b08147643d5ef2a 100644 --- a/docs/source/algorithms/LoadNexusMonitors-v2.rst +++ b/docs/source/algorithms/LoadNexusMonitors-v2.rst @@ -24,7 +24,7 @@ workspace. As a side-effect of the fix, the contained individual workspaces for each of the periods are named slightly differently. Event monitor and histogram monitor -=================================== +################################### There are two types of monitors, event monitors and histograms monitors. Both of them are of class *NXmonitor* in NeXus file. @@ -39,14 +39,14 @@ Both of them are of class *NXmonitor* in NeXus file. * period_index ISIS event monitor -================== +################## ISIS monitor of event mode may contain entry *data*. In this case, the monitor of event mode can be loaded in histogram mode. Load NeXus file containing both event monitor and histogram monitor -=================================================================== +################################################################### There are a few use cases to load monitor's data if the NeXus file has coexisting event monitors and histogram monitors. diff --git a/docs/source/algorithms/LoadVulcanCalFile-v1.rst b/docs/source/algorithms/LoadVulcanCalFile-v1.rst index 229c49b353ffd1ae377e38a58122543a23684e42..993e081745b9cd6a08c4b355d2c80540564c7d71 100644 --- a/docs/source/algorithms/LoadVulcanCalFile-v1.rst +++ b/docs/source/algorithms/LoadVulcanCalFile-v1.rst @@ -17,7 +17,7 @@ By this algorithm, Vulcan's calibration file can be converted to the standard calibration file for SNSPowderReduction. Detector offset file -==================== +#################### There are :math:`62500` (:math:`50\times 1250`) rows in the offset file. In each row, the first value is the pixel ID; and the second is inner-module offset. @@ -35,14 +35,14 @@ from 0. - Line :math:`1250\times M_i + 1249`: pixel ID, inter bank correction Bad pixel file -============== +############## In bad pixel file, each line contains one and only one integer corresponding to the detector ID of a bad pixel. The bad pixels will be masked in the output MaskWorkspace. Conversion from offset in TOF to d-spacing -========================================== +########################################## With VULCAN's offsets in TOF, the calibration is done as the following. diff --git a/docs/source/algorithms/NRCalculateSlitResolution-v1.rst b/docs/source/algorithms/NRCalculateSlitResolution-v1.rst index fc5e506ea0641eeacb2abfdf2d4bec9ac690bc62..1f729b8c20ced64dce0d2b712f7aa49c8cce1a62 100644 --- a/docs/source/algorithms/NRCalculateSlitResolution-v1.rst +++ b/docs/source/algorithms/NRCalculateSlitResolution-v1.rst @@ -17,7 +17,7 @@ using the theta log name provided. The effective inverse of this algorithm is :ref:`algm-CalculateSlits`. Beam Divergence -*************** +############### .. figure:: ../images/collimation_diagram.png :scale: 50 % diff --git a/docs/source/algorithms/PDFFourierTransform-v1.rst b/docs/source/algorithms/PDFFourierTransform-v1.rst index 37d699cd5ee4f636a22ee96819f3ab9fd1e3f122..de892da208fd3652c62e6f89c070fe929689410a 100644 --- a/docs/source/algorithms/PDFFourierTransform-v1.rst +++ b/docs/source/algorithms/PDFFourierTransform-v1.rst @@ -32,7 +32,7 @@ Output Options -------------- **G(r)** -''''''''' +######## .. raw:: html @@ -84,7 +84,7 @@ otherwise **g(r)** -'''''''' +######## .. raw:: html @@ -111,7 +111,7 @@ transforms to **RDF(r)** -'''''''''' +########## .. raw:: html diff --git a/docs/source/algorithms/RefinePowderInstrumentParameters-v3.rst b/docs/source/algorithms/RefinePowderInstrumentParameters-v3.rst index 3c389cfddd340342e9fb2f7aa116fa3b45d05247..db10e6fa19aed7c023e26adeb9bd0f5b3420ea23 100644 --- a/docs/source/algorithms/RefinePowderInstrumentParameters-v3.rst +++ b/docs/source/algorithms/RefinePowderInstrumentParameters-v3.rst @@ -19,7 +19,7 @@ FitPowderDiffPeaks(). Introduction -============ +############ In order to do Rietveld refinement to experimental data, the diffractometer’s profile should be calibrated by the standards, such as LaB6 or Ni, with known crystal structure and lattice parameters. @@ -45,8 +45,8 @@ Final Time-of-flight is calculated as: .. math:: TOF = n_{cross} TOF_e + (1-n_{cross}) TOF_t -Formular for calculating :math:`A(d)`, :math:`B(d)`, :math:`\sigma(d)` and :math:`\gamma(d)` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Formula for calculating :math:`A(d)`, :math:`B(d)`, :math:`\sigma(d)` and :math:`\gamma(d)` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :math:`\alpha(d)`: @@ -104,7 +104,7 @@ where Break down the problem -====================== +###################### If we can do the single peak fitting on each single diffraction peak in a certain range, then we can divide the optimization problem into 4 sub problems for :math:`X_0`, :math:`A`, @@ -136,13 +136,13 @@ with constraint: The coefficients in this function are strongly correlated to each other. Current Implementation -====================== +###################### Only the parameters of the function for :math:`X_0` are fitted in present implementation. Refinement Algorithm -==================== +#################### Two refinement algorithms, DirectFit and MonteCarlo, are provided. @@ -171,7 +171,7 @@ In future, constaint will be considered. How to use algorithm with other algorithms -========================================== +########################################## This algorithm is designed to work with other algorithms to do Le Bail fit. The introduction can be found in the wiki page of diff --git a/docs/source/algorithms/SCDCalibratePanels-v1.rst b/docs/source/algorithms/SCDCalibratePanels-v1.rst index 81975af5892cf42db5f660b955aaab32d0450ae8..c07c43128af31621d822eed17e6197bfcbb5863f 100644 --- a/docs/source/algorithms/SCDCalibratePanels-v1.rst +++ b/docs/source/algorithms/SCDCalibratePanels-v1.rst @@ -37,7 +37,7 @@ The panels and packs' parameters are optimized in parallel. An option is available to adjust the panel widths and heights for Rectangular Detectors in a second iteration with all the other parameters fixed. OUTPUT workspaces and files: -============================ +############################ 1) The results are saved to an ISAW-like DetCal file and optionally in an xml file that can be used with the :ref:`LoadParameterFile <algm-LoadParameterFile>` algorithm.