Skip to content
Snippets Groups Projects
Commit 843932c1 authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

Doxy comments more concise

parent d231cfc9
No related branches found
No related tags found
1 merge request!1142simplify ISimulation2D and IDetector, improve comments
......@@ -211,19 +211,17 @@ protected:
//! Returns the name for the axis with given index
virtual std::string axisName(size_t index) const = 0;
//! Return 0 if no ROI has been explicitly set.
//! Size means number of data points.
//! Return number of data points in Roi, or 0 if no Roi is set.
virtual size_t sizeOfExplicitRegionOfInterest() const;
//! Lower and upper bound of one axis of an explicitly set ROI.
//! Return 0/0 if no ROI has been explicitly set.
//! Returns lower and upper Roi bound of one axis, or (0,0) if no Roi is set.
virtual std::pair<double, double> boundsOfExplicitRegionOfInterest(size_t iAxis) const;
//! Calculate global index from two axis indices
//! Returns flattened index computed from two axis indices.
size_t getGlobalIndex(size_t x, size_t y) const;
#ifndef SWIG
//! Keeps RegionOfInterest (ROI) data of one axis
//! Keeps RegionOfInterest (ROI) data of one axis.
struct RoiOfAxis {
double lower;
double upper;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment