4.2.6 - X-ray Source Parameters - JdlXraySource

John W. Campbell

4.2.6.1 Introduction

This class stores parameters related to the X-ray source as used in Protein Crystallography.

See also the Diffraction Data Module for a further description of the parameters and their meanings.

Class, fields, constructor and methods:

Class Details
Accessible Fields
Constructors
Set Values
Get Values
List X-ray Source Data

4.2.6.2 Class Details

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

4.2.6.3 Accessible Fields

The following accessible fields have been defined:

public final static int MONOCHROMATIC
Monochromatic radiation type flag.
public final static int POLYCHROMATIC
Polychromatic radiation type flag.
public final static int LAUE
Laue radiation type flag (same as polychromatic).
int radiation_type
Flag =1 Monochromatic, =2 polychromatic radiation.
double wavelength
Wavelength for monochromatic radiation.
double lambda_min
Minimum wavelength for polychromatic radiation.
double lambda_max
Maximum wavelength for polychromatic radiation.
boolean synchrotron
Synchrotron flag: True if Synchrotron source, otherwise false.
double dispersion
Synchrotron: dispersion (delta(lambda)/lambda).
double cor_disp
Synchrotron: Correlated component of dispersion.
int horiz_axis
The number of the laboratory axis (1-3) which is horizontal so that the correct axis may be identified for the horizontal divergence.
int vert_axis
The number of the laboratory axis (1-3) which is vertical so that the correct axis may be identified for the vertical divergence.
double horiz_div
Synchrotron: horizontal divergence in degrees.
double vert_div
Synchrotron: vertical divergence in degrees.
double polarisation
The X-ray beam polarisation factor.

4.2.6.4 Constructors

4.2.6.4.1 Introduction

There are several constructors, one sets up a JdlXraySource object with a default parameter set, one for a monochromatic source, one for a polychromatic source and one with a fully specified set of parameters.

Constructors:

Default Constructor
Monochromatic Constructor
Laue Constructor
Full Constructor

4.2.6.4.2 Default Constructor

This sets up a JdlXraySource object with a default parameter set.
Type - Monochromatic
Wavelength - 1.0 Angstroms
Lambda_min, Lambda_max - 0.5, 1.5
Synchrotron - false, synchrotron parameters zero
Horizontal, vertical axes - 3, 2

Constructor Definition:
public JdlXraySource()
Parameters List:
none

4.2.6.4.3 Monochromatic Constructor

This sets up an object with a set of parameters for a monochromatic source.

Constructor Definition:
public JdlXraySource(double wave, boolean synch, double disp, double delcor, int iax_h, int iax_v, double divh, double divv, double pol)
Parameters List:
wave
The wavelength.
synch
Synchrotron flag: True if Synchrotron source, otherwise false.
disp
Synchrotron: dispersion (delta(lambda)/lambda).
delcor
Synchrotron: Correlated component of dispersion.
iax_h
The number of the laboratory axis (1-3) which is horizontal so that the correct axis may be identified for the horizontal divergence.
iax_v
The number of the laboratory axis (1-3) which is vertical so that the correct axis may be identified for the vertical divergence.
divh
Synchrotron: horizontal divergence in degrees.
divv
Synchrotron: vertical divergence in degrees.
pol
The X-ray beam polarisation factor.

4.2.6.4.4 Laue Constructor

This sets up an object with a set of parameters for a polychromatic source.

Constructor Definition:
public JdlXraySource(double lmin, double lmax, boolean synch, double disp, double delcor, int iax_h, int iax_v, double divh, double divv, double pol)
Parameters List:
lmin
Minimum wavelength for polychromatic radiation.
lmax
Maximum wavelength for polychromatic radiation.
synch
Synchrotron flag: True if Synchrotron source, otherwise false.
disp
Synchrotron: dispersion (delta(lambda)/lambda).
delcor
Synchrotron: Correlated component of dispersion.
iax_h
The number of the laboratory axis (1-3) which is horizontal so that the correct axis may be identified for the horizontal divergence.
iax_v
The number of the laboratory axis (1-3) which is vertical so that the correct axis may be identified for the vertical divergence.
divh
Synchrotron: horizontal divergence in degrees.
divv
Synchrotron: vertical divergence in degrees.
pol
The X-ray beam polarisation factor.

4.2.6.4.5 Full Constructor

This sets up an object with a complete set of parameters specified.

Constructor Definition:
public JdlXraySource(int type, double wave, double lmin, double lmax, boolean synch, double disp, double delcor, int iax_h, int iax_v, double divh, double divv, double pol)
Parameters List:
type
Radiation type:
= 1, Monochromatic - MONOCHROMATIC
= 2, Polychromatic - POLYCHROMATIC or LAUE (Laue)
wave
The wavelength.
lmin
Minimum wavelength for polychromatic radiation.
lmax
Maximum wavelength for polychromatic radiation.
synch
Synchrotron flag: True if Synchrotron source, otherwise false.
disp
Synchrotron: dispersion (delta(lambda)/lambda).
delcor
Synchrotron: Correlated component of dispersion.
iax_h
The number of the laboratory axis (1-3) which is horizontal so that the correct axis may be identified for the horizontal divergence.
iax_v
The number of the laboratory axis (1-3) which is vertical so that the correct axis may be identified for the vertical divergence.
divh
Synchrotron: horizontal divergence in degrees.
divv
Synchrotron: vertical divergence in degrees.
pol
The X-ray beam polarisation factor.

4.2.6.5 Set Values

4.2.6.5.1 Introduction

This section has methods to set individual sets of values in the X-ray source object.

Methods:

Set type - setRadiationType
Set wavelength - setWavelength
Set lambda-min - setLambdaMin
Set lambda-max - setLambdaMax
Set synchrotron - setSynchrotron
Set dispersion - setDispersion
Set correlated dispersion - setCorrelatedDispersion
Set horizontal axis - setHorizontalAxis
Set vertical axis - setVerticalAxis
Set horizontal divergence - setHorizontalDivergence
Set vertical divergence - setVerticalDivergence
Set polarisation - setPolarisation

4.2.6.5.2 Set type - setRadiationType

This method sets the monochromatic/polychromatic type flag.

Method Definition:
public void setRadiationType(int type)
Parameters List:
type
Radiation type:
= 1, Monochromatic - MONOCHROMATIC
= 2, Polychromatic - POLYCHROMATIC or LAUE (Laue)

4.2.6.5.3 Set wavelength - setWavelength

This method sets the monochromatic wavelength.

Method Definition:
public void setWavelength (double wave)
Parameters List:
wave
Wavelength.

4.2.6.5.4 Set lambda-min - setLambdaMin

This method sets the polychromatic lambda-min wavelength.

Method Definition:
public void setLambdaMin (double lmin)
Parameters List:
lmin
Lambda-min.

4.2.6.5.5 Set lambda-max - setLambdaMax

This method sets the polychromatic lambda-max wavelength.

Method Definition:
public void setLambdaMax (double lmax)
Parameters List:
lmax
Lambda-max.

4.2.6.5.6 Set synchrotron - setSynchrotron

This method sets the value of the Synchrotron radiation flag.

Method Definition:
public void setSynchrotron (boolean synch)
Parameters List:
synch
Synchrotron flag: True if Synchrotron source, otherwise false.

4.2.6.5.7 Set dispersion - setDispersion

This method sets the value of the Synchrotron dispersion (delta(lambda)/lambda).

Method Definition:
public void setDispersion (double disp)
Parameters List:
disp
Synchrotron: dispersion (delta(lambda)/lambda).

4.2.6.5.8 Set correlated dispersion - setCorrelatedDispersion

This method sets the value of the Synchrotron correlated dispersion.

Method Definition:
public void setCorrelatedDispersion (double delcor)
Parameters List:
delcor
Synchrotron: Correlated component of dispersion.

4.2.6.5.9 Set horizontal axis - setHorizontalAxis

This method sets the value of the Synchrotron horizontal axis.

Method Definition:
public void setHorizontalAxis (int iax_h)
Parameters List:
iax_h
The number of the laboratory axis (1-3) which is horizontal so that the correct axis may be identified for the horizontal divergence.

4.2.6.5.10 Set vertical axis - setVerticalAxis

This method sets the value of the Synchrotron vertical axis.

Method Definition:
public void setVerticalAxis (int iax_v)
Parameters List:
iax_h
The number of the laboratory axis (1-3) which is vertical so that the correct axis may be identified for the vertical divergence.

4.2.6.5.11 Set horizontal divergence - setHorizontalDivergence

This method sets the value of the Synchrotron horizontal divergence.

Method Definition:
public void setHorizontalDivergence (double divh)
Parameters List:
divh
Synchrotron: horizontal divergence in degrees.

4.2.6.5.12 Set vertical divergence - setVerticalDivergence

This method sets the value of the Synchrotron vertical divergence.

Method Definition:
public void setVerticalDivergence (double divv)
Parameters List:
divv
Synchrotron: vertical divergence in degrees.

4.2.6.5.13 Set polarisation - setPolarisation

This methods sets the value of the beam polarisation factor.

Method Definition:
public void setPolarisation (double pol)
Parameters List:
pol
The X-ray beam polarisation factor.

4.2.6.6 Get Values

4.2.6.6.1 Introduction

This section has methods to get individual sets of values from the x-ray source object.

Methods:

Get radiation type - getRadiationType
Get wavelength - getWavelength
Get lambda-min - getLambdaMin
Get lambda-max - getLambdaMax
Get synchrotron - getSynchrotron
Get dispersion - getDispersion
Get correlated dispersion - getCorrelatedDispersion
Get horizontal axis - getHorizontalAxis
Get vertical axis - getVerticalAxis
Get horizontal divergence - getHorizontalDivergence
Get vertical divergence - getVerticalDivergence
Get polarisation - getPolarisation

4.2.6.6.2 Get radiation type - getRadiationType

Gets the radiation type (monochromatic or polychromatic)

Method Definition:
public int getRadiationType()
Parameters List:
none
Method Return:
The radiation type MONOCHROMATIC (1) or POLYCHROMATIC (2, LAUE).

4.2.6.6.3 Get wavelength - getWavelength

This method returns the monochromatic wavelength.

Method Definition:
public double getWavelength ()
Parameters List:
none
Method Return:
The wavelength.

4.2.6.6.4 Get lambda-min - getLambdaMin

This method returns the polychromatic lambda-min wavelength.

Method Definition:
public double getLambdaMin ()
Parameters List:
none
Method Return:
Lambda-min.

4.2.6.6.5 Get lambda-max - getLambdaMax

This method returns the polychromatic lambda-max wavelength.

Method Definition:
public double getLambdaMax ()
Parameters List:
none
Method Return:
Lambda-max.

4.2.6.6.6 Get synchrotron - getSynchrotron

This method gets the value of the Synchrotron radiation flag.

Method Definition:
public boolean getSynchrotron ()
Parameters List:
none
Method Return:
True if Synchrotron source, otherwise false.

4.2.6.6.7 Get dispersion - getDispersion

This method gets the value of the Synchrotron dispersion (delta(lambda)/lambda).

Method Definition:
public double getDispersion ()
Parameters List:
none
Method Return:
Dispersion (delta(lambda)/lambda) value.

4.2.6.6.8 Get correlated dispersion - getCorrelatedDispersion

This method gets the value of the Synchrotron correlated dispersion.

Method Definition:
public double getCorrelatedDispersion ()
Parameters List:
none
Method Return:
Correlated dispersion value.

4.2.6.6.9 Get horizontal axis - getHorizontalAxis

This method gets the value of the Synchrotron horizontal axis.

Method Definition:
public int getHorizontalAxis ()
Parameters List:
none
Method Return:
The number of the laboratory axis (1-3) which is horizontal.

4.2.6.6.10 Get vertical axis - getVerticalAxis

This method gets the value of the Synchrotron vertical axis.

Method Definition:
public int getVerticalAxis ()
Parameters List:
none
Method Return:
The number of the laboratory axis (1-3) which is vertical.

4.2.6.6.11 Get horizontal divergence - getHorizontalDivergence

This method gets the value of the Synchrotron horizontal divergence.

Method Definition:
public double getHorizontalDivergence ()
Parameters List:
none
Method Return:
The horizontal divergence value.

4.2.6.6.12 Get vertical divergence - getVerticalDivergence

This method gets the value of the Synchrotron vertical divergence.

Method Definition:
public double getVerticalDivergence ()
Parameters List:
none
Method Return:
The vertical divergence value.

4.2.6.6.13 Get polarisation - getPolarisation

This method gets the value of the beam polarisation factor.

Method Definition:
public double getPolarisation ()
Parameters List:
none
Method Return:
The beam polarisation factor.

4.2.6.7 List X-ray Source Data

4.2.6.7.1 Introduction

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

Method:

List contents - listContents

4.2.6.7.2 List contents - listContents

This method lists the contents of the object.

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

⇑ Up 2   ⇑ Up 1   ⇑ Top of this