InversionResult

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

public class InversionResult
extends java.lang.Object

Utilities for write of LetMeInvert.

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

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

InversionResult(java.nio.file.Path rootPath)

コンストラクタ
コンストラクタと説明
`InversionResult(java.nio.file.Path rootPath)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`double`	`aicOf(double a, InverseMethodEnum inverse, int n)`
`java.util.Map<UnknownParameter,java.lang.Double>`	`answerMapOf(InverseMethodEnum inverse, int n)` Example, if you want to get an answer of CG1.
`Trace`	`bornOf(BasicID id, InverseMethodEnum method, int n)` If the born waveform already is computed and in a file then, read and return it.
`static double`	`complement(java.util.Map<UnknownParameter,java.lang.Double> answer, int nPoints, int nPower, Location location, PartialType type)`
`void`	`createBorn(InverseMethodEnum method, int n)` Computes born waveforms of the answer by using n basis vector in the method for all time windows.
`java.util.List<BasicID>`	`getBasicIDList()`
`org.apache.commons.math3.linear.RealVector`	`getDVector()`
`java.util.Map<GlobalCMTID,java.lang.Double>`	`getEventVariance()`
`double`	`getInitialAIC(double a)`
`double`	`getInitialVariance()`
`int`	`getNumberOfDatapoints()`
`int`	`getNumberOfUnknowns()`
`int`	`getNumberOfWindows()`
`org.apache.commons.math3.linear.RealVector`	`getObservedVector()`
`double`	`getStartTimeDifference(int i)`
`java.util.Map<Station,java.lang.Double>`	`getStationVariance()`
`org.apache.commons.math3.linear.RealVector`	`getSyntheticVector()`
`java.util.List<UnknownParameter>`	`getUnknownParameterList()`
`java.util.Set<GlobalCMTID>`	`idSet()`
`Trace`	`observedOf(BasicID id)`
`Trace`	`partialOf(BasicID id, UnknownParameter parameter)`
`java.util.Set<Station>`	`stationSet()`
`Trace`	`syntheticOf(BasicID id)`
`double`	`varianceOf(InverseMethodEnum inverse, int n)`

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

- コンストラクタの詳細
  - InversionResult
```
public InversionResult(java.nio.file.Path rootPath)
                throws java.io.IOException
```
    パラメータ:
    
    rootPath - of an inversion
    
    例外:
    
    java.io.IOException - if an I/O error occurs
- メソッドの詳細
  - complement
```
public static double complement(java.util.Map<UnknownParameter,java.lang.Double> answer,
                                int nPoints,
                                int nPower,
                                Location location,
                                PartialType type)
```
    パラメータ:
    
    answer - map of the answer
    
    nPoints - number of points
    
    nPower - 距離の何乗で補間するか
    
    location - location for complement
    
    type - PartialType
    
    戻り値:
    
    locationの直近nPoints点からの補間値
  - getUnknownParameterList
```
public java.util.List<UnknownParameter> getUnknownParameterList()
```
    戻り値:
    
    (unmodifiable) List of unknown parameters
  - getBasicIDList
```
public java.util.List<BasicID> getBasicIDList()
```
    戻り値:
    
    (unmodifiable) List of BasicID in order. Observed IDs.
  - getNumberOfWindows
```
public int getNumberOfWindows()
```
    戻り値:
    
    Number of timewindow
  - getNumberOfUnknowns
```
public int getNumberOfUnknowns()
```
    戻り値:
    
    Number of unknown parameters (m)
  - getStartTimeDifference
```
public double getStartTimeDifference(int i)
```
    パラメータ:
    
    i - index of the order in vectors
    
    戻り値:
    
    Difference of Start time ( observed - synthetic )
  - getDVector
```
public org.apache.commons.math3.linear.RealVector getDVector()
                                                      throws org.apache.commons.math3.exception.DimensionMismatchException,
                                                             java.io.IOException
```
    戻り値:
    
    vector of residual (observed-synthetic) waveforms in an observed equation
    
    例外:
    
    java.io.IOException - if any
    
    org.apache.commons.math3.exception.DimensionMismatchException
  - getObservedVector
```
public org.apache.commons.math3.linear.RealVector getObservedVector()
                                                             throws java.io.IOException
```
    戻り値:
    
    vector of observed waveforms in an observed equation
    
    例外:
    
    java.io.IOException - if any
  - getSyntheticVector
```
public org.apache.commons.math3.linear.RealVector getSyntheticVector()
                                                              throws java.io.IOException
```
    戻り値:
    
    vector of synthetic waveforms in an observed equation
    
    例外:
    
    java.io.IOException - if any
  - varianceOf
```
public double varianceOf(InverseMethodEnum inverse,
                         int n)
```
    パラメータ:
    
    inverse - the method for the inverse problem
    
    n - the index for the answer 1 ≤ n
    
    戻り値:
    
    the variance between obs and born with the answer of the n
  - aicOf
```
public double aicOf(double a,
                    InverseMethodEnum inverse,
                    int n)
```
    パラメータ:
    
    a - assumed redundancy in data points. It is used as n/a, where n is the number of data points, note that n/a will be (int)(n/a).
    
    inverse - the method for the inverse problem
    
    n - the index for the answer 1 ≤ n
    
    戻り値:
    
    the Akaike Information criterion for the answer
  - getNumberOfDatapoints
```
public int getNumberOfDatapoints()
```
    戻り値:
    
    the number of datapoints (NPTS)
  - partialOf
```
public Trace partialOf(BasicID id,
                       UnknownParameter parameter)
                throws java.io.IOException
```
    パラメータ:
    
    id - ID of the partial
    
    parameter - index of a partial in unknown parameters
    
    戻り値:
    
    Trace of parN in nth time window. time axis is Synthetic one
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - answerMapOf
```
public java.util.Map<UnknownParameter,java.lang.Double> answerMapOf(InverseMethodEnum inverse,
                                                                    int n)
                                                             throws java.io.IOException
```
    Example, if you want to get an answer of CG1.
    inverse → CG, n → 1
    Keys of the returning map are unknown parameters.
    
    パラメータ:
    
    inverse - used solver
    
    n - the number of used eigen vectors for the answer
    
    戻り値:
    
    Map of answer values
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - observedOf
```
public Trace observedOf(BasicID id)
                 throws java.io.IOException
```
    パラメータ:
    
    id - id of an observed waveform (This ID must be in the list by getBasicIDList())
    
    戻り値:
    
    Trace of n th observed waveforms. Time axis is observed one.
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - syntheticOf
```
public Trace syntheticOf(BasicID id)
                  throws java.io.IOException
```
    パラメータ:
    
    id - ID of the order in vector (This ID must be in the list by getBasicIDList())
    
    戻り値:
    
    Trace of n th synthetic waveforms. Time axis is syn
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - stationSet
```
public java.util.Set<Station> stationSet()
```
  - idSet
```
public java.util.Set<GlobalCMTID> idSet()
```
    戻り値:
    
    (unmodifiable) Set of used GlobalCMT ids
  - bornOf
```
public Trace bornOf(BasicID id,
                    InverseMethodEnum method,
                    int n)
             throws java.io.IOException
```
    If the born waveform already is computed and in a file then, read and return it. If not, this method computes a born waveform and returns it and write in a certain folder.
    
    パラメータ:
    
    id - of the target raypath
    
    method - of inversion
    
    n - number of eigen vectors(SVD) or CG vectors (CG) or...
    if it is 1 and method is CG then CG1
    
    戻り値:
    
    Trace of Born
    
    例外:
    
    java.io.IOException - if any
  - createBorn
```
public void createBorn(InverseMethodEnum method,
                       int n)
                throws java.io.IOException
```
    Computes born waveforms of the answer by using n basis vector in the method for all time windows. This method also creates 'eachVariance', 'eventVariance', 'stationVariance' (.txt)
    
    パラメータ:
    
    method - to solve an equation
    
    n - the number of used basis vector
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - getStationVariance
```
public java.util.Map<Station,java.lang.Double> getStationVariance()
```
    戻り値:
    
    (unmodifiable)Map of variance (obs vs syn) for a station.
  - getEventVariance
```
public java.util.Map<GlobalCMTID,java.lang.Double> getEventVariance()
```
    戻り値:
    
    (unmodifiable)Map of variance (obs vs syn) for an event.
  - getInitialVariance
```
public double getInitialVariance()
```
    戻り値:
    
    the variance between obs and syn (initial model)
  - getInitialAIC
```
public double getInitialAIC(double a)
```
    パラメータ:
    
    a - assumed redundancy in data points. It is used as n/a, where n is the number of data points, note that n/a will be (int)(n/a).
    
    戻り値:
    
    the Akaike Information criterion for the initial model. (k=0)

クラス InversionResult

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

メソッドのサマリー

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

コンストラクタの詳細

InversionResult

メソッドの詳細

complement

getUnknownParameterList

getBasicIDList

getNumberOfWindows

getNumberOfUnknowns

getStartTimeDifference

getDVector

getObservedVector

getSyntheticVector

varianceOf

aicOf

getNumberOfDatapoints

partialOf

answerMapOf

observedOf

syntheticOf

stationSet

idSet

bornOf

createBorn

getStationVariance

getEventVariance

getInitialVariance

getInitialAIC