MaterialStats (Materials 0.80.0 API)

com.kazurayam.materials.stats.MaterialStats

referrences: - https://blog.apar.jp/data-analysis/4632/ - https://stackoverflow.com/questions/14758509/calculating-t-inverse-in-apache-commons

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MaterialStats.ConfidenceInterval`	Mimic of apache commons2 math ConfidenceInterval without parameter checks http://home.apache.org/~luc/commons-math-3.6-RC2-site/jacoco/org.apache.commons.math3.stat.interval/ConfidenceInterval.java.html

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`CRITERIA_PERCENTAGE_FORMAT`
`static double`	`DEFAULT_FILTER_DATA_LESS_THAN`
`static int`	`DEFAULT_MAXIMUM_NUMBER_OF_IMAGEDELTAS`
`static double`	`DEFAULT_PROBABILITY`
`static MaterialStats`	`NULL`
`static double`	`SUGGESTED_SHIFT_CRITERIA_PERCENTAGE_BY`
`static org.slf4j.Logger`	`logger_`

Constructor Summary

Constructors
Constructor and description
`MaterialStats (java.nio.file.Path path, java.util.List<ImageDelta> imageDeltaList)` @param path

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double[]`	`data()`
	`int`	`degree()` number of sample data @return
	`boolean`	`equals(java.lang.Object obj)` FIXME: too simple?
	`static MaterialStats`	`fromJsonObject(java.lang.Object jsonObject)` { "path": "main.TC_47News.visitSite/47NEWS_TOP.png", "degree": 5, "sum": 68.17, "mean": 13.634, "variance": 2.6882191428856, "standardDeviation": 1.6395789529283424, "tDistribution": 2.1318467859510317, "confidenceInterval": { "lowerBound": 12.070840401864046, "upperBound": 15.197159598135954 }, "criteriaPercentage": 40.20, "data": [ 16.86, 4.53, 2.83, 27.85, 16.1 ], "imageDeltaList": [ // list of ImageDelta objects ] }
	`MaterialStats.ConfidenceInterval`	`getConfidenceInterval()`
	`double`	`getCriteriaPercentage()` @return ConfidenceInterval.upperBound + shiftCriteriaPercentage
	`java.lang.String`	`getCriteriaPercentageAsString(java.lang.String fmt = CRITERIA_PERCENTAGE_FORMAT)`
	`ImageDelta`	`getImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)` @param a
	`java.util.List<ImageDelta>`	`getImageDeltaList()`
	`java.nio.file.Path`	`getPath()`
	`java.lang.String`	`getPathAsStringInUNIX()`
	`boolean`	`hasImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)` If this MaterialStats has an ImageDelta of a anb b, return true
	`int`	`hashCode()`
	`double`	`mean()`
	`void`	`setFilterDataLessThan(double value)`
	`void`	`setProbability(double value)`
	`void`	`setShiftCriteriaPercentageBy(double value)`
	`double`	`standardDeviation()`
	`double`	`sum()`
	`double`	`tDistribution()` @return calculate t-inverse with this.degree() degrees of FREEDOM %
	`java.lang.String`	`toJsonText()`
	`java.lang.String`	`toString()`
	`double`	`variance()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.String CRITERIA_PERCENTAGE_FORMAT
  - static final double DEFAULT_FILTER_DATA_LESS_THAN
  - static final int DEFAULT_MAXIMUM_NUMBER_OF_IMAGEDELTAS
  - static final double DEFAULT_PROBABILITY
  - static final MaterialStats NULL
  - static final double SUGGESTED_SHIFT_CRITERIA_PERCENTAGE_BY
  - static org.slf4j.Logger logger_
- Constructor Detail
  - MaterialStats(java.nio.file.Path path, java.util.List<ImageDelta> imageDeltaList)
    
    Parameters:
    path
    imageDeltaList
- Method Detail
  - double[] data()
  - int degree()
    
    number of sample data
    Returns:
  - @java.lang.Override boolean equals(java.lang.Object obj)
    
    FIXME: too simple? should consider data?
  - static MaterialStats fromJsonObject(java.lang.Object jsonObject)
```
 {
                    "path": "main.TC_47News.visitSite/47NEWS_TOP.png",
                    "degree": 5,
                    "sum": 68.17,
                    "mean": 13.634,
                    "variance": 2.6882191428856,
                    "standardDeviation": 1.6395789529283424,
                    "tDistribution": 2.1318467859510317,
                    "confidenceInterval": {
                        "lowerBound": 12.070840401864046,
                        "upperBound": 15.197159598135954
                    },
                    "criteriaPercentage": 40.20,
                    "data": [
                        16.86,
                        4.53,
                        2.83,
                        27.85,
                        16.1
                    ],
                    "imageDeltaList": [
                        // list of ImageDelta objects
                    ]
                }
 
```
    Parameters:
    json
    Returns:
  - MaterialStats.ConfidenceInterval getConfidenceInterval()
  - double getCriteriaPercentage()
    
    Returns:
    ConfidenceInterval.upperBound + shiftCriteriaPercentage
  - java.lang.String getCriteriaPercentageAsString(java.lang.String fmt = CRITERIA_PERCENTAGE_FORMAT)
  - ImageDelta getImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)
    
    Parameters:
    a
    b
    Returns:
    an ImageDelta object with TSuiteTimestamp a and b, else null
  - java.util.List<ImageDelta> getImageDeltaList()
  - java.nio.file.Path getPath()
  - java.lang.String getPathAsStringInUNIX()
  - boolean hasImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)
    
    If this MaterialStats has an ImageDelta of a anb b, return true
    Parameters:
    a
    b
    Returns:
  - @java.lang.Override int hashCode()
  - double mean()
  - void setFilterDataLessThan(double value)
  - void setProbability(double value)
  - void setShiftCriteriaPercentageBy(double value)
  - double standardDeviation()
  - double sum()
  - double tDistribution()
    
    Returns:
    calculate t-inverse with this.degree() degrees of FREEDOM %
  - java.lang.String toJsonText()
  - @java.lang.Override java.lang.String toString()
  - double variance()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class MaterialStats

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String CRITERIA_PERCENTAGE_FORMAT

static final double DEFAULT_FILTER_DATA_LESS_THAN

static final int DEFAULT_MAXIMUM_NUMBER_OF_IMAGEDELTAS

static final double DEFAULT_PROBABILITY

static final MaterialStats NULL

static final double SUGGESTED_SHIFT_CRITERIA_PERCENTAGE_BY

static org.slf4j.Logger logger_

Constructor Detail

MaterialStats(java.nio.file.Path path, java.util.List<ImageDelta> imageDeltaList)

Method Detail

double[] data()

int degree()

@java.lang.Override boolean equals(java.lang.Object obj)

static MaterialStats fromJsonObject(java.lang.Object jsonObject)

MaterialStats.ConfidenceInterval getConfidenceInterval()

double getCriteriaPercentage()

java.lang.String getCriteriaPercentageAsString(java.lang.String fmt = CRITERIA_PERCENTAGE_FORMAT)

ImageDelta getImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)

java.util.List<ImageDelta> getImageDeltaList()

java.nio.file.Path getPath()

java.lang.String getPathAsStringInUNIX()

boolean hasImageDelta(TSuiteTimestamp a, TSuiteTimestamp b)

@java.lang.Override int hashCode()

double mean()

void setFilterDataLessThan(double value)

void setProbability(double value)

void setShiftCriteriaPercentageBy(double value)

double standardDeviation()

double sum()

double tDistribution()

java.lang.String toJsonText()

@java.lang.Override java.lang.String toString()

double variance()