Dvector

java.lang.Object
- io.github.kensuke1984.kibrary.inversion.Dvector

```
public class Dvector
extends java.lang.Object
```
Am=d のdに対する情報 TODO 震源観測点ペア
basicDataFileから Dvectorを構築する
This class is immutable.
TODO 同じ震源観測点ペアの波形も周波数やタイムウインドウによってあり得るからそれに対処 varianceも

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

コンストラクタ
コンストラクタと説明
`Dvector(BasicID[] basicIDs)` Use all waveforms in the IDs.
`Dvector(BasicID[] basicIDs, java.util.function.Predicate<BasicID> chooser)` Use selected waveforms.
`Dvector(BasicID[] basicIDs, java.util.function.Predicate<BasicID> chooser, java.util.function.ToDoubleBiFunction<BasicID,BasicID> weightingFunction)` Use selected waveforms.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`org.apache.commons.math3.linear.RealVector`	`combine(org.apache.commons.math3.linear.RealVector[] vectors)` Every vector must have the same length as the corresponding timewindow.
`org.apache.commons.math3.linear.RealVector`	`getD()`
`double`	`getDNorm()`
`org.apache.commons.math3.linear.RealVector[]`	`getDVectors()` The returning vector is unmodifiable.
`java.util.Map<GlobalCMTID,java.lang.Double>`	`getEventVariance()`
`int[]`	`getLengths()`
`int`	`getNpts()`
`int`	`getNTimeWindow()`
`org.apache.commons.math3.linear.RealVector`	`getObs()`
`BasicID[]`	`getObsIDs()`
`double`	`getObsNorm()`
`org.apache.commons.math3.linear.RealVector[]`	`getObsVectors()`
`int`	`getStartPoints(int i)`
`java.util.Map<Station,java.lang.Double>`	`getStationVariance()`
`org.apache.commons.math3.linear.RealVector`	`getSyn()`
`BasicID[]`	`getSynIDs()`
`org.apache.commons.math3.linear.RealVector[]`	`getSynVectors()`
`java.util.Set<GlobalCMTID>`	`getUsedGlobalCMTIDset()`
`java.util.Set<Station>`	`getUsedStationSet()`
`double`	`getVariance()`
`double`	`getWeighting(int i)`
`void`	`outOrder(java.nio.file.Path outPath)` syn.dat del.dat obs.dat obsOrder synOrder.datを outDirectory下に書き込む
`void`	`outputVarianceOf(java.nio.file.Path outPath, org.apache.commons.math3.linear.RealVector[] vectors)` vectors（各タイムウインドウ）に対して、観測波形とのvarianceを求めてファイルに書き出す Create event folders under the outPath and variances are written for each path.
`org.apache.commons.math3.linear.RealVector[]`	`separate(org.apache.commons.math3.linear.RealVector vector)`

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

- コンストラクタの詳細
  - Dvector
```
public Dvector(BasicID[] basicIDs)
```
    Use all waveforms in the IDs. Weighting factor is the reciprocal of the maximum value in each obs time window.
    
    パラメータ:
    
    basicIDs - must contain waveform data
  - Dvector
```
public Dvector(BasicID[] basicIDs,
               java.util.function.Predicate<BasicID> chooser)
```
    Use selected waveforms. Weighting factor is reciprocal of maximum value in each obs time window.
    
    パラメータ:
    
    basicIDs - must contain waveform data
    
    chooser - Predicate for selection of obs data to be used
  - Dvector
```
public Dvector(BasicID[] basicIDs,
               java.util.function.Predicate<BasicID> chooser,
               java.util.function.ToDoubleBiFunction<BasicID,BasicID> weightingFunction)
```
    Use selected waveforms.
    
    パラメータ:
    
    basicIDs - must contain waveform data
    
    chooser - Predicate used for filtering Observed (not synthetic) ID. If one ID is true, then the observed ID and the pair synthetic are used.
    
    weightingFunction - ToDoubleBiFunction (observed, synthetic). If null, the reciprocal of the max value in observed is a weighting value.
- メソッドの詳細
  - getEventVariance
```
public java.util.Map<GlobalCMTID,java.lang.Double> getEventVariance()
```
    戻り値:
    
    map of variance of waveforms in each event
  - getStationVariance
```
public java.util.Map<Station,java.lang.Double> getStationVariance()
```
    戻り値:
    
    map of variance of waveforms for each station
  - combine
```
public org.apache.commons.math3.linear.RealVector combine(org.apache.commons.math3.linear.RealVector[] vectors)
```
    Every vector must have the same length as the corresponding timewindow.
    
    パラメータ:
    
    vectors - to combine
    
    戻り値:
    
    combined vectors
  - getDVectors
```
public org.apache.commons.math3.linear.RealVector[] getDVectors()
```
    The returning vector is unmodifiable.
    
    戻り値:
    
    Vectors consisting of dvector(obs-syn). Each vector is each timewindow. If you want to get the vector D, you may use combine(RealVector[])
  - getD
```
public org.apache.commons.math3.linear.RealVector getD()
```
    戻り値:
    
    vectors of residual between observed and synthetics (obs-syn)
  - getLengths
```
public int[] getLengths()
```
    戻り値:
    
    an array of each time window length.
  - getNpts
```
public int getNpts()
```
    戻り値:
    
    number of total data.
  - getNTimeWindow
```
public int getNTimeWindow()
```
    戻り値:
    
    number of timewindows
  - getObsIDs
```
public BasicID[] getObsIDs()
```
  - getObsVectors
```
public org.apache.commons.math3.linear.RealVector[] getObsVectors()
```
  - getObs
```
public org.apache.commons.math3.linear.RealVector getObs()
```
    戻り値:
    
    vector of observed waveforms
  - getStartPoints
```
public int getStartPoints(int i)
```
    パラメータ:
    
    i - index of timewindow
    
    戻り値:
    
    the index of start point where the i th timewindow starts
  - getSynIDs
```
public BasicID[] getSynIDs()
```
  - getSynVectors
```
public org.apache.commons.math3.linear.RealVector[] getSynVectors()
```
  - getSyn
```
public org.apache.commons.math3.linear.RealVector getSyn()
```
    戻り値:
    
    vector of synthetic waveforms.
  - getUsedGlobalCMTIDset
```
public java.util.Set<GlobalCMTID> getUsedGlobalCMTIDset()
```
  - getUsedStationSet
```
public java.util.Set<Station> getUsedStationSet()
```
    戻り値:
    
    set of stations in vector
  - getWeighting
```
public double getWeighting(int i)
```
    パラメータ:
    
    i - index for the weighting
    
    戻り値:
    
    weighting for the i th timewindow.
  - outOrder
```
public void outOrder(java.nio.file.Path outPath)
              throws java.io.IOException
```
    syn.dat del.dat obs.dat obsOrder synOrder.datを outDirectory下に書き込む
    
    パラメータ:
    
    outPath - Path for write
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - outputVarianceOf
```
public void outputVarianceOf(java.nio.file.Path outPath,
                             org.apache.commons.math3.linear.RealVector[] vectors)
                      throws java.io.IOException
```
    vectors（各タイムウインドウ）に対して、観測波形とのvarianceを求めてファイルに書き出す Create event folders under the outPath and variances are written for each path.
    
    パラメータ:
    
    outPath - Root for the write
    
    vectors - RealVectors for write
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - getVariance
```
public double getVariance()
```
    戻り値:
    
    ∑|obs-syn|²/∑|obs|²
  - getObsNorm
```
public double getObsNorm()
```
    戻り値:
    
    |obs|
  - getDNorm
```
public double getDNorm()
```
    戻り値:
    
    |obs-syn|
  - separate
```
public org.apache.commons.math3.linear.RealVector[] separate(org.apache.commons.math3.linear.RealVector vector)
```
    パラメータ:
    
    vector - to separate
    
    戻り値:
    
    Separated vectors for each time window. Error occurs if the input is invalid.

クラス Dvector

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

メソッドのサマリー

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

コンストラクタの詳細

Dvector

Dvector

Dvector

メソッドの詳細

getEventVariance

getStationVariance

combine

getDVectors

getD

getLengths

getNpts

getNTimeWindow

getObsIDs

getObsVectors

getObs

getStartPoints

getSynIDs

getSynVectors

getSyn

getUsedGlobalCMTIDset

getUsedStationSet

getWeighting

outOrder

outputVarianceOf

getVariance

getObsNorm

getDNorm

separate