mlCurveData.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_CURVE_DATA_H
#define ML_CURVE_DATA_H
 
 
 
// ML includes
#include "mlBase.h"
#include "mlTreeNode.h"
 
 
#include "mlBaseInit.h"
#include "mlBaseList.h"
 
 
ML_START_NAMESPACE
 
 
// --- Type definitions
 
typedef std::vector<double> CurveSeries;
 
 
 
// ------------------------------------------------------------------
// Base object class CurveData
 
// ------------------------------------------------------------------
class MLBASEEXPORT CurveData : public Base
{
public:
 
  enum { ctyLine,              
         ctyArea,              
         ctyDeltaArea,         
         ctyLineDeltaArea,     
         ctyErrorBar           
       };
 
 
  // --------------------------------------------
  // --------------------------------------------
 
  CurveData ();
  CurveData (const CurveData &curveData);
 
  ~CurveData () override {}
 
  CurveData &operator = (const CurveData &srcCurve);
 
 
  friend bool operator==(const CurveData& x, const CurveData& y);
  friend bool operator!=(const CurveData& x, const CurveData& y);
 
 
  // --------------------------------------------
  // --------------------------------------------
 
  void clearData ();
  void clear ();
 
  void setX (MLssize_t nPoints = 0, const double *data = nullptr, MLssize_t step = 1);
  void setX (MLssize_t nPoints, const float *data, MLssize_t step = 1);
 
  void setY (MLssize_t nPoints, const double *data, MLssize_t step = 1);
  void setY (MLssize_t nPoints, const float *data, MLssize_t step = 1);
 
  void setY (MLssize_t iSeries, MLssize_t nPoints, const double *data, MLssize_t step = 1);
  void setY (MLssize_t iSeries, MLssize_t nPoints, const float *data, MLssize_t step = 1);
 
  void setXValue (double value, MLssize_t iPoint);
  void setYValue (double value, MLssize_t iSeries, MLssize_t iPoint);
  void setYValue (double value, MLssize_t iPoint);
 
  void resizeX(MLssize_t nPoints);
  void resizeY(MLssize_t nPoints);
  void resizeY(MLssize_t iSeries, MLssize_t nPoints);
 
 
 
  // --------------------------------------------
  // --------------------------------------------
 
  MLssize_t getPoints ();
  MLssize_t getNumSeries ();
 
  double getXValue (MLssize_t iPoint);
  double getYValue (MLssize_t iSeries, MLssize_t iPoint);
  double getYValue (MLssize_t iPoint);
 
 
 
  // --------------------------------------------
  // --------------------------------------------
 
  void setXRange (double xMin, double xMax);
  void setAutoXRange ();
  void setYRange (double yMin, double yMax);
  void setAutoYRange ();
 
  void setCurveType (int type);
  void setCurveStyle (int style);
 
  void setTitle (std::string title);
  void setUnit (std::string unit);
  void setSymbol (std::string symbol);
 
 
 
  // --------------------------------------------
  // --------------------------------------------
 
  bool isAutoX () { return _autoX; }
 
  double getXMin ();
  double getXMax ();
  double getYMin ();
  double getYMax ();
  void getXYRange (double *xMin, double *xMax, double *yMin, double *yMax);
 
  int getCurveType ();
  int getCurveStyle ();
 
  std::string getTitle ();
  std::string getUnit ();
  std::string getSymbol ();
 
 
  void addStateToTree(TreeNode* /*parent*/) const override;
 
  void readStateFromTree(TreeNode* /*parent*/) override;
 
  // set current version number
  ML_SET_ADDSTATE_VERSION(1);
 
  CurveData* deepCopy() const override { return new CurveData(*this); };
 
protected:
 
  void setXChanged ();
  void setYChanged ();
 
  void setSeries (CurveSeries &v, MLssize_t nPoints, const double *data, MLssize_t step);
  void setSeries (CurveSeries &v, MLssize_t nPoints, const float *data, MLssize_t step);
 
 
#if ML_DEPRECATED_SINCE(3,5,0)
  virtual void updateData () {}
#else
private:
  virtual void updateData() {}
protected:
#endif
 
  void updateAutoX ();
  void updateXRange ();
  void updateYRange ();
 
#if ML_DEPRECATED_SINCE(3,5,0)
 
public:
  ML_DEPRECATED void getXYRange (float *xMin, float *xMax, float *yMin, float *yMax);
 
#endif
 
protected:
  CurveSeries _xData;
  std::vector<CurveSeries> _yData;
 
  bool _autoX;
 
  bool _autoXRange;
  bool _autoYRange;
 
  bool _validXRange;
  bool _validYRange;
 
  double _xMin, _xMax,
         _yMin, _yMax;
 
  int _curveType;
  int _curveStyle;
 
  std::string _title;
  std::string _unit;
  std::string _symbol;
 
 
  ML_CLASS_HEADER(CurveData)
};
 
ML_END_NAMESPACE
 
#endif
// __mlCurveData_H