Trace

java.lang.Object
- io.github.kensuke1984.kibrary.util.Trace

```
public class Trace
extends java.lang.Object
```
Utility for a function y = f(x)
This class is IMMUTABLE
TODO sorted

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Trace(double[] x, double[] y)
Deep copy

コンストラクタ
コンストラクタと説明
`Trace(double[] x, double[] y)` Deep copy

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`Trace`	`add(Trace trace)` x in this and trace must be same. i.e. all the x elements must be same
`double`	`average()`
`static Trace`	`createTrace(java.nio.file.Path path)`
`static Trace`	`createTrace(java.nio.file.Path path, int xColumn, int yColumn)` All lines are trimmed.
`Trace`	`cutWindow(double start, double end)` thisの start ≤ x ≤ endの部分を切り抜く
`Trace`	`cutWindow(Timewindow timeWindow)`
`static int`	`findBestShift(double[] base, double[] compare)` 最も相関の高い位置を探す探し方は、短い方をずらしていく同じ長さだと探さない。
`double`	`findBestShift(Trace trace)` Assume the interval of x is same as that of this.
`int`	`getLength()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`double`	`getNearestX(double target)`
`int`	`getNearestXIndex(double target)`
`double[]`	`getX()`
`double`	`getXAt(int i)`
`double`	`getXforMaxValue()`
`double`	`getXforMinValue()`
`org.apache.commons.math3.linear.RealVector`	`getXVector()`
`double[]`	`getY()`
`double`	`getYAt(int i)`
`org.apache.commons.math3.linear.RealVector`	`getYVector()`
`int[]`	`indexOfDownwardConvex()` 0 < (y(x[i])-y(x[i-1])) * (y(x[i]) - y(x[i+1])) and y[i] < y[i-1]
`int[]`	`indexOfPeaks()` peak is defined as 0 < (y(x[i])-y(x[i-1]))*(y(x[i])-y(x[i+1]))
`int[]`	`indexOfUpwardConvex()` 0 < (y(x[i])-y(x[i-1]))*(y(x[i])-y(x[i+1])) and y[i-1] < t[i]
`Trace`	`multiply(double d)`
`Trace`	`shiftX(double shift)` f(x) → f(x-shift) Shifts "shift" in the direction of x axis.
`double`	`standardDeviation()` 1/n×Σ(y_i - ymean)²
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`toPolynomial(int n)` compute n th polynomial functions for the trace
`double`	`toValue(int n, double c)` x=cの点でのyの値をfをn次関数として補完する補完の際には直近のn+1点で補完 f(x) = Σ a_i xⁱ
`void`	`write(java.nio.file.Path path, java.nio.file.OpenOption... options)` Writes X and Y.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - Trace
```
public Trace(double[] x,
             double[] y)
```
    Deep copy
    
    パラメータ:
    
    x - array for X
    
    y - array for Y
- メソッドの詳細
  - createTrace
```
public static Trace createTrace(java.nio.file.Path path,
                                int xColumn,
                                int yColumn)
                         throws java.io.IOException
```
    All lines are trimmed. Lines starting with 'c' '!' '#' are ignored.
    
    パラメータ:
    
    path - of the file you want to read
    
    xColumn - indicates which column is x (for the first column → 0)
    
    yColumn - indicates which column is y
    
    戻り値:
    
    Trace made by the file of the path
    
    例外:
    
    java.io.IOException - if any
  - createTrace
```
public static Trace createTrace(java.nio.file.Path path)
                         throws java.io.IOException
```
    パラメータ:
    
    path - of a file
    
    戻り値:
    
    Trace of x in the first column and y in the second column
    
    例外:
    
    java.io.IOException - if any
  - findBestShift
```
public static int findBestShift(double[] base,
                                double[] compare)
```
    最も相関の高い位置を探す探し方は、短い方をずらしていく同じ長さだと探さない。
    
    パラメータ:
    
    base - array
    
    compare - array
    
    戻り値:
    
    compareを何ポイントずらすか 0だと先頭から
  - getXAt
```
public double getXAt(int i)
```
    パラメータ:
    
    i - index for x [0, length -1]
    
    戻り値:
    
    x[i]
  - getYAt
```
public double getYAt(int i)
```
    パラメータ:
    
    i - index for y [0, length -1]
    
    戻り値:
    
    y[i]
  - getLength
```
public int getLength()
```
    戻り値:
    
    the number of elements
  - toPolynomial
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction toPolynomial(int n)
```
    compute n th polynomial functions for the trace
    
    パラメータ:
    
    n - degree of polynomial
    
    戻り値:
    
    n th PolynomialFunction fitted to this
  - shiftX
```
public Trace shiftX(double shift)
```
    f(x) → f(x-shift) Shifts "shift" in the direction of x axis. If you want to change like below:
    x:(3, 4, 5) → (0, 1, 2)
    f(3) → f'(0) then the value 'shift' should be -3
    
    パラメータ:
    
    shift - value of shift
    
    戻り値:
    
    f (x - shift), the values in y are deep copied.
  - toValue
```
public double toValue(int n,
                      double c)
```
    x=cの点でのyの値をfをn次関数として補完する補完の際には直近のn+1点で補完 f(x) = Σ a_i xⁱ
    
    パラメータ:
    
    n - degree of function for interpolation
    
    c - point for the value
    
    戻り値:
    
    y = f(c) = Σ a_i cⁱ
  - getNearestX
```
public double getNearestX(double target)
```
    パラメータ:
    
    target - value of x to look for the nearest x value to
    
    戻り値:
    
    the closest x to the target
  - indexOfPeaks
```
public int[] indexOfPeaks()
```
    peak is defined as 0 < (y(x[i])-y(x[i-1]))*(y(x[i])-y(x[i+1]))
    
    戻り値:
    
    index of a peak (ordered)
  - indexOfDownwardConvex
```
public int[] indexOfDownwardConvex()
```
    0 < (y(x[i])-y(x[i-1])) * (y(x[i]) - y(x[i+1])) and y[i] < y[i-1]
    
    戻り値:
    
    index of downward convex
  - indexOfUpwardConvex
```
public int[] indexOfUpwardConvex()
```
    0 < (y(x[i])-y(x[i-1]))*(y(x[i])-y(x[i+1])) and y[i-1] < t[i]
    
    戻り値:
    
    index of downward convex
  - getNearestXIndex
```
public int getNearestXIndex(double target)
```
    パラメータ:
    
    target - value of x to look for the nearest x value to
    
    戻り値:
    
    the index of the closest x to the target
  - findBestShift
```
public double findBestShift(Trace trace)
```
    Assume the interval of x is same as that of this.
    
    パラメータ:
    
    trace - which length must be shorter than this.
    
    戻り値:
    
    the shift value x0 in x direction for best correlation.
  - cutWindow
```
public Trace cutWindow(double start,
                       double end)
```
    thisの start ≤ x ≤ endの部分を切り抜く
    
    パラメータ:
    
    start - start x of window
    
    end - end x of window
    
    戻り値:
    
    対象部分のtraceを返す (deep copy)
  - cutWindow
```
public Trace cutWindow(Timewindow timeWindow)
```
    パラメータ:
    
    timeWindow - Timewindow for cut
    
    戻り値:
    
    timeWindowの内部に属する部分を切り取ったものをnewして返す
  - getX
```
public double[] getX()
```
    戻り値:
    
    DEEP copy of x
  - getY
```
public double[] getY()
```
    戻り値:
    
    DEEP copy of y
  - getXforMaxValue
```
public double getXforMaxValue()
```
    戻り値:
    
    x which gives maximum y
  - getXforMinValue
```
public double getXforMinValue()
```
    戻り値:
    
    x which gives minimum y
  - getMaxValue
```
public double getMaxValue()
```
    戻り値:
    
    maximum value of y
  - getMinValue
```
public double getMinValue()
```
    戻り値:
    
    minimum value of y
  - getXVector
```
public org.apache.commons.math3.linear.RealVector getXVector()
```
    戻り値:
    
    (deep) copy of x
  - getYVector
```
public org.apache.commons.math3.linear.RealVector getYVector()
```
    戻り値:
    
    (deep) copy of y
  - add
```
public Trace add(Trace trace)
```
    x in this and trace must be same. i.e. all the x elements must be same
    
    パラメータ:
    
    trace - to be added
    
    戻り値:
    
    new Trace after the addition
  - multiply
```
public Trace multiply(double d)
```
    パラメータ:
    
    d - to be multiplied
    
    戻り値:
    
    Trace which y is multiplied d
  - average
```
public double average()
```
    戻り値:
    
    the average value of y
  - standardDeviation
```
public double standardDeviation()
```
    1/n×Σ(y_i - ymean)²
    
    戻り値:
    
    standard deviation of y
  - write
```
public void write(java.nio.file.Path path,
                  java.nio.file.OpenOption... options)
           throws java.io.IOException
```
    Writes X and Y. Each line has X_i and Y_i
    
    パラメータ:
    
    path - of the write file
    
    options - if any
    
    例外:
    
    java.io.IOException - if any

クラス Trace

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Trace

メソッドの詳細

createTrace

createTrace

findBestShift

getXAt

getYAt

getLength

toPolynomial

shiftX

toValue

getNearestX

indexOfPeaks

indexOfDownwardConvex

indexOfUpwardConvex

getNearestXIndex

findBestShift

cutWindow

cutWindow

getX

getY

getXforMaxValue

getXforMinValue

getMaxValue

getMinValue

getXVector

getYVector

add

multiply

average

standardDeviation

write