TreatmentParameter

java.lang.Object
- java.lang.Enum<TreatmentParameter>
- - net.talvi.puffinplot.data.TreatmentParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TreatmentParameter>
```
public enum TreatmentParameter
extends java.lang.Enum<TreatmentParameter>
```
This enum represents a data field in the TreatmentStep class which is associated with a measurement or other value. It is used to address data values from TreatmentStep in a uniform way, for example when loading or saving data.
Each field has a heading, a string representation intended for use when reading or writing data from to to a file, and a nice name, a string representation intended to be displayed to the user. In practice these are currently identical for all existing fields, but this should not be relied upon.
Fields are classed as either ‘real’ (corresponding to an actual stored item of data) or ‘virtual’ (corresponding to data which is not explicitly stored but can be calculated on-the-fly from other data). The distinction is useful when storing data to a file, since virtual fields do not need to be stored.

See Also:

TreatmentStep

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AF_X` for treatments involving AF, the AF x-axis field strength in Tesla
`AF_Y` for treatments involving AF, the AF y-axis field strength in Tesla
`AF_Z` for treatments involving AF, the AF z-axis field strength in Tesla
`AREA` the cross-sectional area of a continuous core
`ARM_AXIS` for ARM treatment, the axis along which the biasing field was applied
`ARM_FIELD` for ARM treatment, the biasing field strength in Tesla
`DEPTH` the depth in the core of a continuous measurement
`DISCRETE_ID` the identifier (name) of a discrete sample
`FORM_AZ` the formation dip azimuth in degrees
`FORM_DIP` the formation dip angle in degrees
`IRM_FIELD` for IRM treatment, the field strength in Tesla
`MAG_DEV` the local geomagnetic field declination at the sampling site
`MAG_SUS` the measured magnetic susceptibility
`MEAS_TYPE` the type of the measurement (discrete or continuous)
`PP_ANCHOR_PCA` whether PCA fits are to be anchored for this datum
`PP_HIDDEN` whether this datum should be hidden on plots
`PP_INPCA` whether this datum is used for a PCA fit
`PP_ONCIRCLE` whether this datum is used for a great-circle fit
`PP_SELECTED` the selection state of the datum
`RUN_NUMBER` the number of the machine run during which the measurements were made
`SAMPLE_AZ` the sample dip azimuth in degrees
`SAMPLE_DIP` the sample dip angle in degrees
`SLOT_NUMBER` for discrete samples, the position of the sample on the measurement tray
`TEMPERATURE` for thermal treatment, the temperature in degrees Celsius
`TIMESTAMP` the timestamp of the measurement
`TREATMENT` the type of treatment applied before measurement (thermal, AF, etc.)
`VIRT_DECLINATION` declination of magnetization vector (degrees)
`VIRT_FORM_STRIKE` the strike of the formation orientation (degrees)
`VIRT_INCLINATION` inclination of magnetization vector (degrees)
`VIRT_MAGNETIZATION` the intensity of the magnetic dipole moment per unit volume (‘magnetization’)
`VIRT_MSJUMP` the temperature at which the magnetic susceptibility increases sharply
`VIRT_SAMPLE_HADE` the hade of a discrete sample (degrees)
`VOLUME` the volume of a discrete sample
`X_MOMENT` the x component of the magnetic moment measurement
`Y_MOMENT` the y component of the magnetic moment measurement
`Z_MOMENT` the z component of the magnetic moment measurement

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TreatmentParameter`	`getByHeading(java.lang.String heading)` Returns the field whose heading string is the specified string, or `null` if no such field exists.
`java.lang.String`	`getDefaultValue()` Returns this field's default value.
`java.lang.String`	`getHeading()` Returns the heading string for this field.
`java.lang.String`	`getNiceName()` Returns this field's ‘nice name’ (string representation for display to user)
`static java.util.List<TreatmentParameter>`	`getRealFields()` Returns an unmodifiable list of the real fields.
`static java.util.List<java.lang.String>`	`getRealFieldStrings()` Returns an unmodifiable list of the string representations of the real fields.
`java.lang.Class`	`getType()` Returns the type of this field (double, String, etc.).
`boolean`	`isImportable()` Reports whether this field is importable.
`boolean`	`isVirtual()` Reports whether this field is virtual.
`static TreatmentParameter`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TreatmentParameter[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DISCRETE_ID
```
public static final TreatmentParameter DISCRETE_ID
```
    the identifier (name) of a discrete sample
  - DEPTH
```
public static final TreatmentParameter DEPTH
```
    the depth in the core of a continuous measurement
  - RUN_NUMBER
```
public static final TreatmentParameter RUN_NUMBER
```
    the number of the machine run during which the measurements were made
  - TIMESTAMP
```
public static final TreatmentParameter TIMESTAMP
```
    the timestamp of the measurement
  - SLOT_NUMBER
```
public static final TreatmentParameter SLOT_NUMBER
```
    for discrete samples, the position of the sample on the measurement tray
  - MEAS_TYPE
```
public static final TreatmentParameter MEAS_TYPE
```
    the type of the measurement (discrete or continuous)
  - X_MOMENT
```
public static final TreatmentParameter X_MOMENT
```
    the x component of the magnetic moment measurement
  - Y_MOMENT
```
public static final TreatmentParameter Y_MOMENT
```
    the y component of the magnetic moment measurement
  - Z_MOMENT
```
public static final TreatmentParameter Z_MOMENT
```
    the z component of the magnetic moment measurement
  - MAG_SUS
```
public static final TreatmentParameter MAG_SUS
```
    the measured magnetic susceptibility
  - VOLUME
```
public static final TreatmentParameter VOLUME
```
    the volume of a discrete sample
  - AREA
```
public static final TreatmentParameter AREA
```
    the cross-sectional area of a continuous core
  - SAMPLE_AZ
```
public static final TreatmentParameter SAMPLE_AZ
```
    the sample dip azimuth in degrees
  - SAMPLE_DIP
```
public static final TreatmentParameter SAMPLE_DIP
```
    the sample dip angle in degrees
  - FORM_AZ
```
public static final TreatmentParameter FORM_AZ
```
    the formation dip azimuth in degrees
  - FORM_DIP
```
public static final TreatmentParameter FORM_DIP
```
    the formation dip angle in degrees
  - MAG_DEV
```
public static final TreatmentParameter MAG_DEV
```
    the local geomagnetic field declination at the sampling site
  - TREATMENT
```
public static final TreatmentParameter TREATMENT
```
    the type of treatment applied before measurement (thermal, AF, etc.)
  - AF_X
```
public static final TreatmentParameter AF_X
```
    for treatments involving AF, the AF x-axis field strength in Tesla
  - AF_Y
```
public static final TreatmentParameter AF_Y
```
    for treatments involving AF, the AF y-axis field strength in Tesla
  - AF_Z
```
public static final TreatmentParameter AF_Z
```
    for treatments involving AF, the AF z-axis field strength in Tesla
  - TEMPERATURE
```
public static final TreatmentParameter TEMPERATURE
```
    for thermal treatment, the temperature in degrees Celsius
  - IRM_FIELD
```
public static final TreatmentParameter IRM_FIELD
```
    for IRM treatment, the field strength in Tesla
  - ARM_FIELD
```
public static final TreatmentParameter ARM_FIELD
```
    for ARM treatment, the biasing field strength in Tesla
  - ARM_AXIS
```
public static final TreatmentParameter ARM_AXIS
```
    for ARM treatment, the axis along which the biasing field was applied
  - PP_SELECTED
```
public static final TreatmentParameter PP_SELECTED
```
    the selection state of the datum
  - PP_ANCHOR_PCA
```
public static final TreatmentParameter PP_ANCHOR_PCA
```
    whether PCA fits are to be anchored for this datum
  - PP_HIDDEN
```
public static final TreatmentParameter PP_HIDDEN
```
    whether this datum should be hidden on plots
  - PP_ONCIRCLE
```
public static final TreatmentParameter PP_ONCIRCLE
```
    whether this datum is used for a great-circle fit
  - PP_INPCA
```
public static final TreatmentParameter PP_INPCA
```
    whether this datum is used for a PCA fit
  - VIRT_MAGNETIZATION
```
public static final TreatmentParameter VIRT_MAGNETIZATION
```
    the intensity of the magnetic dipole moment per unit volume (‘magnetization’)
  - VIRT_DECLINATION
```
public static final TreatmentParameter VIRT_DECLINATION
```
    declination of magnetization vector (degrees)
  - VIRT_INCLINATION
```
public static final TreatmentParameter VIRT_INCLINATION
```
    inclination of magnetization vector (degrees)
  - VIRT_MSJUMP
```
public static final TreatmentParameter VIRT_MSJUMP
```
    the temperature at which the magnetic susceptibility increases sharply
  - VIRT_SAMPLE_HADE
```
public static final TreatmentParameter VIRT_SAMPLE_HADE
```
    the hade of a discrete sample (degrees)
  - VIRT_FORM_STRIKE
```
public static final TreatmentParameter VIRT_FORM_STRIKE
```
    the strike of the formation orientation (degrees)
- Method Detail
  - values
```
public static TreatmentParameter[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TreatmentParameter c : TreatmentParameter.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TreatmentParameter valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getByHeading
```
public static TreatmentParameter getByHeading(java.lang.String heading)
```
    Returns the field whose heading string is the specified string, or null if no such field exists.
    
    Parameters:
    
    heading - a heading string for a field
    
    Returns:
    
    the field whose heading string is the specified string, or null if no such field exists
  - getHeading
```
public java.lang.String getHeading()
```
    Returns the heading string for this field.
    
    Returns:
    
    the heading string for this field
  - getNiceName
```
public java.lang.String getNiceName()
```
    Returns this field's ‘nice name’ (string representation for display to user)
    
    Returns:
    
    this field's ‘nice name’ (string representation for display to user)
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    Returns this field's default value. Currently only used in TreatmentStep.setValue(TreatmentParameter, String, double).
    
    Returns:
    
    a string representation of the default value for this field
  - isVirtual
```
public boolean isVirtual()
```
    Reports whether this field is virtual. Virtual fields have no corresponding explicitly stored data value. Their values are calculated on-the-fly from other fields.
    
    Returns:
    
    true if this field is virtual
  - isImportable
```
public boolean isImportable()
```
    Reports whether this field is importable. Importable fields are those which may be specified for custom data import. Note that (perhaps counterintuitively) the virtual fields for declination, inclination, and magnetization are importable, although they cannot be set by TreatmentStep.setValue(TreatmentParameter, String, double): they are handled as a special case by FileFormat.readLine(String).
    
    Returns:
    
    true if this field is importable
  - getRealFields
```
public static java.util.List<TreatmentParameter> getRealFields()
```
    Returns an unmodifiable list of the real fields. A real field corresponds to an explicitly stored data value.
    
    Returns:
    
    an unmodifiable list of the real fields
  - getRealFieldStrings
```
public static java.util.List<java.lang.String> getRealFieldStrings()
```
    Returns an unmodifiable list of the string representations of the real fields. A real field corresponds to an explicitly stored data value.
    
    Returns:
    
    an unmodifiable list of the string representations of the real fields
  - getType
```
public java.lang.Class getType()
```
    Returns the type of this field (double, String, etc.).
    
    Returns:
    
    a Class object representing the field's data type

Enum TreatmentParameter

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DISCRETE_ID

DEPTH

RUN_NUMBER

TIMESTAMP

SLOT_NUMBER

MEAS_TYPE

X_MOMENT

Y_MOMENT

Z_MOMENT

MAG_SUS

VOLUME

AREA

SAMPLE_AZ

SAMPLE_DIP

FORM_AZ

FORM_DIP

MAG_DEV

TREATMENT

AF_X

AF_Y

AF_Z

TEMPERATURE

IRM_FIELD

ARM_FIELD

ARM_AXIS

PP_SELECTED

PP_ANCHOR_PCA

PP_HIDDEN

PP_ONCIRCLE

PP_INPCA

VIRT_MAGNETIZATION

VIRT_DECLINATION

VIRT_INCLINATION

VIRT_MSJUMP

VIRT_SAMPLE_HADE

VIRT_FORM_STRIKE

Method Detail

values

valueOf

getByHeading

getHeading

getNiceName

getDefaultValue

isVirtual

isImportable

getRealFields

getRealFieldStrings

getType