net.talvi.puffinplot.data
Class PcaAnnotated

java.lang.Object
  extended by net.talvi.puffinplot.data.PcaAnnotated

public class PcaAnnotated
extends java.lang.Object

This class encapsulates a set of principal component analysis (PCA) parameters along with some data on the treatment steps from which the PCA was calculated. At present the treatment step data can only be read via the toStrings() method which is intended for export to a file.

See Also:
PcaValues

Method Summary
static PcaAnnotated calculate(Sample sample, Correction correction)
          Performs principal component analysis (PCA) on the specified sample.
static java.util.List<java.lang.String> getEmptyFields()
          Returns a list of empty strings equal in length to the number of parameters.
static java.util.List<java.lang.String> getHeaders()
          Returns the headers describing the parameters as a list of strings.
 PcaValues getPcaValues()
          Returns the results of the principal component analysis.
 java.util.List<java.lang.String> toStrings()
          Returns the parameters as a list of strings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

calculate

public static PcaAnnotated calculate(Sample sample,
                                     Correction correction)
Performs principal component analysis (PCA) on the specified sample. Points to use for PCA are determined using the Datum.isInPca() method. The starting and ending treatment steps are stored, as is a flag indicating whether the treatment step were contiguous.

Parameters:
sample - the sample on which to perform PCA
correction - the correction to apply to the magnetic moment data
Returns:
results of principal component analysis

getPcaValues

public PcaValues getPcaValues()
Returns the results of the principal component analysis.

Returns:
the results of the principal component analysis

toStrings

public java.util.List<java.lang.String> toStrings()
Returns the parameters as a list of strings. The order of the parameters is the same as the order of the headers provided by getHeaders().

Returns:
the parameters as a list of strings

getHeaders

public static java.util.List<java.lang.String> getHeaders()
Returns the headers describing the parameters as a list of strings.

Returns:
the headers describing the parameters

getEmptyFields

public static java.util.List<java.lang.String> getEmptyFields()
Returns a list of empty strings equal in length to the number of parameters.

Returns:
a list of empty strings equal in length to the number of parameters