4.2.8 - Positioned Detector Object - JdlPositionedDetector

John W. Campbell

4.2.8.1 Introduction

This class stores details of a set (positioned) detector. It includes a JdlDetectorBasics detector basics object and a JdlXraySource X-ray source object. In addition its position is defined with a crystal to detector distance, rotations around the detector axes and a maximum detector radius.

Class, constructors and methods:

Class Details
Accessible Fields
Constructors
Set Values
Get Values
Real and Reciprocal Coordinate Conversions
List Positioned Detector Data

4.2.8.2 Class Details

Package:
Jdl.JdlPX;
Class name:
JdlPositionedDetector
Class definition:
public class JdlPositionedDetector
Extends:
Object
Implements:
Cloneable
Actions:
none

4.2.8.3 Accessible Fields

The following accessible fields have been defined:

JdlDetectorBasics det
JdlXraySource source
double c_to_d
double tau1
double tau2
double tau3
double rmax
double weiss_coupling

4.2.8.4 Constructors

4.2.8.4.1 Introduction

There are a series of constructors available specifying various combinations of default and explicitly given parameter values.

Constructors:

Constructor 1
Constructor 2
Constructor 3
Constructor 4

4.2.8.4.2 Constructor 1

Create a JdlPositionedDetector object with default values for the X-ray source object and zero values for the detector rotations.

Constructor Definition:
public JdlPositionedDetector (JdlDetectorBasics det, double c_to_d, double rmax)
Parameters List:
det
The JdlDetectorBasics detector basics object.
c_to_d
The crystal to detector distance mm.
rmax
A maximum radius which encloses the recordable detector area - used as one of the limits when predicting reflection positions.

4.2.8.4.3 Constructor 2

Create a JdlPositionedDetector object with default values for the X-ray source object.

Constructor Definition:
public JdlPositionedDetector (JdlDetectorBasics det, double tau1, double tau2, double tau3, double c_to_d, double rmax)
Parameters List:
det
The JdlDetectorBasics detector basics object.
tau1
The tau1 detector rotation angle in degrees.
tau2
The tau2 detector rotation angle in degrees.
tau3
The tau3 detector rotation angle in degrees.
c_to_d
The crystal to detector distance mm.
rmax
A maximum radius which encloses the recordable detector area - used as one of the limits when predicting reflection positions.

4.2.8.4.4 Constructor 3

Create a JdlPositionedDetector object with zero values for the detector rotations.

Constructor Definition:
public JdlPositionedDetector (JdlDetectorBasics det, JdlXraySource source, double c_to_d, double rmax)
Parameters List:
det
The JdlDetectorBasics detector basics object.
source
The JdlXraySource X-ray source object.
c_to_d
The crystal to detector distance mm.
rmax
A maximum radius which encloses the recordable detector area - used as one of the limits when predicting reflection positions.

4.2.8.4.5 Constructor 4

Create a JdlPositionedDetector object with all items being explicitly defined.

Constructor Definition:
public JdlPositionedDetector (JdlDetectorBasics det, JdlXraySource source, double tau1, double tau2, double tau3, double c_to_d, double rmax, double weiss)
Parameters List:
det
The JdlDetectorBasics detector basics object.
source
The JdlXraySource X-ray source object.
tau1
The tau1 detector rotation angle in degrees.
tau2
The tau2 detector rotation angle in degrees.
tau3
The tau3 detector rotation angle in degrees.
c_to_d
The crystal to detector distance mm.
rmax
A maximum radius which encloses the recordable detector area - used as one of the limits when predicting reflection positions.
weiss
Weissenberg coupling constant in mm/deg along the second local detector axis.

4.2.8.5 Set Values

4.2.8.5.1 Introduction

This section has methods to set individual sets of values in the positioned detector object.

Methods:

Set detector basics - setDetectorBasics
Set scan axis - setScanAxis
Set the X-ray source - setXraySource
Set detector distance - setDetectorDistance
Set detector radius - setMaximumRadius
Set detector rotations - setTauValues
Set Weissenberg coupling - setWeissenbergCoupling

4.2.8.5.2 Set detector basics - setDetectorBasics

This method sets the value of the store JdlDetectorBasics detector basics object.

Method Definition:
public void setDetectorBasics (JdlDetectorBasics det)
Parameters List:
det
The JdlDetectorBasics detector basics object.

4.2.8.5.3 Set scan axis - setScanAxis

This method sets the detector scan axis.

Method Definition:
public void setScanAxis (double[] scax)
Parameters List:
scax
A three element array holding scan axis vector.

4.2.8.5.4 Set the X-ray source - setXraySource

This method sets the JxdXraySource X-ray source object.

Method Definition:
public void setXraySource (JdlXraySource source)
Parameters List:
source
The JdlXraySource X-ray source object.

4.2.8.5.5 Set detector distance - setDetectorDistance

This method sets the crystal to detector distance.

Method Definition:
public void setDetectorDistance (double c_to_d)
Parameters List:
c_to_d
The crystal to detector distance mm.

4.2.8.5.6 Set detector radius - setMaximumRadius

This method sets the maximum detector radius.

Method Definition:
public void setMaximumRadius (double rmax)
Parameters List:
rmax
The maximum radius which encloses the recordable detector area - used as one of the limits when predicting reflection positions.

4.2.8.5.7 Set detector rotations - setTauValues

This method sets values for the detector rotations angles.

Method Definition:
public void setTauValues (double tau1, double tau2, double tau3)
Parameters List:
tau1
The tau1 detector rotation angle in degrees.
tau2
The tau2 detector rotation angle in degrees.
tau3
The tau3 detector rotation angle in degrees.

4.2.8.5.8 Set Weissenberg coupling - setWeissenbergCoupling

This method sets the Weissenberg coupling constant.

Method Definition:
public void setWeissenbergCoupling(double weiss)
Parameters List:
weiss
Weissenberg coupling constant in mm/deg along the second local detector axis.

4.2.8.6 Get Values

4.2.8.6.1 Introduction

This section has methods to get individual sets of values from the positioned detector object.

Methods:

Get detector basics - getDetectorBasics
Get detector basics - getDetectorBasicsCopy
Get scan axis - getScanAxis
Get beam vector - getBeamVector
Get X-ray source - getXraySource
Get X-ray source - getXraySourceCopy
Get detector distance - getDetectorDistance
Get maximum radius - getMaximumRadius
Get tau1 - getTau1
Get tau2 - getTau2
Get tau3 - getTau3
Get Weissenberg coupling - getWeissenbergCoupling
Get orientation matrix - getOrientationMatrix
Get inverse orientation matrix - getInverseOrientationMatrix
Get normal vector - getNormalVector

4.2.8.6.2 Get detector basics - getDetectorBasics

This method returns a reference to the JdlDetectorBasics detector basics object stored within the JdlPositionedDetector object.

Method Definition:
public JdlDetectorBasics getDetectorBasics()
Parameters List:
none
Method Return:
The JdlDetectorBasics object.

4.2.8.6.3 Get detector basics - getDetectorBasicsCopy

This method returns a copy (clone) of the JdlDetectorBasics detector basics object stored within the JdlPositionedDetector object.

Method Definition:
public JdlDetectorBasics getDetectorBasicsCopy()
Parameters List:
none
Method Return:
The JdlDetectorBasics object.

4.2.8.6.4 Get scan axis - getScanAxis

This method returns the scan axis vector.

Method Definition:
public void getScanAxis(double[] scax)
Parameters List:
scax
A three element array in which the scan axis vector is to be returned.

4.2.8.6.5 Get beam vector - getBeamVector

This method returns the X-ray beam vector.

Method Definition:
public void getBeamVector(double[] s0)
Parameters List:
s0
A three element array in which the beam vector is to be returned.

4.2.8.6.6 Get X-ray source - getXraySource

This method returns a reference to the JdlXraySource X-ray source object stored within the JdlPositionedDetector object.

Method Definition:
public JdlXraySource getXraySource()
Parameters List:
none
Method Return:
The JdlXraySource object.

4.2.8.6.7 Get X-ray source - getXraySourceCopy

This method returns a copy (clone) of the JdlXraySource X-ray source object stored within the JdlPositionedDetector object.

Method Definition:
public JdlXraySource getXraySourceCopy()
Parameters List:
none
Method Return:
The JdlXraySource object.

4.2.8.6.8 Get detector distance - getDetectorDistance

This method returns the crystal to detector distance stored in the JdlPositionedDetector object.

Method Definition:
public double getDetectorDistance()
Parameters List:
none
Method Return:
The crystal to detector distance in mm.

4.2.8.6.9 Get maximum radius - getMaximumRadius

This method returns the maximum detector radius value stored in the JdlPositionedDetector object.

Method Definition:
public double getMaximumRadius()
Parameters List:
none
Method Return:
The maximum detector radius in mm.

4.2.8.6.10 Get tau1 - getTau1

This method returns the tau1 detector rotation angle.

Method Definition:
public double getTau1()
Parameters List:
none
Method Return:
The tau1 detector rotation angle in degrees.

4.2.8.6.11 Get tau2 - getTau2

This method returns the tau2 detector rotation angle.

Method Definition:
public double getTau2()
Parameters List:
none
Method Return:
The tau2 detector rotation angle in degrees.

4.2.8.6.12 Get tau3 - getTau3

This method returns the tau3 detector rotation angle.

Method Definition:
public double getTau3()
Parameters List:
none
Method Return:
The tau3 detector rotation angle in degrees.

4.2.8.6.13 Get Weissenberg coupling - getWeissenbergCoupling

This method returns the Weissenberg coupling constant.

Method Definition:
public double getWeissenbergCoupling()
Parameters List:
none
Method Return:
Weissenberg coupling constant in mm/deg along the second local detector axis.

4.2.8.6.14 Get orientation matrix - getOrientationMatrix

This method returns the detector orientation matrix.

Method Definition:
public Jdl3x3 getOrientationMatrix()
Parameters List:
none
Method Return:
The orientation matrix

4.2.8.6.15 Get inverse orientation matrix - getInverseOrientationMatrix

This method returns the detector inverse orientation matrix.

Method Definition:
public Jdl3x3 getInverseOrientationMatrix()
Parameters List:
none
Method Return:
The inverse orientation matrix

4.2.8.6.16 Get normal vector - getNormalVector

This method returns the vector normal to the detecto .

Method Definition:
public JdlVec getNormalVector()
Parameters List:
none
Method Return:
The detector normal vector

4.2.8.7 Real and Reciprocal Coordinate Conversions

4.2.8.7.1 Introduction

This section has methods to convert between ideal detector coordinates for a reflection and the corresponding reciprocal lattice coordinates for the reflection.

Methods:

Reciprocal lattice to detector - reciprocalLatticeToDetector
Detector to reciprocal lattice - detectorToReciprocalLattice

4.2.8.7.2 Reciprocal lattice to detector - reciprocalLatticeToDetector

This method calculates ideal detector coordinates (xd, yd MOSFLM convention) in mm from the pattern centre from a set of reciprocal lattice coordinates for a reflection, using the object's stored detector data.

Method Definition:
public JdlXY reciprocalLatticeToDetector (double[] xr)
Parameters List:
xr
The reciprocal lattice coordinates xr[3]
Method Return:
The ideal detector coordinates in mm (from the centre) JdlXY.x is xd, JdlXY.y is yd

4.2.8.7.3 Detector to reciprocal lattice - detectorToReciprocalLattice

This method calculates reciprocal lattice coordinates for a reflection from the ideal detector coordinates in mm from the pattern centre, using the object's stored detector data.

Method Definition:
public JdlVec detectorToReciprocalLattice(double xd, double yd, double dst2)
Parameters List:
xd
The ideal detector 'x' coordinate in mm. (MOSFLM convention)
yd
The ideal detector 'y' coordinate in mm.
dst2
(d*)**2 for the reflection. Required for the Laue case but may give zero for the monochromatic case.
Method Return:
Returns The reciprocal lattice coordinates in a 3 element vector

4.2.8.8 List Positioned Detector Data

4.2.8.8.1 Introduction

This section has a single method to list the contents of the object primarily for diagnostic purposes.

Method:

List contents - listContents
List derived values - listDerived

4.2.8.8.2 List contents - listContents

This method lists the contents of the object.

Method Definition:
public void listContents()
Parameters List:
none

4.2.8.8.3 List derived values - listDerived

This method lists the internal items derived from the main parameters of the object.

Method Definition:
public void listDerived()
Parameters List:
none

⇑ Up 2   ⇑ Up 1   ⇑ Top of this