vertical_segment.h 3.03 KB
Newer Older
1 2 3 4 5 6 7
#pragma once

// Include STL
#include <vector>
#include <string>

// Interface
8
#include "common.h"
9 10 11 12 13
#include "function.h"
#include "data.h"
#include "fitter.h"
#include "args.h"

14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*! \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$: 
37 38 39
 *		\f$ [x, x (1 - dt), x (1 + dt)] \f$. You can specify the vertical
 *		segment to be equal to the max of the relative and absolute sizes
 *		using the <b>\-\-dt-max</b> option.
40 41 42 43
 *		<li><b>\-\-data-positive</b> for the vertical segment to stay in the 
 *		positive region. The negative values are replaced by zeros.
 *  </ul>
 */
44 45 46 47 48 49
class vertical_segment : public data
{
	public: // methods

		// Load data from a file
		virtual void load(const std::string& filename) ;
50 51 52 53 54 55 56 57 58 59

        //! \brief Load data from a file using the command line arguments
        //!
        //! \details
        //! Specific arguments for the vertical segment data
        //!   --dt specify a value for the absolute/relative segment if not defined
        //!        in the data
        //!   --data-positive for the data to be positive
        //!   --dt-relative use a relative segment intervale. The dt is used
        //!     multipled by the data
60 61
		virtual void load(const std::string& filename, const arguments& args) ;

62

63
		// Acces to data
64 65
		virtual vec get(int i) const ;		
		virtual vec operator[](int i) const ;
66
		virtual vec value(vec, vec) const 
67
		{
68
			NOT_IMPLEMENTED();
69
		}
70
        virtual vec value(vec) const
71 72 73
        {
            NOT_IMPLEMENTED();
        }
74 75 76

		//! \brief Put the sample inside the data
		virtual void set(vec x);
77 78 79 80 81 82 83 84 85
		
		//! \brief Specific accessor to a vertical segment, this gives the
		//! complete vector, plus the ordinate segment
		virtual void get(int i, vec &x, vec &yl, vec &yu) const ;

		//! \brief Specific accessor to a vertical segment. Provides only the 
		//! ordinate segment.
		virtual void get(int i, vec& yl, vec& yu) const ;		

86 87 88 89 90 91 92 93 94 95 96

		// Get data size
		virtual int size() const ;

	private: // data

		// Store for each point of data, the upper
		// and lower value
		std::vector<vec> _data ;
} ;