public class KentParams
extends java.lang.Object
A class representing the parameters of a Kent confidence ellipse. It also provides methods to calculate the parameters from sets of tensors using programs from Lisa Tauxe's pmagpy suite.
For details of the pmagpy programs and anisotropy statistics, see Lisa Tauxe, Essentials of Paleomagnetism (University of California Press, 2010).
Constructor and Description |
---|
KentParams(double tau,
double tauSigma,
double dec,
double inc,
double etaMag,
double etaDec,
double etaInc,
double zetaMag,
double zetaDec,
double zetaInc)
Creates an object representing a Kent confidence ellipse defined
by the supplied parameters.
|
KentParams(java.lang.String line)
Creates an object representing a Kent confidence ellipse defined
by the parameters listed in the supplied string.
|
Modifier and Type | Method and Description |
---|---|
static java.util.List<KentParams> |
calculateBootstrap(java.util.List<Tensor> tensors,
boolean parametric,
java.lang.String scriptPath)
Calculates 95% Kent confidence ellipses from the supplied tensors
by running the
bootams.py script from Lisa Tauxe's
pmagpy suite. |
static java.util.List<KentParams> |
calculateHext(java.util.List<Tensor> tensors,
java.lang.String scriptPath)
Calculates 95% Kent confidence ellipses from the supplied tensors
by running the
s_hext.py script from Lisa Tauxe's
pmagpy suite. |
Vec3 |
getEtaDir()
Returns the direction of the confidence ellipse's first axis
|
double |
getEtaMag()
Returns the semiangle of the confidence ellipse's first axis
|
Vec3 |
getMean()
Returns the mean direction
|
double |
getTau()
Returns the tau value (eigenvalue of normalized mean susceptibility tensor).
|
double |
getTauSigma()
Returns (95% confidence region for tau)
|
Vec3 |
getZetaDir()
Returns the direction of the confidence ellipse's second axis
|
double |
getZetaMag()
Returns the semiangle of the confidence ellipse's second axis
|
public KentParams(double tau, double tauSigma, double dec, double inc, double etaMag, double etaDec, double etaInc, double zetaMag, double zetaDec, double zetaInc)
tau
- the tau value (eigenvalue of normalized mean susceptibility tensor)tauSigma
- (95% confidence region for tau)dec
- the mean declination in degreesinc
- the mean inclination in degreesetaMag
- the semiangle of the confidence ellipse's first axisetaDec
- the declination of the confidence ellipse's first axisetaInc
- the inclination of the confidence ellipse's first axiszetaMag
- the semiangle of the confidence ellipse's second axiszetaDec
- the declination of the confidence ellipse's second axiszetaInc
- the inclination of the confidence ellipse's second axispublic KentParams(java.lang.String line)
Creates an object representing a Kent confidence ellipse defined by the parameters listed in the supplied string. The parameters in the string should be separated by white space, and occur in the following order:
tau tau_sigma mean_dec mean_inc eta_semiangle eta_dec eta_inc zeta_semiangle zeta_dec zeta_inc
In the above, dec and inc refer to declination and inclination respectively; all angles are given in degrees.
line
- a string representation of the Kent parameterspublic static java.util.List<KentParams> calculateBootstrap(java.util.List<Tensor> tensors, boolean parametric, java.lang.String scriptPath) throws java.io.IOException
bootams.py
script from Lisa Tauxe's
pmagpy suite. The ellipses are calculated by bootstrap statistics.tensors
- the tensors on which to calculate statisticsparametric
- true
to use a parametric bootstrap; to use a ‘naïve’ bootstrapscriptPath
- filesystem path to the bootams.py
scriptjava.io.IOException
- if an I/O error occurredpublic static java.util.List<KentParams> calculateHext(java.util.List<Tensor> tensors, java.lang.String scriptPath) throws java.io.IOException
s_hext.py
script from Lisa Tauxe's
pmagpy suite. The ellipses are calculated by Hext statistics.
Note that no value is calculated for tau_sigma, which is set to
zero.tensors
- the tensors on which to calculate statisticsscriptPath
- filesystem path to the s_hext.py
scriptjava.io.IOException
- if an I/O error occurredpublic double getTau()
public double getTauSigma()
public Vec3 getMean()
public double getEtaMag()
public Vec3 getEtaDir()
public double getZetaMag()
public Vec3 getZetaDir()