Commit 569f3220 authored by Samuel Jackson's avatar Samuel Jackson
Browse files

Update doc to include units

parent 662b6706
...@@ -707,13 +707,13 @@ void Peak::setMonitorCount(double m_monitorCount) { ...@@ -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; } 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; } 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 { double Peak::getEnergyTransfer() const {
return getInitialEnergy() - getFinalEnergy(); return getInitialEnergy() - getFinalEnergy();
} }
......
...@@ -125,17 +125,17 @@ void export_IPeak() { ...@@ -125,17 +125,17 @@ void export_IPeak() {
"microseconds) of the neutrons for this " "microseconds) of the neutrons for this "
"peak") "peak")
.def("getInitialEnergy", &IPeak::getInitialEnergy, arg("self"), .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"), .def("getFinalEnergy", &IPeak::getFinalEnergy, arg("self"),
"Get the final neutron energy") "Get the final neutron energy in meV.")
.def("getEnergyTransfer", &IPeak::getEnergyTransfer, arg("self"), .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") "\n\n.. versionadded:: 3.12.0")
.def("setInitialEnergy", &IPeak::setInitialEnergy, .def("setInitialEnergy", &IPeak::setInitialEnergy,
(arg("self"), arg("initial_energy")), (arg("self"), arg("initial_energy")),
"Set the initial (incident) neutron energy") "Set the initial (incident) neutron energy in meV.")
.def("setFinalEnergy", &IPeak::setFinalEnergy, .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"), .def("getIntensity", &IPeak::getIntensity, arg("self"),
"Return the integrated peak intensity") "Return the integrated peak intensity")
.def("getSigmaIntensity", &IPeak::getSigmaIntensity, arg("self"), .def("getSigmaIntensity", &IPeak::getSigmaIntensity, arg("self"),
......
Supports Markdown
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