net.talvi.puffinplot.data

Class SuiteRpiEstimate<EstimateType extends SampleRpiEstimate>

java.lang.Object

net.talvi.puffinplot.data.SuiteRpiEstimate<EstimateType>

Type Parameters:

EstimateType -

public class SuiteRpiEstimate<EstimateType extends SampleRpiEstimate>
extends java.lang.Object

A collection of RPI estimates. Instances of this class contain a list of the treatment levels used for the RPI calculation (if applicable), and a list of SampleRpiEstimate instances, each containing the RPI estimate(s) for a single sample.

Method Summary

Modifier and Type	Method and Description
static SuiteRpiEstimate<MagSusSampleRpiEstimate>	calculateWithMagSus(Suite nrmSuite, Suite msSuite) Estimate RPI by normalizing NRM to MS.
static SuiteRpiEstimate<StepwiseSampleRpiEstimate>	calculateWithStepwiseAF(Suite nrmSuite, Suite normalizerSuite, double minLevel, double maxLevel) Estimate RPI by normalizing a stepwise demagnetized NRM to another stepwise demagnetized remanence (ARM or IRM).
static SuiteRpiEstimate<StepwiseSampleRpiEstimate>	calculateWithStepwiseARM(Suite nrmSuite, Suite normalizerSuite, double minLevel, double maxLevel) Estimate RPI by normalizing a stepwise demagnetized NRM to a stepwise imparted ARM.
Suite	getNrmSuite()
java.util.List<EstimateType>	getRpis()
java.util.List<java.lang.Double>	getTreatmentLevels()
void	writeToFile(java.lang.String path) Write this RPI estimate to a CSV file.

Methods inherited from class java.lang.Object

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

Method Detail

writeToFile

public void writeToFile(java.lang.String path)
                 throws java.io.IOException

Write this RPI estimate to a CSV file.

Parameters:

path - the path of the file to which to write the data

Throws:

java.io.IOException - if an error occurred while writing the file

calculateWithMagSus

public static SuiteRpiEstimate<MagSusSampleRpiEstimate> calculateWithMagSus(Suite nrmSuite,
                                                                            Suite msSuite)

Estimate RPI by normalizing NRM to MS.

Parameters:

nrmSuite - suite containing NRM data

msSuite - suite containing magnetic susceptibility normalizer data

Returns:

a collection of RPI estimates

calculateWithStepwiseAF

public static SuiteRpiEstimate<StepwiseSampleRpiEstimate> calculateWithStepwiseAF(Suite nrmSuite,
                                                                                  Suite normalizerSuite,
                                                                                  double minLevel,
                                                                                  double maxLevel)

Estimate RPI by normalizing a stepwise demagnetized NRM to another stepwise demagnetized remanence (ARM or IRM).

Parameters:

nrmSuite - suite containing NRM data

normalizerSuite - suite containing AF demagnetization normalizer data

minLevel - lowest AF treatment level to consider

maxLevel - highest AF treatment level to consider

Returns:

a collection of RPI estimates

calculateWithStepwiseARM

public static SuiteRpiEstimate<StepwiseSampleRpiEstimate> calculateWithStepwiseARM(Suite nrmSuite,
                                                                                   Suite normalizerSuite,
                                                                                   double minLevel,
                                                                                   double maxLevel)

Estimate RPI by normalizing a stepwise demagnetized NRM to a stepwise imparted ARM. For a stepwise demagnetized ARM, calculateWithStepwiseAF(net.talvi.puffinplot.data.Suite, net.talvi.puffinplot.data.Suite, double, double) should be used.

Parameters:

nrmSuite - suite containing NRM data

normalizerSuite - suite containing ARM acquisition normalizer data

minLevel - lowest ARM treatment level to consider (AF intensity)

maxLevel - highest ARM treatment level to consider (AF intensity)

Returns:

a collection of RPI estimates

getTreatmentLevels

public java.util.List<java.lang.Double> getTreatmentLevels()

Returns:

the treatment levels from which this RPI estimate was calculated

getRpis

public java.util.List<EstimateType> getRpis()

Returns:

the RPI estimates for the individual samples

getNrmSuite

public Suite getNrmSuite()

Returns:

suite containing NRM values from which this RPI estimate was calculated