4.10.4 - Find Setting Options - JdlFindSettingOptions

John W. Campbell

4.10.4.1 Introduction

This class provides some user options for a JdlPXImage object enabling the user to search find a crystal setting for a known cell. Background image and spot finding options are inclu7ded. When the Find Setting user options are selected, a window is displayed which contains a menu, a parameter table and an I/O window.

Class, constructors and methods:

Class Details
Accessible Fields
Constructor
Set Parameter Values

4.10.4.2 Class Details

Package:
Jdl.JdlPX;
Class name:
JdlFindSettingOptions
Class definition:
public class JdlFindSettingOptions
Extends:
Object
Implements:
JdlPXImageUserOptions
ActionListener
Runnable
Actions:
An action event will be generated when the 'Close' menu item is selected. The associated object is the String object 'done'.

4.10.4.3 Accessible Fields

No fields with public, package or protected access defined.

4.10.4.4 Constructor

4.10.4.4.1 Introduction

A single constructor is available.

Constructor:

Standard Constructor

4.10.4.4.2 Standard Constructor

Constructs a JdlFindSettingOptions object with initialised parameter values. Note that the construction of the window and the handling of the calculations are done in the interface routines.

Constructor Definition:
public JdlFindSettingOptions()
Parameters List:
none

4.10.4.5 Set Parameter Values

4.10.4.5.1 Introduction

This section has methods to set initial values for the parameters required in the calculations. These values may be reset (or input for the first time) via the parameter table which is displayed when the IPDISP user options are selected. The values may be set or reset at any stage and the parameter table, if already constructed, will have its values updated. If the centre parameters x_cen, y_cen have not been set when the IPDISP options window is first displayed, the image mid-point will be chosen.

Methods:

Set file option - setFilenameInputOption
Set distance - setDistance
Set wavelength - setWavelength
Set rmax - setDetectorRmax
Set resolution - setResolution
Set mosaicity - setMosaicity
Set detector tilt - setDetectorTilt
Set xy limits - setDetectorXYLimits
Set rmin limits - setDetectorRminLimits
Set centre - setDetectorCentre
Set cell - setCell
Set symmetry - setSymmetry
Set Phi - setPhiOsc

4.10.4.5.2 Set file option - setFilenameInputOption

This method sets the required default choice for file name input.

Method Definition:
public void setFilenameInputOption(boolean use_iow)
Parameters List:
use_iow
If true or the file chooser is null (could not be created for security reasons), the file name is to be read from the i/o window; If false, use the file chooser unless it is null.

4.10.4.5.3 Set distance - setDistance

Set the crystal to detector distance.

Method Definition:
public void setDistance (double ctod)
Parameters List:
ctod
The crystal to detector distance in mm.

4.10.4.5.4 Set wavelength - setWavelength

Set the wavelength.

Method Definition:
public void setWavelength (double wave)
Parameters List:
wave
The wavelength in Angstroms.

4.10.4.5.5 Set rmax - setDetectorRmax

Set the detector 'rmax' limit.

Method Definition:
public void setDetectorRmax (double rmax)
Parameters List:
rmax
'rmax' limit in mm.

4.10.4.5.6 Set resolution - setResolution

Set prediction resolution limit.

Method Definition:
public void setResolution (double resol)
Parameters List:
resol
The resolution limit in Angstroms.

4.10.4.5.7 Set mosaicity - setMosaicity

Set prediction mosaicity value.

Method Definition:
public void setMosaicity (double mosaic)
Parameters List:
mosaic
The mosaic spread in degrees.

4.10.4.5.8 Set detector tilt - setDetectorTilt

Set the detector tilt angle.

Method Definition:
public void setDetectorTilt (double dtilt)
Parameters List:
dtilt
The detector tilt angle in degrees.

4.10.4.5.9 Set xy limits - setDetectorXYLimits

Set the detector x and y limits.

Method Definition:
public void setDetectorXYLimits (double x_min, double x_max, double y_min, double y_max)
Parameters List:
x_min
Minimum 'x' limit in rasters (0.0 = image start).
x_max
Maximum 'x' limit in rasters (0.0 = image end).
y_min
Minimum 'y' limit in rasters (0.0 = image start).
y_max
Maximum 'y' limit in rasters (0.0 = image end).

4.10.4.5.10 Set rmin limits - setDetectorRminLimits

Set the detector 'rmin' limits.

Method Definition:
public void setDetectorRminLimits (double rmin, double r_xcen, double r_ycen)
Parameters List:
rmin
'rmin' limit in mm.
r_xcen
Centre in 'x' for rmin limit in rasters.
r_ycen
Centre in 'y' for rmin limit in rasters. If r_xcen and r_ycen are both zero, then x_cen and y_cen will be used as the rmin circle centre.

4.10.4.5.11 Set centre - setDetectorCentre

Set detector centre starting values.

Method Definition:
public void setDetectorCentre (double x_cen, double y_cen)
Parameters List:
x_cen
The image x-centre position in pixel units.
y_cen
The image y-centre position in pixel units.

4.10.4.5.12 Set cell - setCell

Set the cell parameters.

Method Definition:
public void setCell(JdlCell cell)
Parameters List:
cell
The cell parameters object.

4.10.4.5.13 Set symmetry - setSymmetry

Set the symmetry.

Method Definition:
public void setSymmetry (String symstr)
Parameters List:
sym_str
Symmetry; must be either the space group number or code or, for undefined symmetry, the string "undef". (Valid numbers/codes as currently defined in the JdlSymops class).

4.10.4.5.14 Set Phi - setPhiOsc

Set rotation angle and oscillation angle.

Method Definition:
public void setPhiOsc (double phi, double osc)
Parameters List:
phi
Rotation angle (ROTSTART and ROTEND will both be set to this value).
osc
Oscillation angle.

⇑ Up 2   ⇑ Up 1   ⇑ Top of this