Commit 3122609b authored by Laurent Belcour's avatar Laurent Belcour

Cleaning of the vertical segment class. Adding some documentation to it.

parent 04381660
......@@ -164,7 +164,7 @@ void vertical_segment::load(const std::string& filename, const arguments& args)
if(args.is_defined("dt-relative"))
{
v[dimX() + dimY()+i] = v[dimX() + i] * (1.0 + min_dt) ;
v[dimX() + dimY()+i] = v[dimX() + i] * (1.0 + min_dt) ;
v[dimX() + 2*dimY()+i] = v[dimX() + i] * (1.0 + max_dt) ;
}
else
......
......@@ -11,6 +11,34 @@
#include "fitter.h"
#include "args.h"
/*! \ingroup core
*
* \brief
* A vertical segment data class
*
* This class implement a data representation of vertical segments in the
* sens of Pacanowski et al. [2012]. Each data point is in fact composed
* of a middle point \f$ x \f$ and an upper \f$ \overline{x} \f$ and lower
* bound \f$ \underline{x} \f$.
*
* To retreive the complete vertical segment data \f$ [x, \underline{x},
* \overline{x}] \f$, a special function is provided. The functions
* inherited from \a data will only return the middle point.
*
* It is possible to load regular ALTA file using a vertical segment data
* loader. It will automatically generate vertical segments. You can
* control the behaviour of the vertical segments using the following
* option in the command line:
* <ul>
* <li><b>\-\-dt</b> specify the size of the vertical segment. If the
* option <b>\-\-dt-relative</b> is not set, this size is absolute: \f$ [x,
* x - dt, x + dt] \f$. If the <b>\-\-dt-relative</b> option is set, the
* vertical segment size is relative to the middle point value \f$ x \f$:
* \f$ [x, x (1 - dt), x (1 + dt)] \f$.
* <li><b>\-\-data-positive</b> for the vertical segment to stay in the
* positive region. The negative values are replaced by zeros.
* </ul>
*/
class vertical_segment : public data
{
public: // methods
......
Markdown is supported
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