com.github.jessemull.microflexinteger.stat

Class DescriptiveStatistic

java.lang.Object

com.github.jessemull.microflexinteger.stat.DescriptiveStatistic

Direct Known Subclasses:

CoefficientOfVariation, DescriptiveStatisticWeights, InterquartileRange, Kurtosis, Max, MeanDeviation, Median, MedianDeviation, Min, Mode, PopulationStandardDeviation, QuartileDeviation, QuartileSkewness, Range, SampleStandardDeviation, Skewness, StandardError

public abstract class DescriptiveStatistic
extends Object

This class performs statistical operations for integer plate stacks, plates, wells and well sets. To create a custom statistical operation extend this class and override the calculate methods using the appropriate statistical operation.

Statistical operations can be performed on stacks, plates, sets and wells using standard or aggregated functions. Standard functions calculate the desired statistic for each well in the stack, plate or set. Aggregated functions aggregate the values from all the wells in the stack, plate or set and perform the statistical operation on the aggregated values. Both standard and aggregated functions can be performed on a subset of data within the stack, plate, set or well.

The methods within the MicroFlex library are meant to be flexible and the descriptive statistic object supports operations using a single stack, plate, set or well as well as collections and arrays of stacks, plates, sets or wells.

Operation	Beginning Index	Length of Subset	Input/Output
Standard	+/-	+/-	Accepts a single well, set, plate or stack as input Calculates the statistic for each well in a well, set, plate or stack
Aggregated	+/-	+/-	Accepts a single well/set/plate/stack or a collection/array of wells/sets/plates/stacks as input Aggregates the data from all the wells in a well/set/plate/stack and calculates the statistic using the aggregated data

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
DescriptiveStatistic()

Method Summary

Modifier and Type	Method and Description
abstract double	calculate(List<Double> list) Calculates the statistic.
abstract double	calculate(List<Double> list, int begin, int length) Calculates the statistic of the values between the beginning and ending indices.
Map<Well,Double>	plate(Plate plate) Returns the statistic for each plate well.
Map<Well,Double>	plate(Plate plate, int begin, int length) Returns the statistic for each plate well using the values between the beginning and ending indices.
Map<Plate,Double>	platesAggregated(Collection<Plate> collection) Returns the aggregated statistic for each plate.
Map<Plate,Double>	platesAggregated(Collection<Plate> collection, int begin, int length) Returns the aggregated statistic for each plate using the values between the indices.
double	platesAggregated(Plate plate) Returns the aggregated statistic for the plate.
Map<Plate,Double>	platesAggregated(Plate[] array) Returns the aggregated statistic for each plate.
Map<Plate,Double>	platesAggregated(Plate[] array, int begin, int length) Returns the aggregated statistic for each plate using the values between the indices.
double	platesAggregated(Plate plate, int begin, int length) Returns the aggregated statistic for each plate using the values between the indices.
Map<Well,Double>	set(WellSet set) Returns the statistic of each well in the well set.
Map<Well,Double>	set(WellSet set, int begin, int length) Returns the statistic of each well in the well set using the values between the beginning and ending indices.
Map<WellSet,Double>	setsAggregated(Collection<WellSet> collection) Returns the aggregated statistic for each well set.
Map<WellSet,Double>	setsAggregated(Collection<WellSet> collection, int begin, int length) Returns the aggregated statistic for each well set using the values between the indices.
double	setsAggregated(WellSet set) Returns the aggregated statistic for the well set.
Map<WellSet,Double>	setsAggregated(WellSet[] array) Returns the aggregated statistic for each well set.
Map<WellSet,Double>	setsAggregated(WellSet[] array, int begin, int length) Returns the aggregated statistic for each well set using the values between the indices.
double	setsAggregated(WellSet set, int begin, int length) Returns the aggregated statistic for each well set using the values between the indices.
double	well(Well well) Returns the well statistic.
double	well(Well well, int begin, int length) Returns the well statistic for the values between the beginning and ending indices.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescriptiveStatistic

public DescriptiveStatistic()

Method Detail

plate

public Map<Well,Double> plate(Plate plate)

Returns the statistic for each plate well.

Parameters:

Plate - the plate

Returns:

map of wells and results

plate

public Map<Well,Double> plate(Plate plate,
                              int begin,
                              int length)

Returns the statistic for each plate well using the values between the beginning and ending indices.

Parameters:

Plate - the plate

int - beginning index of subset

int - length of subset

Returns:

map of wells and results

platesAggregated

public double platesAggregated(Plate plate)

Returns the aggregated statistic for the plate.

Parameters:

Plate - the plate

Returns:

the aggregated result

platesAggregated

public Map<Plate,Double> platesAggregated(Collection<Plate> collection)

Returns the aggregated statistic for each plate.

Parameters:

Collection - collection of plates

Returns:

map of plates and aggregated results

platesAggregated

public Map<Plate,Double> platesAggregated(Plate[] array)

Returns the aggregated statistic for each plate.

Parameters:

PlateInteger[] - array of plates

Returns:

map of plates and aggregated result

platesAggregated

public double platesAggregated(Plate plate,
                               int begin,
                               int length)

Returns the aggregated statistic for each plate using the values between the indices.

Parameters:

Plate - the plate

int - beginning index of subset

int - length of subset

Returns:

the aggregated result

platesAggregated

public Map<Plate,Double> platesAggregated(Collection<Plate> collection,
                                          int begin,
                                          int length)

Returns the aggregated statistic for each plate using the values between the indices.

Parameters:

Collection - collection of plates

int - beginning index of subset

int - length of subset

Returns:

map of plates and aggregated results

platesAggregated

public Map<Plate,Double> platesAggregated(Plate[] array,
                                          int begin,
                                          int length)

Returns the aggregated statistic for each plate using the values between the indices.

Parameters:

PlateInteger[] - array of plates

int - beginning index of subset

int - length of subset

Returns:

map of plates and aggregated results

set

public Map<Well,Double> set(WellSet set)

Returns the statistic of each well in the well set.

Parameters:

WellSet - the well set

Returns:

map of wells and results

set

public Map<Well,Double> set(WellSet set,
                            int begin,
                            int length)

Returns the statistic of each well in the well set using the values between the beginning and ending indices.

Parameters:

WellSet - the well set

int - beginning index of subset

int - length of subset

Returns:

map of wells and results

setsAggregated

public double setsAggregated(WellSet set)

Returns the aggregated statistic for the well set.

Parameters:

WellSet - the well set

Returns:

the aggregated result

setsAggregated

public Map<WellSet,Double> setsAggregated(Collection<WellSet> collection)

Returns the aggregated statistic for each well set.

Parameters:

Collection - collection of well sets

Returns:

map of well sets and aggregated results

setsAggregated

public Map<WellSet,Double> setsAggregated(WellSet[] array)

Returns the aggregated statistic for each well set.

Parameters:

WellSetInteger[] - array of well sets

Returns:

map of well sets and aggregated results

setsAggregated

public double setsAggregated(WellSet set,
                             int begin,
                             int length)

Returns the aggregated statistic for each well set using the values between the indices.

Parameters:

WellSet - the well set

int - beginning index of subset

int - length of subset

Returns:

the aggregated result

setsAggregated

public Map<WellSet,Double> setsAggregated(Collection<WellSet> collection,
                                          int begin,
                                          int length)

Returns the aggregated statistic for each well set using the values between the indices.

Parameters:

Collection - collection of well sets

int - beginning index of subset

int - length of subset

Returns:

map of well sets and aggregated results

setsAggregated

public Map<WellSet,Double> setsAggregated(WellSet[] array,
                                          int begin,
                                          int length)

Returns the aggregated statistic for each well set using the values between the indices.

Parameters:

WellSetInteger[] - array of well sets

int - beginning index of subset

int - length of subset

Returns:

map of well sets and aggregated results

well

public double well(Well well)

Returns the well statistic.

Parameters:

Well - the well

Returns:

the result

well

public double well(Well well,
                   int begin,
                   int length)

Returns the well statistic for the values between the beginning and ending indices.

Parameters:

Well - the well

int - beginning index of subset

int - length of the subset

Returns:

the result

calculate

public abstract double calculate(List<Double> list)

Calculates the statistic.

Parameters:

List - the list

Returns:

the result

calculate

public abstract double calculate(List<Double> list,
                                 int begin,
                                 int length)

Calculates the statistic of the values between the beginning and ending indices.

Parameters:

List - the list

int - beginning index of subset

int - length of subset

Returns:

the result