public class Site
extends java.lang.Object
A site is a grouping of samples within a suite. In practice, it usually corresponds to a group of samples from a small physical area. In a discrete study, it usually corresponds to a physical field site within a section. In a long core study, it usually corresponds to a narrow ‘slice’ of the core between two defined depths.
Constructor and Description |
---|
Site(java.lang.String name)
Creates a site containing no samples.
|
Site(java.lang.String name,
java.util.List<Sample> samples)
Creates a site containing the specified samples.
|
Modifier and Type | Method and Description |
---|---|
void |
calculateFisherStats(Correction correction)
Calculate Fisherian statistics on the PCA directions of samples
within this site.
|
void |
calculateGreatCirclesDirection(Correction correction)
Calculate a mean direction for the site using best-fit great circles.
|
void |
calculateVgp()
Calculates a virtual geomagnetic pole for the site, if possible.
|
void |
clearFisherStats()
Clears the stored Fisher statistics, if any.
|
void |
clearGcFit()
Clears the stored great-circle fit parameters, if any
|
void |
fromString(java.lang.String string)
Sets site data from information in a string.
|
FisherParams |
getFisherParams()
Returns the Fisherian parameters of the site mean direction,
as calculated by Fisher statistics or great-circle analysis.
|
FisherValues |
getFisherValues()
Returns the Fisher statistics (if any) calculated for this site.
|
static java.util.List<java.lang.String> |
getGreatCircleLimitHeader()
Returns headers for information on the treatment steps used
for the great-circle analysis.
|
java.util.List<java.lang.String> |
getGreatCircleLimitStrings()
Returns information on the treatment steps used for the
great-circle analysis.
|
GreatCircles |
getGreatCircles()
Returns the great-circle parameters (if any) calculated for this site.
|
Location |
getLocation() |
Vec3 |
getMeanDirection()
Returns the site mean direction.
|
java.lang.String |
getName() |
java.util.List<Sample> |
getSamples()
Returns the samples in this site
|
VGP |
getVgp() |
boolean |
isEmpty()
Reports whether there are any samples in this site.
|
void |
setLocation(Location location) |
java.lang.String |
toString()
Returns the name of this site.
|
java.util.List<java.lang.String> |
toStrings()
Returns a list of strings giving information about this site.
|
public Site(java.lang.String name, java.util.List<Sample> samples)
name
- the name of the sitesamples
- the samples contained in the sitepublic Site(java.lang.String name)
name
- the name of the sitepublic void calculateFisherStats(Correction correction)
correction
- the correction to apply to the magnetic moment
data when performing the PCA calculationspublic void clearFisherStats()
public void calculateGreatCirclesDirection(Correction correction)
correction
- the correction to apply to the magnetic moment
data when fitting the great circles.GreatCircles
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List<Sample> getSamples()
public FisherValues getFisherValues()
public GreatCircles getGreatCircles()
public FisherParams getFisherParams()
public static java.util.List<java.lang.String> getGreatCircleLimitHeader()
public java.util.List<java.lang.String> getGreatCircleLimitStrings()
public void clearGcFit()
public java.lang.String getName()
public boolean isEmpty()
true
if there are no samples in this sitepublic java.util.List<java.lang.String> toStrings()
public void fromString(java.lang.String string)
toStrings()
.string
- a string containing site datapublic Location getLocation()
public void setLocation(Location location)
location
- the location to setpublic Vec3 getMeanDirection()
getFisherParams()
for details of how the mean
direction is chosen.public void calculateVgp()
public VGP getVgp()