4.8.13 - Spot from Image Search - JdlSearchImageSpot

John W. Campbell

4.8.13.1 Introduction

This class stores details of a spot found by searching an image. All the main fields have public access.

Class, fields, constructors and methods:

Class Details
Accessible Fields
Constructors
Sort Order

4.8.13.2 Class Details

Package:
Jdl.JdlPX;
Class name:
JdlSearchImageSpot
Class definition:
public class JdlSearchImageSpot
Extends:
Object
Implements:
Cloneable

Comparable
Comparator<JdlSearchImageSpot>
Actions:
none

4.8.13.3 Accessible Fields

The following accessible fields have been defined:

public final static int AXIS1_COORDINATE
Flag to sort on local axis 1 coordinate.
public final static int AXIS2_COORDINATE
Flag to sort on local axis 2 coordinate.
public final static int INTENSITY
Flag to sort on intensity.
static int sort_option
public int img_id
Image identifier or number (>0) - create from image number (>0) and rotation range number using the static method JdlDiffractionDataModule.setImageID(..)
public double phimid
Phi angle (degrees) for middle of the oscillation range. (May be 0.0 if the list of spots is to be used for positions only and not, for example, for determining a crystal setting).
public double ax1_pos
Spot position along 1'st local axis in rasters.
public double ax2_pos
Spot position along 2'nd local axis in rasters.
public double sumint
Spot intensity (rough estimate) - sum of background subtracted pixel intensities.
public int npix
Number of pixels in spot.
public double siz_ax1
Spot size along 1'st local axis in rasters.
public double siz_ax2
Spot size along 2'nd local axis in rasters.
public int spot_flag
Spot flag = 0, unset, = 1 good spot, >1 bad spot. (= 2 large/badly-defined spot,)

4.8.13.4 Constructors

4.8.13.4.1 Introduction

Constructors are available to construct a JdlSearchImageSpot object with default (unset) values or given a set of all the parameter values.

Constructors:

Default Constructor
Double Parameters Constructor

4.8.13.4.2 Default Constructor

This constructs an object with all values set to zero.

Constructor Definition:
public JdlSearchImageSpot()
Parameters List:
none

4.8.13.4.3 Double Parameters Constructor

Constructor Definition:
public JdlSearchImageSpot(int img_id, double phimid, double ax1_pos, double ax2_pos, double sumint, int npix, double siz_ax1, double siz_ax2, int spot_flag)
Parameters List:
img_id
Image identifier or number (>0) - create from image number (>0) and rotation range number using the static method JdlDiffractionDataModule.setImageID(..).
phimid
Phi angle (degrees) for middle of the oscillation range. (May be 0.0 if the list of spots is to be used for positions only and not, for example, for determining a crystal setting).
ax1_pos
Spot position along 1'st local axis in rasters.
ax2_pos
Spot position along 2'nd local axis in rasters.
sumint
Spot intensity (rough estimate) - sum of background subtracted pixel intensities.
npix
Number of pixels in spot.
siz_ax1
Spot size along 1'st local axis in rasters.
siz_ax2
Spot size along 2'nd local axis in rasters.
spot_flag
Spot flag (= 0, unset, = 1 good spot, =2 bad spot).

4.8.13.5 Sort Order

4.8.13.5.1 Introduction

This section has methods to set and return the value of the flag which will determine the sort order of a found spots list if it is sorted.

Methods:

Set sort order - setSortOption
Get sort order - getSortOption

4.8.13.5.2 Set sort order - setSortOption

This method sets the required sort order flag.

Method Definition:
public static void setSortOption (int srt_opt)
Parameters List:
srt_opt
Flag to set the sort order:
= 1, Sort on ax1_pos
= 2, Sort on ax2_pos
= 3, Sort on sumint

4.8.13.5.3 Get sort order - getSortOption

This method returns the current value of the sort order flag. Note that it does not indicate, for example, that a spot list has actually been sorted.

Method Definition:
public static int getSortOption()
Parameters List:
none
Method Return:
The sort order flag.

⇑ Up 2   ⇑ Up 1   ⇑ Top of this