com.github.jessemull.microflexinteger.stat

Class DescriptiveStatisticWeights

java.lang.Object

com.github.jessemull.microflexinteger.stat.DescriptiveStatistic

com.github.jessemull.microflexinteger.stat.DescriptiveStatisticWeights

Direct Known Subclasses:

ContraharmonicMean, GeometricMean, HarmonicMean, Mean, PopulationVariance, Product, SampleVariance, Sum, SumOfSquares

public abstract class DescriptiveStatisticWeights
extends DescriptiveStatistic

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

From wikipedia: a weight function is a mathematical device used when performing a sum, integral, or average to give some elements more "weight" or influence on the result than other elements in the same set. In statistics a weighted function is often used to correct bias. The weighted statistic class implements a weighted function by accepting an array of values as weights. The values in each well of the stack, plate, set or well are multiplied by the values within the double array prior to the statistical calculation.

Weighted 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 weighted 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 and an array of weights as input Multiplies the values in each well of a well, set, plate or stack by the values in the weights array then calculates the statistic using the weighted values
Aggregated	+/-	+/-	Accepts a single well/set/plate/stack or a collection/array of wells/sets/plates/stacks and an array of weights as input Multiplies the values in each well of a well, set, plate or stack by the values in the weights array, aggregates the data from all the wells in the well/set/plate/stack then calculates the statistic using the aggregated weighted values

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
DescriptiveStatisticWeights()

Method Summary

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

Methods inherited from class com.github.jessemull.microflexinteger.stat.DescriptiveStatistic

calculate, calculate, plate, plate, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, set, set, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, well, well

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptiveStatisticWeights

public DescriptiveStatisticWeights()

Method Detail

plate

public Map<Well,Double> plate(Plate plate,
                              double[] weights)

Returns the weighted statistic for each plate well.

Parameters:

Plate - the plate

double[] - weights for the data set

Returns:

map of wells and results

plate

public Map<Well,Double> plate(Plate plate,
                              double[] weights,
                              int begin,
                              int length)

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

Parameters:

Plate - the plate

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

map of wells and results

platesAggregated

public double platesAggregated(Plate plate,
                               double[] weights)

Returns the aggregated weighted statistic for the plate.

Parameters:

Plate - the plate

double[] - weights for the data set

Returns:

the aggregated result

platesAggregated

public Map<Plate,Double> platesAggregated(Collection<Plate> collection,
                                          double[] weights)

Returns the aggregated weighted statistic for each plate.

Parameters:

Collection - collection of plates

double[] - weights for the data set

Returns:

map of plates and aggregated results

platesAggregated

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

Returns the aggregated weighted statistic for each plate.

Parameters:

PlateInteger[] - array of plates

double[] - weights for the data set

Returns:

map of plates and aggregated results

platesAggregated

public double platesAggregated(Plate plate,
                               double[] weights,
                               int begin,
                               int length)

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

Parameters:

Plate - the plate

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

the aggregated result

platesAggregated

public Map<Plate,Double> platesAggregated(Collection<Plate> collection,
                                          double[] weights,
                                          int begin,
                                          int length)

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

Parameters:

Collection - collection of plates

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

map of plates and aggregated results

platesAggregated

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

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

Parameters:

PlateInteger[] - array of plates

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

map of plates and aggregated results

set

public Map<Well,Double> set(WellSet set,
                            double[] weights)

Returns the weighted statistic of each well in the well set.

Parameters:

WellSet - the well set

double[] - weights for the data set

Returns:

map of wells and results

set

public Map<Well,Double> set(WellSet set,
                            double[] weights,
                            int begin,
                            int length)

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

Parameters:

WellSet - the well set

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

map of wells and results

setsAggregated

public double setsAggregated(WellSet set,
                             double[] weights)

Returns the aggregated weighted statistic for the well set.

Parameters:

WellSet - the well set

double[] - weights for the data set

Returns:

the aggregated results

setsAggregated

public Map<WellSet,Double> setsAggregated(Collection<WellSet> collection,
                                          double[] weights)

Returns the aggregated weighted statistic for each well set.

Parameters:

Collection - collection of well sets

double[] - weights for the data set

Returns:

map of well sets and aggregated results

setsAggregated

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

Returns the aggregated weighted statistic for each well set.

Parameters:

WellSetInteger[] - array of well sets

double[] - weights for the data set

Returns:

map of well sets and aggregated results

setsAggregated

public double setsAggregated(WellSet set,
                             double[] weights,
                             int begin,
                             int length)

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

Parameters:

WellSet - the well set

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

the aggregated result

setsAggregated

public Map<WellSet,Double> setsAggregated(Collection<WellSet> collection,
                                          double[] weights,
                                          int begin,
                                          int length)

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

Parameters:

Collection - collection of well sets

double[] - weights for the data set

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,
                                          double[] weights,
                                          int begin,
                                          int length)

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

Parameters:

WellSetInteger[] - array of well sets

double[] - weights for the data set

int - beginning index of subset

int - length of subset

Returns:

map of well sets and aggregated results

well

public double well(Well well,
                   double[] weights)

Returns the weighted well statistic.

Parameters:

Well - the well

double[] - weights for the data set

Returns:

the result

well

public double well(Well well,
                   double[] weights,
                   int begin,
                   int length)

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

Parameters:

Well - the well

double[] - weights for the data set

int - beginning index of subset

int - length of the subset

Returns:

the result

calculate

public abstract double calculate(List<Double> list,
                                 double[] weights)

Calculates the weighted statistic.

Parameters:

List - the list

double[] - weights for the data set

Returns:

the result

calculate

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

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

Parameters:

List - the list

double[] - weights of the data set

int - beginning index of subset

int - length of subset

Returns:

the result