net.talvi.puffinplot.data

Class CoreSection

java.lang.Object

net.talvi.puffinplot.data.CoreSection

All Implemented Interfaces:

SampleGroup

public class CoreSection
extends java.lang.Object
implements SampleGroup

A representation of a section of core, comprising a contiguous sequence of Samples. This can be useful, for instance, for rotating an entire section to align its declination with a neighbouring section.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreSection.End A representation of the end of a core section -- top or bottom.

Method Summary

Modifier and Type	Method and Description
static CoreSection	fromSamples(java.util.List<Sample> samples) Returns a core section containing the specified samples in the specified order.
Vec3	getDirectionNearEnd(CoreSection.End end, int nSamples) Calculates and returns the Fisherian mean direction of the topmost or bottommost samples in this section.
java.util.List<Sample>	getSamples()
java.util.List<Sample>	getSamplesNearEnd(CoreSection.End end, int nSamples) Returns the topmost or bottommost samples in this core section.
void	rotateDeclinations(double clockwiseDegrees) Rotates the declinations of all the data points in all the samples by the specified angle.

Methods inherited from class java.lang.Object

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

Method Detail

fromSamples

public static CoreSection fromSamples(java.util.List<Sample> samples)

Returns a core section containing the specified samples in the specified order. Note that the samples are not copied: the returned CoreSection contains references to the original samples, so operations upon it may modify them.

Parameters:

samples - a list of samples

Returns:

a core section containing the provided samples

getSamples

public java.util.List<Sample> getSamples()

Specified by:

getSamples in interface SampleGroup

Returns:

the samples in this core section

rotateDeclinations

public void rotateDeclinations(double clockwiseDegrees)

Rotates the declinations of all the data points in all the samples by the specified angle.

Parameters:

clockwiseDegrees - rotation angle

getSamplesNearEnd

public java.util.List<Sample> getSamplesNearEnd(CoreSection.End end,
                                                int nSamples)

Returns the topmost or bottommost samples in this core section.

Parameters:

end - the end from which to return the samples (top or bottom)

nSamples - the number of samples to return (from 0 to the number of samples in this section)

Returns:

the topmost or bottommost samples

getDirectionNearEnd

public Vec3 getDirectionNearEnd(CoreSection.End end,
                                int nSamples)

Calculates and returns the Fisherian mean direction of the topmost or bottommost samples in this section.

Parameters:

end - the section end (top or bottom)

nSamples - the number of samples to average

Returns:

the mean direction of the top or bottom samples

Throws:

java.lang.IllegalStateException - if none of the section end samples have a direction