Uses of Class
net.talvi.puffinplot.data.Vec3

Packages that use Vec3

Package	Description
net.talvi.puffinplot.data	This package contains code to read, store, analyse, and write palaeomagnetic data.
net.talvi.puffinplot.data.file	This package contains classes for reading palaeomagnetic data from a file.
net.talvi.puffinplot.plots	This package contains classes for plotting palaeomagnetic data.

Uses of Vec3 in net.talvi.puffinplot.data

Fields in net.talvi.puffinplot.data declared as Vec3

Modifier and Type	Field and Description
static Vec3	Vec3.DOWN a unit vector pointing down
static Vec3	Vec3.EAST a unit vector pointing east
static Vec3	Vec3.NORTH a unit vector pointing north
static Vec3	Vec3.ORIGIN the origin vector (zero along each axis)

Methods in net.talvi.puffinplot.data that return Vec3

Modifier and Type	Method and Description
Vec3	Vec3.addDecRad(double angle) Returns a new vector equal to this vector with the specified angle added to the declination.
Vec3	Vec3.addIncRad(double angle) Returns a new vector equal to this vector with the specified angle added to the inclination.
Vec3	Vec3.correctForm(double az, double dip) Applies a sample correction to this vector.
Vec3	Vec3.correctSample(double az, double dip) Applies a sample correction to this vector.
Vec3	Vec3.cross(Vec3 v) Returns the cross product of this vector and another vector.
Vec3	Vec3.divideBy(double a) Divides this vector by a scalar value.
Vec3	Vec3.divideBy(Vec3 v) Divides the components of this vector individually by the corresponding components of another vector.
static Vec3	Vec3.equatorPoint(Vec3 v0, Vec3 v1) Returns the unit vector on the intersection of the equator (z=0 line) and the great circle between the supplied points.
static Vec3	Vec3.fromPolarDegrees(double mag, double inc, double dec) Creates a vector from a polar specification in degrees.
static Vec3	Vec3.fromPolarRadians(double mag, double inc, double dec) Creates a vector from a polar specification in radians.
Vec3	Tensor.getAxis(int axis) Returns one of the tensor's three principal axes as a vector.
Vec3	PcaValues.getDirection() Returns the direction of the principal PCA axis.
Vec3	Sample.getDirection() Returns the sample direction.
Vec3	CoreSection.getDirectionNearEnd(CoreSection.End end, int nSamples) Calculates and returns the Fisherian mean direction of the topmost or bottommost samples in this section.
Vec3	KentParams.getEtaDir() Returns the direction of the confidence ellipse's first axis
Vec3	Sample.getImportedDirection() Returns the imported sample direction, if any.
Vec3	KentParams.getMean() Returns the mean direction
Vec3	FisherParams.getMeanDirection() Returns the mean direction.
Vec3	FisherValues.getMeanDirection()
Vec3	GreatCircles.getMeanDirection() Returns the best-fit mean direction for the supplied circles and directions.
Vec3	Site.getMeanDirection() Returns the site mean direction.
Vec3	TreatmentStep.getMoment() Strictly speaking, the name is not quite accurate: we do not deal with magnetic moment (which would be in Am2) but in magnetic dipole moment per unit volume (in A/m).
Vec3	TreatmentStep.getMoment(Correction correction) Returns the measured magnetic dipole moment per unit volume, as modified by the supplied correction.
Vec3	PcaValues.getOrigin() Returns the origin for the PCA fit.
Vec3	GreatCircle.getPole() Returns a pole to the fitted great circle.
Vec3	KentParams.getZetaDir() Returns the direction of the confidence ellipse's second axis
Vec3	Vec3.invert() Returns the inverse of this vector.
Vec3	GreatCircle.lastPoint() Returns the normalized final point used in the great-circle fit, if any.
static Vec3	Vec3.mean(java.util.Collection<Vec3> vectors) Returns the mean of a collection of vectors.
static Vec3	Vec3.meanDirection(java.util.Collection<Vec3> points) Returns the mean direction of a collection of unit vectors.
Vec3	Vec3.minus(Vec3 v) Subtracts another vector from this vector.
Vec3	GreatCircle.nearestOnCircle(Vec3 point) For a supplied direction, returns the nearest direction which lies on this great circle.
Vec3	Vec3.nearestOnCircle(Vec3 v) Using the enclosing vector to define the pole of a great circle G, this method accepts another unit vector v and returns the nearest unit vector to v which lies on G.
Vec3	Vec3.normalize() Normalizes this vector.
Vec3	Vec3.plus(Vec3 v) Adds this vector and another vector.
Vec3	Vec3.rot180(MeasurementAxis axis) Rotates the vector by 180 degrees about the specified axis.
Vec3	Vec3.rotY(double angle) Rotates this vector about the y axis.
Vec3	Vec3.rotZ(double angle) Rotates this vector about the z axis.
Vec3	Vec3.setX(double newX) Sets the x component of this vector.
Vec3	Vec3.setY(double newY) Sets the y component of this vector.
Vec3	Vec3.setZ(double newZ) Sets the z component of this vector.
static Vec3	Vec3.sum(java.util.Collection<Vec3> vectors) Returns the sum of a specified collection of vectors.
Vec3	Vec3.times(double a) Multiplies this vector by a scalar value.
Vec3	Vec3.times(Vec3 v) Multiplies the components of this vector individually by the corresponding components of another vector.
Vec3	Location.toVec3()
Vec3	SensorLengths.toVector() Returns the sensor lengths as a three-dimensional vector.
Vec3	Vec3.transform(double[][] matrix) Multiplies this vector by a supplied matrix.

Methods in net.talvi.puffinplot.data that return types with arguments of type Vec3

Modifier and Type	Method and Description
java.util.List<Vec3>	Sample.getCirclePoints(Correction correction) Returns the magnetic moment vectors used for the current great-circle fit.
java.util.List<Vec3>	FisherValues.getDirections() Returns a list of unit vectors representing the directions of the vectors on which these statistics were calculated.
java.util.List<Vec3>	GreatCircle.getPoints() Returns the normalized points to which the great circle was fitted, if any.
java.util.List<Vec3>	Eigens.getVectors() Returns the eigenvectors in order of decreasing eigenvalue.
java.util.List<Vec3>	Vec3.greatCirclePoints(int n, boolean closed) Returns a list of equally spaced points around a great circle having this vector as its pole.
static java.util.List<java.util.List<Vec3>>	Vec3.interpolateEquatorPoints(java.util.List<Vec3> vs) Given a list of points, return a list of lists containing the same points plus possible extras.
static java.util.List<Vec3>	Vec3.makeEllipse(KentParams kentParams) Returns a list of points outlining the confidence ellipse for a supplied set of Kent statistical parameters.
java.util.List<Vec3>	Vec3.makeSmallCircle(double radiusDegrees) Returns a list of vectors defining a small circle around this vector's direction.
static java.util.List<Vec3>	Vec3.spherInterpDir(Vec3 v0, Vec3 v1, Vec3 onPath, double stepSize) Interpolates a great-circle path in a chosen direction between two specified vectors.
static java.util.List<Vec3>	Vec3.spherInterpolate(Vec3 v0, Vec3 v1, double stepSize) Given two vectors, interpolates unit vectors along a great-circle path between them.

Methods in net.talvi.puffinplot.data with parameters of type Vec3

Modifier and Type	Method and Description
double	GreatCircle.angleFromLast(Vec3 v) Returns the angle between the supplied direction and the last point on the great-circle fit.
double	Vec3.angleTo(Vec3 v) Returns the signed angle between this vector and another vector.
Vec3	Vec3.cross(Vec3 v) Returns the cross product of this vector and another vector.
double	Vec3.distance(Vec3 v) Returns the distance between two vectors.
Vec3	Vec3.divideBy(Vec3 v) Divides the components of this vector individually by the corresponding components of another vector.
double	Vec3.dot(Vec3 v) Returns the dot product of this vector and another vector.
boolean	Vec3.equals(Vec3 v, double precision) Compares vectors for equality to a specified precision.
static Vec3	Vec3.equatorPoint(Vec3 v0, Vec3 v1) Returns the unit vector on the intersection of the equator (z=0 line) and the great circle between the supplied points.
static Tensor	Tensor.fromDirections(Vec3 k1, Vec3 k2, Vec3 k3) Creates a tensor with the specified axes.
static GreatCircle	GreatCircle.fromPole(Vec3 pole) Create a great circle with the given pole.
static Location	Location.fromVec3(Vec3 vector)
Vec3	Vec3.minus(Vec3 v) Subtracts another vector from this vector.
Vec3	GreatCircle.nearestOnCircle(Vec3 point) For a supplied direction, returns the nearest direction which lies on this great circle.
Vec3	Vec3.nearestOnCircle(Vec3 v) Using the enclosing vector to define the pole of a great circle G, this method accepts another unit vector v and returns the nearest unit vector to v which lies on G.
Vec3	Vec3.plus(Vec3 v) Adds this vector and another vector.
boolean	Vec3.sameHemisphere(Vec3 v) Returns true if and only if the supplied vector is in the same (upper/lower) hemisphere as this one.
void	Sample.setImportedDirection(Vec3 importedDirection) Sets an imported direction for this sample.
void	TreatmentStep.setMoment(Vec3 v) Sets the sample's magnetic dipole moment per unit volume in A/m.
static java.util.List<Vec3>	Vec3.spherInterpDir(Vec3 v0, Vec3 v1, Vec3 onPath, double stepSize) Interpolates a great-circle path in a chosen direction between two specified vectors.
static java.util.List<Vec3>	Vec3.spherInterpolate(Vec3 v0, Vec3 v1, double stepSize) Given two vectors, interpolates unit vectors along a great-circle path between them.
Vec3	Vec3.times(Vec3 v) Multiplies the components of this vector individually by the corresponding components of another vector.

Method parameters in net.talvi.puffinplot.data with type arguments of type Vec3

Modifier and Type	Method and Description
static FisherValues	FisherValues.calculate(java.util.Collection<Vec3> vectors) Returns a set of Fisherian statistics, calculated using the Fisher (1953) method, for a collection of vectors.
static SuiteCalcs.Means	SuiteCalcs.Means.calculate(java.util.Collection<Vec3> directions) Calculate Fisher statistics on a set of directions.
static PcaValues	PcaValues.calculate(java.util.List<Vec3> points, boolean anchored) Performs principal component analysis (PCA) on the supplied vectors and returns an object containing the results of the analysis.
static GreatCircle	GreatCircle.fromBestFit(java.util.List<Vec3> vectors) Constructs a best-fitting great circle for the supplied vectors.
static Eigens	Eigens.fromVectors(java.util.Collection<Vec3> vectors, boolean normalize) Create an orientation tensor from the supplied vectors, then return the results of eigen analysis upon the constructed matrix.
static GreatCircles	GreatCircles.instance(java.util.List<Vec3> endpoints, java.util.List<GreatCircle> circles, java.lang.String validityCondition) Calculates a mean direction from the supplied great circle and directions.
static java.util.List<java.util.List<Vec3>>	Vec3.interpolateEquatorPoints(java.util.List<Vec3> vs) Given a list of points, return a list of lists containing the same points plus possible extras.
static Vec3	Vec3.mean(java.util.Collection<Vec3> vectors) Returns the mean of a collection of vectors.
static Vec3	Vec3.meanDirection(java.util.Collection<Vec3> points) Returns the mean direction of a collection of unit vectors.
static Vec3	Vec3.sum(java.util.Collection<Vec3> vectors) Returns the sum of a specified collection of vectors.

Constructors in net.talvi.puffinplot.data with parameters of type Vec3

Constructor and Description
TreatmentStep(Vec3 vector) Creates a treatment step with a supplied magnetization vector.

Uses of Vec3 in net.talvi.puffinplot.data.file

Fields in net.talvi.puffinplot.data.file declared as Vec3

Modifier and Type	Field and Description
Vec3	VectorAndOrientations.vector A vector measured relative to a sample's own co-ordinate system; in practice, most likely to be a magnetization vector.

Methods in net.talvi.puffinplot.data.file that return Vec3

Modifier and Type	Method and Description
Vec3	OrientationParameters.AzimuthParameter.rotateForP1(Vec3 vector) Rotates a vector from a P1=this system to a P1=12 system.

Methods in net.talvi.puffinplot.data.file with parameters of type Vec3

Modifier and Type	Method and Description
Vec3	OrientationParameters.AzimuthParameter.rotateForP1(Vec3 vector) Rotates a vector from a P1=this system to a P1=12 system.

Constructors in net.talvi.puffinplot.data.file with parameters of type Vec3

Constructor and Description
VectorAndOrientations(Vec3 vector, double sampleAzimuth, double sampleDip, double formationAzimuth, double formationDip) Instantiate a VectorAndOrientations object.

Uses of Vec3 in net.talvi.puffinplot.plots

Methods in net.talvi.puffinplot.plots with parameters of type Vec3

Modifier and Type	Method and Description
protected void	EqualAreaPlot.drawGreatCircle(Vec3 pole, boolean drawPole) Projects and draws a great circle
protected void	EqualAreaPlot.drawGreatCircleSegment(Vec3 v0, Vec3 v1) Draws the projection of a specified great-circle segment.
protected void	EqualAreaPlot.drawGreatCircleSegment(Vec3 v0, Vec3 v1, Vec3 dir) Draws the projection of a specified great-circle segment.
protected java.awt.geom.Point2D.Double	EqualAreaPlot.project(Vec3 v) Projects the direction of a three-dimensional vector into plot co-ordinates.
protected LineCache	EqualAreaPlot.projectGreatCircleSegment(Vec3 v0, Vec3 v1) Create a projection of a great-circle segment.

Method parameters in net.talvi.puffinplot.plots with type arguments of type Vec3

Modifier and Type	Method and Description
protected void	EqualAreaPlot.drawLineSegments(java.util.List<Vec3> vs) Projects and draws the supplied vectors.
protected void	EqualAreaPlot.projectLineSegments(java.util.List<Vec3> vs, LineCache cache) Project and cache line segments.
protected java.awt.geom.Path2D.Double	EqualAreaPlot.vectorsToPath(java.util.List<Vec3> vectors) Projects a list of three-dimensional vectors into a two-dimensional path in the current plot co-ordinates.