public class Correction
extends java.lang.Object
This class represents the corrections which may be applied to the measured remanence to estimate the true remanence. The main corrections are the orientation corrections for sample and formation orientations. The class also contains facilities for handling tray corrections (subtracting the tray remanence) and empty-slot corrections (monitoring the measured remanence of an empty measurement slot to correct for instrument drift). At present, these are not actually used by PuffinPlot: the tray correction is applied when the data file is first loaded, and the empty-slot correction is not implemented.
Note that this class does not contain any of the data for actually applying to corrections; it just determines which corrections should be applied.
Modifier and Type | Class and Description |
---|---|
static class |
Correction.Rotation
An enumeration of the types of rotation correction which may
be applied to a sample's data.
|
Modifier and Type | Field and Description |
---|---|
static Correction |
NONE
The null correction.
|
Constructor and Description |
---|
Correction(boolean tray,
boolean empty,
Correction.Rotation rotation,
boolean magDevAppliedToFormation)
Creates a new set of corrections
|
Modifier and Type | Method and Description |
---|---|
static Correction |
fromString(java.lang.String string)
Creates a correction from the supplied string.
|
java.lang.String |
getDescription()
Returns a user-friendly string describing this correction.
|
Correction.Rotation |
getRotation()
Returns the rotation correction.
|
boolean |
includesEmpty()
Returns
true if this correction includes an empty-slot
correction. |
boolean |
includesFormation()
Returns
true if this correction includes a rotation for formation
orientation. |
boolean |
includesSample()
Returns
true if this correction includes a rotation for sample
orientation. |
boolean |
includesTray()
Returns
true if this correction includes a correction for tray
remanence. |
boolean |
isMagDevAppliedToFormation() |
void |
setMagDevAppliedToFormation(boolean magDevAppliedToFormation) |
void |
setRotation(Correction.Rotation rotation)
Sets the rotation correction.
|
java.lang.String |
toString()
Returns a parseable string representation of this correction.
|
public static final Correction NONE
public Correction(boolean tray, boolean empty, Correction.Rotation rotation, boolean magDevAppliedToFormation)
tray
- true
to use the tray correctionempty
- true} to use the empty slot correctionrotation
- the type of rotation correction to usemagDevAppliedToFormation
- if true, magnetic deviation correction
will be applied to formation correctionpublic void setRotation(Correction.Rotation rotation)
rotation
- the type of rotation correction to usepublic Correction.Rotation getRotation()
public boolean isMagDevAppliedToFormation()
public void setMagDevAppliedToFormation(boolean magDevAppliedToFormation)
magDevAppliedToFormation
- the magDevAppliedToFormation to setpublic java.lang.String getDescription()
public boolean includesSample()
true
if this correction includes a rotation for sample
orientation. This is the case if the rotation is SAMPLE
or FORMATION
.true
if this correction includes
a rotation for sample orientationpublic boolean includesFormation()
true
if this correction includes a rotation for formation
orientation. This is the case if the rotation is FORMATION
.true
if this correction includes a rotation for formation
orientationpublic boolean includesTray()
true
if this correction includes a correction for tray
remanence.true
if this correction includes a correction for tray
remanencepublic boolean includesEmpty()
true
if this correction includes an empty-slot
correction.true
if this correction includes an empty-slot correctionpublic java.lang.String toString()
getDescription()
for a user-friendly description.toString
in class java.lang.Object
getDescription()
,
fromString(java.lang.String)
public static Correction fromString(java.lang.String string)
toString()
.string
- a string representation of the correction to be createdtoString()