Commit 3a806190 authored by Karl Palmen's avatar Karl Palmen
Browse files

Merge pull request #15044 from mantidproject/15041_Wokflow_for_ProcessIndirectFitParameters

Wokflow Diagram for ProcessIndirectFitParameters
parents ef0fb3f9 c3914c1b
......@@ -14,6 +14,11 @@ An Algorithm designed to allow for the TableWorkspace output of the
PlotPeakByLogValue algorithm to be transformed into a Matrix workspace
based on the desired parameters.
Workflow
--------
.. diagram:: ProcessIndirectFitParameters-v1_wkflw.dot
Usage
-----
......
digraph ProcessIndirectFitParameters {
label="ProcessIndirectFitParameters Flowchart"
$global_style
subgraph params {
$param_style
//Properties
InputWorkspace
ColumnX
ParameterNames
XAxisUnit
OutputWorkspace
//Local
allColumnNames
currentColumnName
ErrorColumnName
ColumnName
PeakWorkspaces
WorkspaceNames
}
subgraph algorithms {
$algorithm_style
ConvertTableToMatrixWorkspace
RenameWorkspace
}
subgraph decisions {
$decision_style
processedAllColumns [label="All columns to workspaces"]
}
subgraph process {
$process_style
searchForParams [label="searchforFitParams: Search for strings that have the given word as their suffix"]
conjoinParams [label="Conjoin all the workspaces that are about the same peak (Could be multiple Lorentzians)"]
conjoinPeaks [label="Conjoin all the peak workspaces into a single workspace"]
replaceXAxis [label="Replace the x axis with the parameter names"]
replaceXUnit [label="Replace the x axis unit with algorithm input"]
}
InputWorkspace -> allColumnNames [label="Get all column names from the TableWorkspace"]
allColumnNames -> currentColumnName [label="Extract ColumnName to be used in a loop"]
currentColumnName -> searchForParams
ParameterNames -> searchForParams
searchForParams -> ColumnName [label="Corresponding name for currentColumnName from tableWorkspace"]
searchForParams -> ErrorColumnName [label="Corresponding errors for currentColumnName from tableWorkspace"]
ColumnX -> ConvertTableToMatrixWorkspace [label="X"]
ColumnName -> ConvertTableToMatrixWorkspace [label="Y"]
ErrorColumnName -> ConvertTableToMatrixWorkspace [label="E"]
ConvertTableToMatrixWorkspace -> WorkspaceNames [label="Vector to store workspaces for Conjoining"]
WorkspaceNames -> processedAllColumns
processedAllColumns -> allColumnNames [label="No"]
processedAllColumns -> conjoinParams [label="Yes"]
conjoinParams -> PeakWorkspaces
PeakWorkspaces -> conjoinPeaks
conjoinPeaks -> RenameWorkspace
RenameWorkspace -> replaceXAxis
replaceXAxis -> replaceXUnit
XAxisUnit -> replaceXUnit
replaceXUnit -> OutputWorkspace
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment