com.steema.teechart.functions
Class CurveFitting

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.functions.Function
          extended by com.steema.teechart.functions.CurveFitting

public class CurveFitting
extends Function

Title: CurveFitting class

Description: Base class for fitting function(s)

Copyright (c) 2005-2013-2008 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.functions.Function
canUsePeriod, dPeriod, HideSourceList, noSourceRequired, series, SingleSource, updating
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
CurveFitting()
           
CurveFitting(IBaseChart c)
           
 
Method Summary
 void addPoints(java.util.Vector source)
          Gets all points from Source series, performs a function operation and stores results in ParentSeries.
 double coefficient(int index)
          Returns calculated fitted coefficient.
 double getCurveYValue(Series s, double x)
          Evaluate function using calculated coefficients.
 java.lang.String getDescription()
          Gets descriptive text.
 int getFactor()
          Multiplying factor.
 int getFirstCalcPoint()
          First point to be used in fitting.
 int getFirstPoint()
          First point to be used in evaluating.
 int getLastCalcPoint()
          Last point to be used in fitting.
 int getLastPoint()
          Last point to be used in evaluating.
 int getPolyDegree()
          Defines fitted polynomial degree.
protected  java.lang.Object readResolve()
           
 void setFactor(int value)
          Multiplying factor.
 void setFirstCalcPoint(int value)
          First point to be used in fitting.
 void setFirstPoint(int value)
          First point to be used in evaluating.
 void setLastCalcPoint(int value)
          Last point to be used in fitting.
 void setLastPoint(int value)
          Last point to be used in evaluating.
 void setPolyDegree(int value)
          Defines fitted polynomial degree.
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, calculate, calculateAllPoints, calculateByPeriod, calculateMany, calculatePeriod, clear, dispose, doCalculation, getPeriod, getPeriodAlign, getPeriodStyle, getSeries, newInstance, recalculate, setPeriod, setPeriodAlign, setPeriodStyle, setSeries, valueList
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CurveFitting

public CurveFitting()

CurveFitting

public CurveFitting(IBaseChart c)
Method Detail

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class Function

getPolyDegree

public int getPolyDegree()
Defines fitted polynomial degree.
Default value: 5

Returns:
int

setPolyDegree

public void setPolyDegree(int value)
Defines fitted polynomial degree.
Default value: 5

Parameters:
value - int

getFactor

public int getFactor()
Multiplying factor.
Default value: 1

Returns:
int

setFactor

public void setFactor(int value)
Multiplying factor.
Default value: 1

Parameters:
value - int

getFirstCalcPoint

public int getFirstCalcPoint()
First point to be used in fitting.
Default value: -1

Returns:
int

setFirstCalcPoint

public void setFirstCalcPoint(int value)
First point to be used in fitting.
Default value: -1

Parameters:
value - int

getLastCalcPoint

public int getLastCalcPoint()
Last point to be used in fitting.
Default value: -1

Returns:
int

setLastCalcPoint

public void setLastCalcPoint(int value)
Last point to be used in fitting.
Default value: -1

Parameters:
value - int

getFirstPoint

public int getFirstPoint()
First point to be used in evaluating.
Default value: -1

Returns:
int

setFirstPoint

public void setFirstPoint(int value)
First point to be used in evaluating.
Default value: -1

Parameters:
value - int

getLastPoint

public int getLastPoint()
Last point to be used in evaluating.
Default value: -1

Returns:
int

setLastPoint

public void setLastPoint(int value)
Last point to be used in evaluating.
Default value: -1

Parameters:
value - int

coefficient

public double coefficient(int index)
Returns calculated fitted coefficient.

Parameters:
index - int
Returns:
double

getCurveYValue

public double getCurveYValue(Series s,
                             double x)
Evaluate function using calculated coefficients.

Parameters:
s - Series
x - double value to be evaluated
Returns:
double using calculated polynomial coefficients

addPoints

public void addPoints(java.util.Vector source)
Description copied from class: Function
Gets all points from Source series, performs a function operation and stores results in ParentSeries.

Overrides:
addPoints in class Function
Parameters:
source - ArrayList

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Function
Returns:
String