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
8c38155e
Commit
8c38155e
authored
Mar 03, 2021
by
Whitfield, Ross
Browse files
Update class descriptions
parent
18133bef
Changes
3
Hide whitespace changes
Inline
Side-by-side
Framework/DataObjects/inc/MantidDataObjects/BasePeak.h
View file @
8c38155e
...
...
@@ -25,10 +25,10 @@ class InstrumentRayTracer;
namespace
DataObjects
{
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. This is a partial
* implementation of IPeak and should contain everything that is common
* to Peak and LeanPeak.
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class
DLLExport
BasePeak
:
public
Geometry
::
IPeak
{
public:
...
...
Framework/DataObjects/inc/MantidDataObjects/LeanPeak.h
View file @
8c38155e
...
...
@@ -20,10 +20,11 @@ namespace Mantid {
namespace
DataObjects
{
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. This is a version of
* Peak that doesn't require the instrument. The peak is described
* only by the Q-sample position. Optionally if the wavelength and
* goniometer is provided other properties can be calculated.
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class
DLLExport
LeanPeak
:
public
BasePeak
{
public:
...
...
Framework/DataObjects/inc/MantidDataObjects/Peak.h
View file @
8c38155e
...
...
@@ -26,10 +26,11 @@ class InstrumentRayTracer;
namespace
DataObjects
{
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. The peak is described
* by the physical detector position (determined either from detector
* infomation or calculated from Q-lab) and inital/final energy
* (calculated from Q-lab or provided wavelength)
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class
DLLExport
Peak
:
public
BasePeak
{
public:
...
...
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