net.talvi.puffinplot.plots

Interface PlotParams

public interface PlotParams

The current parameters for a plot. This interface provides a way for a plot to retrieve ‘dynamic’ parameters affecting its appearance – that is, parameters which can change after the plot has been created. An object implementing this interface is passed to a plot's constructor; the plot can then call back through this interface to read the current state of the parameters. In the case of the main graph display in PuffinPlot's GUI, the parameters are read from the PuffinApp object, which in turn gets them from user selections in the control panel.

It is not guaranteed that there will always be a valid value available for each parameter. Methods returning lists may return empty lists, and methods returning single objects may return null.

Method Summary

Modifier and Type	Method and Description
java.util.List<Sample>	getAllSamplesInSelectedSites()
Correction	getCorrection() Returns the correction to be applied to magnetic moment data.
MeasurementAxis	getHprojXaxis() Returns the X axis of the Zijderveld plot's horizontal projection.
MeasurementAxis	getHprojYaxis() Returns the Y axis of the Zijderveld plot's horizontal projection.
Sample	getSample() Returns the sample to plot.
java.util.List<Sample>	getSelectedSamples()
java.lang.String	getSetting(java.lang.String key, java.lang.String def) Gets the string value of a named setting.
boolean	getSettingBoolean(java.lang.String key, boolean def) Gets the boolean value of a named setting.
SuiteRpiEstimate	getSuiteRpiEstimate()
float	getUnitSize()
MeasurementAxis	getVprojXaxis() Returns the X axis of the Zijderveld plot's vertical projection.

Method Detail

getSample

Sample getSample()

Returns the sample to plot.

Returns:

the sample to plot

getSelectedSamples

java.util.List<Sample> getSelectedSamples()

Returns:

a list of the currently selected samples. May be empty, but not null.

getCorrection

Correction getCorrection()

Returns the correction to be applied to magnetic moment data.

Returns:

the correction to be applied to magnetic moment data

getVprojXaxis

MeasurementAxis getVprojXaxis()

Returns the X axis of the Zijderveld plot's vertical projection. Valid values are X (V vs. N), Y (V vs. E), and H (V vs. H).

Returns:

the X axis of the Zijderveld plot's vertical projection

getHprojXaxis

MeasurementAxis getHprojXaxis()

Returns the X axis of the Zijderveld plot's horizontal projection. Valid values are Y (N is up) and X (W is up).

Returns:

the X axis of the Zijderveld plot's horizontal projection

getHprojYaxis

MeasurementAxis getHprojYaxis()

Returns the Y axis of the Zijderveld plot's horizontal projection. Valid values are X (N is up) and MINUSY (W is up).

Returns:

the Y axis of the Zijderveld plot's horizontal projection

getAllSamplesInSelectedSites

java.util.List<Sample> getAllSamplesInSelectedSites()

Returns:

a list of all samples in all selected sites (may be empty, but not null)

getSetting

java.lang.String getSetting(java.lang.String key,
                            java.lang.String def)

Gets the string value of a named setting.

Parameters:

key - the name of a string-valued setting

def - a default value

Returns:

the value of the setting, or def if it has no value

getSettingBoolean

boolean getSettingBoolean(java.lang.String key,
                          boolean def)

Gets the boolean value of a named setting.

Parameters:

key - the name of a boolean-valued setting

def - a default value

Returns:

the value of the setting, of def if it has no value

getUnitSize

float getUnitSize()

Returns:

the measurement unit size for this plot

getSuiteRpiEstimate

SuiteRpiEstimate getSuiteRpiEstimate()

Returns:

the current suite RPI estimate, or null if there is none