public class OrientationParameters
extends java.lang.Object
VectorAndOrientations
class encapsulates the values
affected by OrientationParameters
.
The orientation parameters are defined in various documents published
by AGICO, Inc., Brno, Czech Republic, and used in various AGICO
instrument control and data processing programs. For more detail
on their definition and use, see e.g. Chadima and Hrouda (2007)
or AGICO (2017).
Puffinplot's own orientation convention corresponds to the values
P1=12, P2=90, P3=12, P4=0. The main purpose of this class is to aid
in the conversion of other orientation conventions to PuffinPlot's
convention when importing files.
References:
AGICO, 2017. REMA6W control software for JR-6/JR-6A spinner magnetometers,
version 6.2.4., Brno: AGICO.
https://www.agico.com/downloads/documents/manuals/rema6-man.pdf
Chadima, M. & Hrouda, F., 2007. Remasoft 3.0 paleomagnetic data browser
and analyzer user manual, Brno: AGICO.
https://www.agico.com/downloads/documents/manuals/remasoft-usermanual.pdfVectorAndOrientations
Modifier and Type | Class and Description |
---|---|
static class |
OrientationParameters.AzimuthParameter
A parameter representing an orientation convention for an azimuthal
angular value (e.g. the azimuthal orientation of a sample core).
|
static class |
OrientationParameters.DipParameter
A parameter representing an orientation convention for a vertical
angular measurement (e.g. the dip of a sample core).
|
Modifier and Type | Field and Description |
---|---|
OrientationParameters.AzimuthParameter |
p1
P1 is a clock value orientation of the Arrow which represents the x-axis
of Specimen coordinate system (right hand rule, see Legend).
|
OrientationParameters.DipParameter |
p2
P2 indicates which angle is measured as the specimen inclination.
|
OrientationParameters.AzimuthParameter |
p3
P3 is a clock value that indicates which Direction on the specimen
frontal plane (x-y plane) is measured using geological compass and
expressed as Azimuth.
|
OrientationParameters.DipParameter |
p4
P4 indicates how mesoscopic foliation adjacent to the specimen is
measured.
|
Constructor and Description |
---|
OrientationParameters(OrientationParameters.AzimuthParameter p1,
OrientationParameters.DipParameter p2,
OrientationParameters.AzimuthParameter p3,
OrientationParameters.DipParameter p4)
Creates an orientation parameter set from the specified parameters
values.
|
Modifier and Type | Method and Description |
---|---|
VectorAndOrientations |
convertToPuffinPlotConvention(VectorAndOrientations original)
This method takes a
VectorAndOrientations object
and interprets its contents according to the settings in this
OrientationParameters object. |
boolean |
equals(java.lang.Object other)
Compares equality of two orientation parameter sets.
|
int |
hashCode()
Returns a hash code for this parameter set.
|
static OrientationParameters |
read(int p1,
int p2,
int p3,
int p4)
Creates a orientation parameter set from the specified index
values for the required parameters.
|
static OrientationParameters |
read(java.lang.String p1,
java.lang.String p2,
java.lang.String p3,
java.lang.String p4)
Creates a orientation parameter set from the strings containing
index values for the required parameters.
|
public final OrientationParameters.AzimuthParameter p1
public final OrientationParameters.DipParameter p2
public final OrientationParameters.AzimuthParameter p3
public final OrientationParameters.DipParameter p4
public OrientationParameters(OrientationParameters.AzimuthParameter p1, OrientationParameters.DipParameter p2, OrientationParameters.AzimuthParameter p3, OrientationParameters.DipParameter p4)
p1
- Value for the P1 parameterp2
- Value for the P2 parameterp3
- Value for the P3 parameterp4
- Value for the P4 parameterpublic static OrientationParameters read(int p1, int p2, int p3, int p4)
p1
- Index value for the P1 parameter (3, 6, 9, or 12)p2
- Index value for the P2 parameter (0 or 90)p3
- Index value for the P3 parameter (3, 6, 9, or 12)p4
- Index value for the P4 parameter (0 or 90)public static OrientationParameters read(java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4)
p1
- String containing index value for the P1 parameter
(3, 6, 9, or 12)p2
- String containing index value for the P2 parameter (0 or 90)p3
- String containing index value for the P3 parameter
(3, 6, 9, or 12)p4
- String containing index value for the P4 parameter (0 or 90)public VectorAndOrientations convertToPuffinPlotConvention(VectorAndOrientations original)
VectorAndOrientations
object
and interprets its contents according to the settings in this
OrientationParameters
object. It returns a
VectorAndOrientations
object which, when
interpreted according to PuffinPlot's own orientation parameters,
represents the same vector and orientations as the
VectorAndOrientations
passed as input to the method.
More briefly: this method converts data from a the orientation
system represented by this object to PuffinPlot's own orientation
system.
PuffinPlot's own orientation parameter convention is:
P1=12, P2=90, P3=12, P4=0.original
- a vector and orientations, to be
interpreted according to the orientation parameters represented
by this objectpublic boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- the object with which to comparepublic int hashCode()
hashCode
in class java.lang.Object