Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
mantidproject
mantid
Commits
569f3220
Commit
569f3220
authored
Jan 18, 2018
by
Samuel Jackson
Browse files
Update doc to include units
parent
662b6706
Changes
2
Hide whitespace changes
Inline
Side-by-side
Framework/DataObjects/src/Peak.cpp
View file @
569f3220
...
...
@@ -707,13 +707,13 @@ void Peak::setMonitorCount(double m_monitorCount) {
}
//----------------------------------------------------------------------------------------------
/** Get the final neutron energy */
/** Get the final neutron energy
in meV
*/
double
Peak
::
getFinalEnergy
()
const
{
return
m_finalEnergy
;
}
/** Get the initial (incident) neutron energy */
/** Get the initial (incident) neutron energy
in meV
*/
double
Peak
::
getInitialEnergy
()
const
{
return
m_initialEnergy
;
}
/** Get the difference between the initial and final neutron energy */
/** Get the difference between the initial and final neutron energy
in meV
*/
double
Peak
::
getEnergyTransfer
()
const
{
return
getInitialEnergy
()
-
getFinalEnergy
();
}
...
...
Framework/PythonInterface/mantid/api/src/Exports/IPeak.cpp
View file @
569f3220
...
...
@@ -125,17 +125,17 @@ void export_IPeak() {
"microseconds) of the neutrons for this "
"peak"
)
.
def
(
"getInitialEnergy"
,
&
IPeak
::
getInitialEnergy
,
arg
(
"self"
),
"Get the initial (incident) neutron energy"
)
"Get the initial (incident) neutron energy
in meV.
"
)
.
def
(
"getFinalEnergy"
,
&
IPeak
::
getFinalEnergy
,
arg
(
"self"
),
"Get the final neutron energy"
)
"Get the final neutron energy
in meV.
"
)
.
def
(
"getEnergyTransfer"
,
&
IPeak
::
getEnergyTransfer
,
arg
(
"self"
),
"Get the initial neutron energy minus the final neutron energy."
"Get the initial neutron energy minus the final neutron energy
in meV
."
"
\n\n
.. versionadded:: 3.12.0"
)
.
def
(
"setInitialEnergy"
,
&
IPeak
::
setInitialEnergy
,
(
arg
(
"self"
),
arg
(
"initial_energy"
)),
"Set the initial (incident) neutron energy"
)
"Set the initial (incident) neutron energy
in meV.
"
)
.
def
(
"setFinalEnergy"
,
&
IPeak
::
setFinalEnergy
,
(
arg
(
"self"
),
arg
(
"final_energy"
)),
"Set the final neutron energy"
)
(
arg
(
"self"
),
arg
(
"final_energy"
)),
"Set the final neutron energy
in meV.
"
)
.
def
(
"getIntensity"
,
&
IPeak
::
getIntensity
,
arg
(
"self"
),
"Return the integrated peak intensity"
)
.
def
(
"getSigmaIntensity"
,
&
IPeak
::
getSigmaIntensity
,
arg
(
"self"
),
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment