Skip to content

Commit

Permalink
Re #11868 Minor updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raquelalvarezbanos committed Oct 2, 2015
1 parent 10e6f1a commit df62b11
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
15 changes: 6 additions & 9 deletions Code/Mantid/Framework/Algorithms/src/CalMuonDetectorPhases.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,20 @@ void CalMuonDetectorPhases::init() {
"Name of the reference input workspace");

declareProperty("FirstGoodData", EMPTY_DBL(),
"The first good data point in units of "
"micro-seconds as measured from time "
"zero",
"The first good data point in units of micro-seconds",
Direction::Input);

declareProperty("LastGoodData", EMPTY_DBL(),
"The last good data point in units of "
"micro-seconds as measured from time "
"zero",
"The last good data point in units of micro-seconds",
Direction::Input);

declareProperty("Frequency", EMPTY_DBL(), "Starting hint for the frequency",
Direction::Input);

declareProperty(new API::WorkspaceProperty<API::ITableWorkspace>(
"DetectorTable", "", Direction::Output),
"The name of the TableWorkspace in which to store the list "
"of phases and asymmetries for each detector");
"Name of the TableWorkspace in which to store the list "
"of phases and asymmetries");

declareProperty(new API::WorkspaceProperty<API::WorkspaceGroup>(
"DataFitted", "", Direction::Output),
Expand All @@ -60,7 +56,8 @@ std::map<std::string, std::string> CalMuonDetectorPhases::validateInputs() {

// Check units, should be microseconds
Unit_const_sptr unit = inputWS->getAxis(0)->unit();
if ((unit->caption() != "Time") || (unit->label().ascii() != "microsecond")) {
if ((unit->label().ascii() != "Microseconds") &&
(unit->label().ascii() != "microsecond")) {
result["InputWorkspace"] = "InputWorkspace units must be microseconds";
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ There are three optional input properties: *FirstGoodData* and *LastGoodData* de
When left blank, *FirstGoodData* is set to the value stored in the input workspace and *LastGoodData*
is set to the last available bin. The optional property *Frequency* allows the user to select an
initial value for :math:`\omega`. If this property is not supplied, the algortihm takes this
value from the *sample_magn_field* log multiplied by :math:`2*\pi *0.01355` MHz/G.
value from the *sample_magn_field* log multiplied by :math:`2\pi\cdot g_\mu`, where :math:`g_\mu` is
the muon gyromagnetic ratio (0.01355 MHz/G).

Usage
-----
Expand Down

0 comments on commit df62b11

Please sign in to comment.