4.2.10 - Detector Limits - JdlDetectorLimits

John W. Campbell

4.2.10.1 Introduction

This class stores some limits which may be used to select parts of a detector image for processing. Note that the maximum radius 'rmax' is not stored here but is stored in a JdlPositionedDetector object. By default the values make no further selections of the image.

See also the Diffraction Data Module for a description of the parameters and the laboratory coordinate axes.

Class, fields, constructors and methods:

Class Details
Accessible Fields
Constructors
Set Values
Get Values
List Detector Limits Data

4.2.10.2 Class Details

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

4.2.10.3 Accessible Fields

The following accessible fields have been defined:

double x_min
Detector limit x_min (rasters from image origin).
double x_max
Detector limit x_max (rasters from image origin - if zero treat as maximum limit of image).
double y_min
Detector limit y_min (rasters from image origin).
double y_max
Detector limit y_max (rasters from image origin - if zero treat as maximum limit of image).
double rmin
Minimum exclusion radius in mm. Exclude the portion of the image this than this distance from the pattern centre or from r_xcen, r_ycen if set. Ignored if zero.
double r_xcen
Explicit x-centre posiition in rasters for 'rmin' exclusion calculation.
double r_ycen
Explicit y-centre posiition in rasters for 'rmin' exclusion calculation.
double twoth_min
Two theta minimum angle in degrees.

4.2.10.4 Constructors

4.2.10.4.1 Introduction

There are two constructors, one sets up a JdlDetectorLimits object with a default parameter set and the other with a fully specified set of parameters.

Constructors:

Default Constructor
Full Constructor

4.2.10.4.2 Default Constructor

This sets up a JdlDetectorLimits object with default parameters ( no additional exclusions) as follows:
  x_min = 0.0
  x_max = 0.0
  y_min = 0.0
  y_max = 0.0
  rmin = 0.0
  r_xcen = 0.0
  r_ycen = 0.0
  twoth_min = 0.0;

Constructor Definition:
public JdlDetectorLimits()
Parameters List:
none

4.2.10.4.3 Full Constructor

This constructor sets up a fully specified JdlDetectorLimits object.

Constructor Definition:
public JdlDetectorLimits (double x_min, double x_max, double y_min, double y_max, double rmin, double r_xcen, double r_ycen, double twoth_min)
Parameters List:
x_min
Detector limit x_min (rasters from image origin).
x_max
Detector limit x_max (rasters from image origin - if zero treat as maximum limit of image).
y_min
Detector limit y_min (rasters from image origin).
y_max
Detector limit y_max (rasters from image origin - if zero treat as maximum limit of image).
rmin
Minimum exclusion radius in mm. Exclude the portion of the image this than this distance from the pattern centre or from r_xcen, r_ycen if set. Ignored if zero.
r_xcen
Explicit x-centre posiition in rasters for 'rmin' exclusion calculation.
r_ycen
Explicit y-centre posiition in rasters for 'rmin' exclusion calculation.
twoth_min
Two theta minimum angle in degrees.

4.2.10.5 Set Values

4.2.10.5.1 Introduction

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

Methods:

Set x, y limits - setXYLimits
Set 'rmin' limits - setRminLimits
Set two theta minimum - setTwoThetaMin

4.2.10.5.2 Set x, y limits - setXYLimits

This method sets the x and y detector limits.

Method Definition:
public void setXYLimits (double x_min, double x_max, double y_min, double y_max)
Parameters List:
x_min
Detector limit x_min (rasters from image origin).
x_max
Detector limit x_max (rasters from image origin - if zero treat as maximum limit of image).
y_min
Detector limit y_min (rasters from image origin).
y_max
Detector limit y_max (rasters from image origin - if zero treat as maximum limit of image).

4.2.10.5.3 Set 'rmin' limits - setRminLimits

This method sets the minimum radius exclusion limit parameters.

Method Definition:
public void setRminLimits(double rmin, double r_xcen, double r_ycen)
Parameters List:
rmin
Minimum exclusion radius in mm. Exclude the portion of the image this than this distance from the pattern centre or from r_xcen, r_ycen if set. Ignored if zero.
r_xcen
Explicit x-centre posiition in rasters for 'rmin' exclusion calculation.
r_ycen
Explicit y-centre posiition in rasters for 'rmin' exclusion calculation.

4.2.10.5.4 Set two theta minimum - setTwoThetaMin

This method sets the value for the minimum two theta value.

Method Definition:
public void setTwoThetaMin(double twoth_min)
Parameters List:
twoth_min
Two theta minimum angle in degrees.

4.2.10.6 Get Values

4.2.10.6.1 Introduction

This section has methods to get individual values from the detector limits object.

Methods:

Get xmin - getXmin
Get xmax - getXmax
Get ymin - getYmin
Get ymax - getYmax
Get rmin - getRmin
Get r_xcen - getRXCen
Get r_ycen - getRYCen
Get two theta minimum - getTwoThetaMin

4.2.10.6.2 Get xmin - getXmin

This method returns value of xmin.

Method Definition:
public double getXmin()
Parameters List:
none
Method Return:
The xmin value in rasters.

4.2.10.6.3 Get xmax - getXmax

This method returns value of xmax.

Method Definition:
public double getXmax()
Parameters List:
none
Method Return:
The xmax value in rasters.

4.2.10.6.4 Get ymin - getYmin

This method returns value of ymin.

Method Definition:
public double getYmin()
Parameters List:
none
Method Return:
The ymin value in rasters.

4.2.10.6.5 Get ymax - getYmax

This method returns value of ymax.

Method Definition:
public double getYmax()
Parameters List:
none
Method Return:
The ymax value in rasters.

4.2.10.6.6 Get rmin - getRmin

This method returns value of rmin.

Method Definition:
public double getRmin()
Parameters List:
none
Method Return:
The rmin value in rasters.

4.2.10.6.7 Get r_xcen - getRXCen

This method returns value of r_xcen.

Method Definition:
public double getRXCen()
Parameters List:
none
Method Return:
The r_xcen value in rasters.

4.2.10.6.8 Get r_ycen - getRYCen

This method returns value of r_ycen.

Method Definition:
public double getRYCen()
Parameters List:
none
Method Return:
The r_ycen value in rasters.

4.2.10.6.9 Get two theta minimum - getTwoThetaMin

This method returns the value for the minimum two theta value.

Method Definition:
public double getTwoThetaMin()
Parameters List:
none
Method Return:
The twoth_min value.

4.2.10.7 List Detector Limits Data

4.2.10.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.10.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