Package net.talvi.puffinplot.data

This package contains code to read, store, analyse, and write palaeomagnetic data.

See: Description

Interface Summary

Interface	Description
FisherParams	This interface provides access to the standard parameters for Fisherian spherical statistics: mean direction, alpha-95, and k.
SampleGroup	An interface for any grouping of samples (at time of writing: a Site, Suite, or CoreSection).
SampleRpiEstimate	An estimate of relative palaeointensity for a single sample.
Suite.SavedListener	A listener interface for modifications to the Suite's save state.
Suite.SiteNamer	A SiteNamer turns a sample name into a site name.

Class Summary

Class	Description
AmsData	This class holds AMS (anisotropy of magnetic susceptibility) data for a named sample.
ArasonLevi	Calculate and store Arason-Levi Maximum Likelihood Estimates (MLE) for inclination-only data.
ArasonLevi.ArithMean	Calculate and store mean inclination estimates based on a simple arithmetic mean.
CoreSection	A representation of a section of core, comprising a contiguous sequence of Samples.
CoreSections	A collection of CoreSections, stored as a linked hash map indexed by a string identifier.
Correction	This class represents the corrections which may be applied to the measured remanence to estimate the true remanence.
CsvWriter	This class provides a wrapper around a supplied Writer to allow easy writing of lines of data with fields separated by a particular string.
CustomFields<T>	Represents a set of custom fields for sample annotation.
Eigens	A class to calculate and store the eigenvalues and eigenvectors of a matrix.
FisherValues	This class calculates Fisher (1953) spherical statistics on sets of vectors.
GreatCircle	This class represents a great circle, created either directly by specifying a pole direction or indirectly by giving a list of vectors.
GreatCircles	This class represents a set of great circles and a set of directions.
KentParams	A class representing the parameters of a Kent confidence ellipse.
Line	A container class holding all the data within a suite from a particular line number of their respective files.
Location	Represents a location on the Earth's surface (latitude/longitude).
MagSusSampleRpiEstimate	An estimate of relative palaeointensity for a single sample, normalized by magnetic susceptibility.
MedianDestructiveField	This class calculates and stores the median destructive field (MDF) for a set of TreatmentStep objects.
PcaAnnotated	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.
PcaValues	This class performs three-dimension principal component analysis on a supplied collection of vectors and stores the results.
Sample	This class represents a sample on which measurements have been made.
SensorLengths	Represents the effective SQUID sensor lengths of a magnetometer, as determined by the response curves of the SQUID sensors.
Site	A site is a grouping of samples within a suite.
StepwiseSampleRpiEstimate	An estimate of relative palaeointensity for a single sample, normalized by a stepwise series of AF fields.
Suite	A suite of data, containing a number of samples.
SuiteCalcs	Represents a set of calculations for a suite of data.
SuiteCalcs.Means	Fisher statistics for the suite.
SuiteRpiEstimate<EstimateType extends SampleRpiEstimate>	A collection of RPI estimates.
Tensor	A second-order symmetric tensor used to represent the anisotropy of magnetic susceptibility.
TreatmentLevelComparator	A comparator that compares treatment steps according to their treatment level.
TreatmentStep	TreatmentStep is the fundamental data class of PuffinPlot.
TreatmentStep.Reader	This class allows TreatmentStep objects to be created from string representations of a specified format.
TreatmentStepMomentComparator	This class implements a specific type of comparison for datum objects.
Vec3	An immutable three-dimensional Cartesian vector.
VGP	A class representing a virtual geomagnetic pole.

Enum Summary

Enum	Description
AmsCalculationType	The type of a statistical calculation on AMS tensors.
ArmAxis	ArmAxis represents the axis along which an ARM (anhysteretic remanent magnetization) field has been applied.
CoreSection.End	A representation of the end of a core section -- top or bottom.
CoreSections.TargetDeclinationType	The declination which should be aligned with a reference alignment passed to {@link #alignSections(int, double, net.talvi.puffinplot.data.CoreSections.ReferenceAlignmentType) ).
Correction.Rotation	An enumeration of the types of rotation correction which may be applied to a sample's data.
FieldUnit	This enum represents a unit in which magnetic field strength can be measured.
FileType	The fields of this enum represent the types of file that PuffinPlot can read.
MeasurementAxis	An axis along which a magnetic moment measurement was made.
MeasurementType	The type of measurement which was performed on a sample or set of samples.
MomentUnit	This enum represents a unit in which magnetic dipole moment per unit volume can be measured.
RpiEstimateType	The parameter used in normalizing an NRM to produce an RPI estimate.
TreatmentParameter	This enum represents a data field in the TreatmentStep class which is associated with a measurement or other value.
TreatmentType	A type of treatment applied to a sample.

Exception Summary

Exception	Description

Package net.talvi.puffinplot.data Description

This package contains code to read, store, analyse, and write palaeomagnetic data. Most of the classes for reading data from files are in the file subpackage. None of the code refers to any GUI elements in the main PuffinPlot application, so these classes can be used for non-interactive analysis, even in a headless environment.