4.5.5 - Axis Order - JdlAxisOrder

John W. Campbell

4.5.5.1 Introduction

This class sets up image axis order data e.g. for the JdlPXImage object (via the JdlImageData object). The axis order string defines the axis order in an image file in terms of x and y (the detector xd, yd axes). The slower moving axis is given first followed by the faster moving axis. A minus sign is used when the order of an axis is reversed. The code 's', if present indicates that byte swapping is to be done and the code 'n' indicates that no byte swapping is to be done (byte swapping only relevant for some image data types i.e. those in which pixel values are stored in more that one byte of data). Characters, other than 'x', 'y', '-', '+', 's' and 'n', or their upper case equivalents, are ignored. Examples of valid axis order strings are xy, +xd+yd and -yxs.

Class, constructor and methods:

Class Details
Accessible Fields
Constructor
Methods

4.5.5.2 Class Details

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

4.5.5.3 Accessible Fields

No fields with public, package or protected access defined.

4.5.5.4 Constructor

4.5.5.4.1 Introduction

A single constructor is available.

Constructor:

Standard constructor

4.5.5.4.2 Standard constructor

Constructs a JdlAxisOrder object from a given axis order string e.g. +xf-yf.

Constructor Definition:
public JdlAxisOrder(String str)
Parameters List:
str
The axis order string.

4.5.5.5 Methods

4.5.5.5.1 Introduction

This section had methods for returning flags giving the axis order or byte swapping requirements as decoded from the axis order string.

Methods:

Axis order - mosflmOrder
Byte swap flag - mosflmSwap
Byte swap flag - mosflmIswap

4.5.5.5.2 Axis order - mosflmOrder

Decodes the axis order string, as set when the object was constructed, based on the MOSFLM program coordinate axes convention (local axis 1 = x, local axis 2 = y (or xf, yf or xd, yd))

Method Definition:
public int mosflmOrder()
Parameters List:
none
Method Return:
The order number from 1-8 (0 if invalid string was given).
Axis order:
   1   +xf slow   +yf fast
   2   +xf slow   -yf fast
   3   -xf slow   +yf fast
   4   -xf slow   -yf fast
   5   +yf slow   +xf fast
   6   +yf slow   -xf fast
   7   -yf slow   +xf fast
   8   -yf slow   -xf fast

4.5.5.5.3 Byte swap flag - mosflmSwap

Returns the byte swap flag, derived from the axis order string, if present.

Method Definition:
public boolean mosflmSwap()
Parameters List:
none
Method Return:
Returns the value of the byte swap flag:
= true, swap bytes when reading images with more than one byte per pixel
= false, do not

4.5.5.5.4 Byte swap flag - mosflmIswap

Returns the byte swap flag as an integer value (with an indication if it was not explicitly set).

Method Definition:
public int mosflmIswap()
Parameters List:
none
Method Return:
Returns the value of the byte swap flag:
= 2, swap bytes when reading images with more than one byte per pixel = 1, do not (explicitly set)
= 0, do not (by default)

⇑ Up 2   ⇑ Up 1   ⇑ Top of this