John W. Campbell
This class is used, for example, in conjunction with the 'interactive'
Laue prediction simulations JdlPXSimulations object. It enables the
recalculation of a predicted Laue flags/lambda etc for reduced/increased
(as approprate) values of the following parameters:
Lambda-min (increased from prediction value limit)
Lambda-max (decreased from prediction value limit)
Dmin (increased from prediction value limit)
Class, constructors and methods:
Class Details
Accessible Fields
Constructors
- Package:
- Jdl.JdlPX;
- Class name:
- JdlLaueSpotReflag
- Class definition:
- public class JdlLaueSpotReflag
- Extends:
- Object
- Implements:
- none
- Actions:
- none
No fields with public, package or protected access defined.
Constructors are available to construct a JdlReflectionReflag object
with either a specific list of parameters or with objects containing
these values.
Constructors:
Standard Constructor
Constructor 2
Constructor 3
Set current lambda-min - setCurrentLambdaMin
Set current lambda-max - setCurrentLambdaMax
Set current dmin - setCurrentDmin
Get current lambda-min - getCurrentLambdaMin
Get current lambda-max - getCurrentLambdaMax
Get current dmin - getCurrentDmin
Get full lambda-min - getFullLambdaMin
Get full lambda-max - getFullLambdaMax
Get full dmin - getFullDmin
Get minimum lambda-min - getMinimumLambdaMin
Get maximum lambda-min - getMaximumLambdaMin
Get minimum lambda-max - getMinimumLambdaMax
Get maximum lambda-max - getMaximumLambdaMax
Get minimum dmin - getMinimumDmin
Get maximum dmin - getMaximumDmin
Reset spot details - resetSpot
This constructs the object with explicitly defined parameters. These must
be the same as those used when the 'over-predicted' spot list, whose
spots are to be re-flagged, was created. The over-prediction factor
is specified as one of the parameters and current values for the
variable items are taken as the values used in the prediction
multiplied/divided by the over-prediction factor (i.e. reducing the predicted
spot set)
- Constructor Definition:
- public JdlLaueSpotReflag(double lmin, double lmax, double dmin, double multfac, double limfac)
- Parameters List:
- lmin
- The lambda-min value used in the over-prediction.
- lmax
- The lambda-max value used in the over-prediction.
- dmin
- The 'dmin' value used in in the over-prediction.
- multfac
- The over-prediction factor.
- limfac
- The factor by which to extend the range of lambda-min,
lambda-max, and dmin for interactive pattern displays using the
JdlPXSimulations object (extends if opposite direction from multfac i.e.
it increases lambda-min and dmin and decreases lambda-max).
Construct a JdlLaueSpotReflag object from JdlPositionedDetector
and JdlPositionedCrystal objects. These objects must contain the
parameter values of lambda_min, lambda_max and dmin (resolution)
used in the over-prediction.
- Constructor Definition:
- public JdlLaueSpotReflag(JdlPositionedDetector posdet, JdlPositionedCrystal poscrys, double multfac, double limfac)
- Parameters List:
- posdet
- A JdlPositionedDetector object containing details of the
positioned detector, gonioneter and X-ray source.
- poscrys
- A JdlPositionedCrystal containing details of the crystal cell,
symmetry and setting.
- multfac
- The over-prediction factor.
- limfac
- The factor by which to extend the range of lambda-min,
lambda-max, and dmin for interactive pattern displays using the
JdlPXSimulations object (extends if opposite direction from multfac i.e.
it increases lambda-min and dmin and decreases lambda-max).
Construct a JdlLauSpotReflag object from a JdlDiffractionDataModule object.
- Constructor Definition:
- public JdlLaueSpotReflag(JdlDiffractionDataModule ddm, int iset, int img, boolean scaled, double multfac, double limfac)
- Parameters List:
- ddm
- The JdlDiffractionDataModule object containing the detector and
crystal data used in the prediction. NOTE: In this case, in contrast to
that for the other constructors, the JdlDiffractionDataModule object may
contain the prediction values for the prediction before scaling up/down
for the over-prediction (see 'scaled' parameter).
- iset
- The set number within the Diffraction Data Module.
for which the prediction was carried out.
- img
- The (reference) image number - normally 1.
- scaled
- If true, it is assumed that the DDM data contains the relevant
parameters (lambda-min, lambda-max, resolution) already scaled up/down by
'multfac'. If false, then it is assumed that the DDM data contains the
relevant parameters (lambda-min, lambda-max, resolution) with values prior
to scaling up/down by multfac for the over-prediction.
- multfac
- The over-prediction factor.
- limfac
- The factor by which to extend the range of lambda-min,
lambda-max, and dmin for interactive pattern displays using the
JdlPXSimulations object (extends if opposite direction from multfac i.e.
it increases lambda-min and dmin and decreases lambda-max).
This method sets a new value for the current lambda-min used
by the resetSpot(..) method. This must not be less than the value
used in the over-prediction.
- Method Definition:
- public void setCurrentLambdaMin(double lmin)
- Parameters List:
- lmin
- The lambda-min value.
This method sets a new value for the current lambda-max used
by the resetSpot(..) method. This must not be greater than the value
used in the over-prediction.
- Method Definition:
- public void setCurrentLambdaMax(double lmax)
- Parameters List:
- lmin
- The lambda-max value.
This method sets a new value for the current dmin (resolution) used
by the resetSpot(..) method. This must not be less than the value
used in the over-prediction.
- Method Definition:
- public void setCurrentDmin(double dmin)
- Parameters List:
- lmin
- The dmin value.
This method returns the value for the current lambda-min used
by the resetSpot(..) method.
- Method Definition:
- public double getCurrentLambdaMin()
- Parameters List:
- none
This method returns the value for the current lambda-max used
by the resetSpot(..) method.
- Method Definition:
- public double getCurrentLambdaMax()
- Parameters List:
- none
This method returns the value for the current dmin used
by the resetSpot(..) method.
- Method Definition:
- public double getCurrentDmin()
- Parameters List:
- none
This method returns the value for the full lambda-min value used
in the prediction.
- Method Definition:
- public double getFullLambdaMin()
- Parameters List:
- none
This method returns the value for the full lambda-max value used
in the prediction.
- Method Definition:
- public double getFullLambdaMax()
- Parameters List:
- none
This method returns the value for the full dmin value used
in the prediction.
- Method Definition:
- public double getFullDmin()
- Parameters List:
- none
This method returns the minimum value for lambda-min to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMinimumLambdaMin()
- Parameters List:
- none
This method returns the maximum value for lambda-min to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMaximumLambdaMin()
- Parameters List:
- none
This method returns the minimum value for lambda-max to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMinimumLambdaMax()
- Parameters List:
- none
This method returns the maximum value for lambda-max to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMaximumLambdaMax()
- Parameters List:
- none
This method returns the minimum value for dmin to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMinimumDmin()
- Parameters List:
- none
This method returns the maximum value for dmin to be used
for the interactive plots in the JdlPXSimulations object.
- Method Definition:
- public double getMaximumDmin()
- Parameters List:
- none
This method recalculates the parameters which depend on the variable
items and returns an updated JdlPredictedLaueSpot object with these
updated parameters.
- Method Definition:
- public JdlPredictedLaueSpot resetSpot(JdlPredictedLaueSpot spot)
- Parameters List:
- spot
- The spot as predicted originally.
- Method Return:
-
The Laue spot with details updated to reflect the changes in
the variable items. If the spot is no longer recorded the 'mult' field
will be returned as zero.
⇑ Up 2
⇑ Up 1
⇑ Top of this