DataCoverageDescriptors (Ambit 2 4.0.1-SNAPSHOT API)

java.lang.Object
- ambit2.model.numeric.DataCoverage<Jama.Matrix>
- - ambit2.model.numeric.DataCoverageDescriptors

All Implemented Interfaces:

IDataCoverage<Jama.Matrix>, Serializable

Direct Known Subclasses:

DataCoverageDensity, DataCoverageDistance
```
public class DataCoverageDescriptors
extends DataCoverage<Jama.Matrix>
```
A parent class for all classes that estimate applicability domain in descriptor space This clas estimates descriptor ranges in PCA space

Author:

Nina Jeliazkova
Modified 2005-4-7

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`boxcox`
`protected DatasetCenterPoint`	`datasetCenterPoint`
`protected double[]`	`maxdata`
`protected double[]`	`mindata`
`protected boolean`	`pca`
`protected OrthogonalTransform`	`pcaTransform`
`protected boolean`	`scale`

Fields inherited from class ambit2.model.numeric.DataCoverage
appDomainMethodType, logger, object, pThreshold, threshold

Constructor Summary

Constructors
Constructor and Description
`DataCoverageDescriptors()` DataCoverage constructor Default mode modeRANGE
`DataCoverageDescriptors(ADomainMethodType mode)` DataCoverage constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[]`	`assess(Jama.Matrix matrix)`
`double`	`assessTransformed(double[] points, int nd)` does not perform transformation (e.g.
`boolean`	`build(Jama.Matrix data)`
`void`	`clear()`
`protected double`	`doAssessment(double[] points, int nd)`
`protected double[]`	`doAssessment(Jama.Matrix points, int np, int nd)` does the actual assessment, to be overrided by inherited class
`protected void`	`doEstimation(Jama.Matrix points, int np, int nd)` does the actual estimation, to be overrided by inherited class
`boolean`	`estimate(Jama.Matrix m)`
`protected double`	`estimateThreshold(double percent, double[] values)`
`DatasetCenterPoint`	`getDatasetCenterPoint()`
`double[]`	`getMaxdata()`
`double[]`	`getMindata()`
`String`	`getName()`
`Jama.Matrix`	`inverseTransform(Jama.Matrix points)` perform an inverse transformation of points the result is stored in the second argument
`boolean`	`isBoxcox()`
`boolean`	`isEmpty()`
`boolean`	`isPca()`
`boolean`	`isScale()`
`double[]`	`predict(Jama.Matrix data)`
`void`	`setBoxcox(boolean boxcox)`
`void`	`setCmode(DatasetCenterPoint cmode)`
`void`	`setDatasetCenterPoint(DatasetCenterPoint datasetCenterPoint)`
`void`	`setPca(boolean pca)`
`void`	`setScale(boolean scale)`
`String`	`toString()`

Methods inherited from class ambit2.model.numeric.DataCoverage
clone, getAppDomainMethodType, getDomain, getDomain, getDomainName, getId, getMetricName, getPoints, getPThreshold, setAppDomainMethodType, setDomainName, setMetricName, setMode, setParameters, setPThreshold

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - datasetCenterPoint
```
protected DatasetCenterPoint datasetCenterPoint
```
  - scale
```
protected boolean scale
```
  - pca
```
protected boolean pca
```
  - boxcox
```
protected boolean boxcox
```
  - mindata
```
protected double[] mindata
```
  - maxdata
```
protected double[] maxdata
```
  - pcaTransform
```
protected OrthogonalTransform pcaTransform
```
- Constructor Detail
  - DataCoverageDescriptors
```
public DataCoverageDescriptors()
```
    DataCoverage constructor Default mode modeRANGE
  - DataCoverageDescriptors
```
public DataCoverageDescriptors(ADomainMethodType mode)
```
    DataCoverage constructor
    
    Parameters:
    
    mode - - ADomainMethodType _modeRANGE = 0, _modeLEVERAGE = 1; modeEUCLIDEAN = 2, _modeCITYBLOCK = 3, _modeMAHALANOBIS = 4, _modeDENSITY = 5;
- Method Detail
  - clear
```
public void clear()
```
    Overrides:
    
    clear in class DataCoverage<Jama.Matrix>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IDataCoverage<Jama.Matrix>
    
    Overrides:
    
    isEmpty in class DataCoverage<Jama.Matrix>
  - isBoxcox
```
public boolean isBoxcox()
```
    Returns:
    
    Returns the boxcox.
  - setBoxcox
```
public void setBoxcox(boolean boxcox)
```
    Parameters:
    
    boxcox - The boxcox to set.
  - isPca
```
public boolean isPca()
```
    Returns:
    
    Returns the pca.
  - setPca
```
public void setPca(boolean pca)
```
    Parameters:
    
    pca - The pca to set.
  - isScale
```
public boolean isScale()
```
    Returns:
    
    Returns the scale.
  - setScale
```
public void setScale(boolean scale)
```
    Parameters:
    
    scale - The scale to set.
  - inverseTransform
```
public Jama.Matrix inverseTransform(Jama.Matrix points)
                             throws Exception
```
    perform an inverse transformation of points
    the result is stored in the second argument
    
    Parameters:
    
    points - The points to be transformed by the inverse transform
    
    Returns:
    
    the transformed points
    
    Throws:
    
    Exception
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class DataCoverage<Jama.Matrix>
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class DataCoverage<Jama.Matrix>
  - setCmode
```
public void setCmode(DatasetCenterPoint cmode)
```
    Parameters:
    
    cmode - - as in DatasetCenterPoint _cmodeCenter = 1;_cmodeMean = 0;_cmodeOrigin = 2;
  - estimateThreshold
```
protected double estimateThreshold(double percent,
                                   double[] values)
```
  - getDatasetCenterPoint
```
public DatasetCenterPoint getDatasetCenterPoint()
```
  - setDatasetCenterPoint
```
public void setDatasetCenterPoint(DatasetCenterPoint datasetCenterPoint)
```
  - getMaxdata
```
public double[] getMaxdata()
```
    Returns:
    
    Returns the maxdata.
  - getMindata
```
public double[] getMindata()
```
    Returns:
    
    Returns the mindata.
  - predict
```
public double[] predict(Jama.Matrix data)
```
  - build
```
public boolean build(Jama.Matrix data)
```
  - doAssessment
```
protected double[] doAssessment(Jama.Matrix points,
                                int np,
                                int nd)
```
    does the actual assessment, to be overrided by inherited class
    
    Parameters:
    
    points -
    
    np -
    
    nd -
    
    Returns:
    
    double[]
  - assess
```
public double[] assess(Jama.Matrix matrix)
```
    Parameters:
    
    points -
    
    Returns:
    
    double[] vector containing estimated coverage
  - doEstimation
```
protected void doEstimation(Jama.Matrix points,
                            int np,
                            int nd)
```
    does the actual estimation, to be overrided by inherited class
    
    Parameters:
    
    points -
    
    np -
    
    nd -
  - estimate
```
public boolean estimate(Jama.Matrix m)
```
  - assessTransformed
```
public double assessTransformed(double[] points,
                                int nd)
```
    does not perform transformation (e.g. PCA)
    Assumes that point is already in a transformed space
    
    Parameters:
    
    points -
    
    nd -
    
    Returns:
    
    true if successful
  - doAssessment
```
protected double doAssessment(double[] points,
                              int nd)
```
    Parameters:
    
    points -
    
    nd -
    
    Returns:
    
    double[]

Class DataCoverageDescriptors

Field Summary

Fields inherited from class ambit2.model.numeric.DataCoverage

Constructor Summary

Method Summary

Methods inherited from class ambit2.model.numeric.DataCoverage

Methods inherited from class java.lang.Object

Field Detail

datasetCenterPoint

scale

pca

boxcox

mindata

maxdata

pcaTransform

Constructor Detail

DataCoverageDescriptors

DataCoverageDescriptors

Method Detail

clear

isEmpty

isBoxcox

setBoxcox

isPca

setPca

isScale

setScale

inverseTransform

toString

getName

setCmode

estimateThreshold

getDatasetCenterPoint

setDatasetCenterPoint

getMaxdata

getMindata

predict

build

doAssessment

assess

doEstimation

estimate

assessTransformed

doAssessment