Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Calibration Class Reference

Public Member Functions

 Calibration (ImagePlus imp)
 
 Calibration ()
 
boolean scaled ()
 
void setUnit (String unit)
 
String getUnit ()
 
String getUnits ()
 
double getX (int x)
 
double getY (int y)
 
double getZ (int z)
 
void setFunction (int function, double[] coefficients, String unit)
 
void setFunction (int function, double[] coefficients, String unit, boolean zeroClip)
 
void setImage (ImagePlus imp)
 
void disableDensityCalibration ()
 
String getValueUnit ()
 
void setValueUnit (String unit)
 
double[] getCoefficients ()
 
boolean calibrated ()
 
int getFunction ()
 
float[] getCTable ()
 
double getCValue (int value)
 
double getCValue (double value)
 
double getRawValue (double value)
 
Calibration copy ()
 
boolean equals (Calibration cal)
 
boolean isSigned16Bit ()
 
String toString ()
 

Data Fields

double pixelWidth = 1.0
 
double pixelHeight = 1.0
 
double pixelDepth = 1.0
 
double frameInterval
 
double xOrigin
 
double yOrigin
 
double zOrigin
 
String info
 

Static Public Attributes

static final int STRAIGHT_LINE =0
 
static final int NONE =20
 

Detailed Description

Calibration objects contain an image's spatial and density calibration data.

Definition at line 6 of file Calibration.java.

Constructor & Destructor Documentation

Calibration ( ImagePlus  imp)
inline

Constructs a new Calibration object using the default values.

Definition at line 61 of file Calibration.java.

Calibration ( )
inline

Constructs a new Calibration object using the default values. For density calibration, the image is assumed to be 8-bits.

Definition at line 70 of file Calibration.java.

Member Function Documentation

boolean calibrated ( )
inline

Returns true if this image is density calibrated.

Definition at line 175 of file Calibration.java.

Calibration copy ( )
inline

Returns a clone of this object.

Definition at line 291 of file Calibration.java.

boolean equals ( Calibration  cal)
inline

Compares two Calibration objects for equality.

Definition at line 314 of file Calibration.java.

double [] getCoefficients ( )
inline

Returns the calibration function coefficients.

Definition at line 170 of file Calibration.java.

float [] getCTable ( )
inline

Returns the calibration table. For 8-bit images, the table has a length of 256, for 16-bit images, the length is 65536.

Definition at line 187 of file Calibration.java.

double getCValue ( int  value)
inline

Converts a raw pixel value to a density calibrated value.

Definition at line 236 of file Calibration.java.

double getCValue ( double  value)
inline

Converts a raw pixel value to a density calibrated value.

Definition at line 254 of file Calibration.java.

int getFunction ( )
inline

Returns the calibration function ID.

Definition at line 180 of file Calibration.java.

double getRawValue ( double  value)
inline

Converts a density calibrated value into a raw pixel value.

Definition at line 270 of file Calibration.java.

String getUnit ( )
inline

Returns the distance unit (e.g. "micron", "inch").

Definition at line 88 of file Calibration.java.

String getUnits ( )
inline

Returns the plural form of the distance unit (e.g. "microns", "inches").

Definition at line 93 of file Calibration.java.

String getValueUnit ( )
inline

Returns the value unit.

Definition at line 159 of file Calibration.java.

double getX ( int  x)
inline

Converts a x-coodinate in pixels to physical units (e.g. mm).

Definition at line 108 of file Calibration.java.

double getY ( int  y)
inline

Converts a y-coodinate in pixels to physical units (e.g. mm).

Definition at line 113 of file Calibration.java.

double getZ ( int  z)
inline

Converts a z-coodinate in pixels to physical units (e.g. mm).

Definition at line 118 of file Calibration.java.

boolean isSigned16Bit ( )
inline

Returns true if this is a signed 16-bit image.

Definition at line 328 of file Calibration.java.

boolean scaled ( )
inline

Returns true if this image is spatially calibrated.

Definition at line 74 of file Calibration.java.

void setFunction ( int  function,
double[]  coefficients,
String  unit 
)
inline

Sets the calibration function, coefficient table and unit (e.g. "OD").

Definition at line 123 of file Calibration.java.

void setImage ( ImagePlus  imp)
inline

Disables the density calibation if the specified image has a differenent bit depth.

Definition at line 141 of file Calibration.java.

void setUnit ( String  unit)
inline

Sets the distance unit (e.g. "mm", "inch").

Definition at line 79 of file Calibration.java.

void setValueUnit ( String  unit)
inline

Sets the value unit.

Definition at line 164 of file Calibration.java.

Field Documentation

double frameInterval

Frame interval in seconds

Definition at line 22 of file Calibration.java.

String info

Plugin writers can use this string to store information about the image. This string is saved in the TIFF header if it is not longer than 64 characters and it contains no '=' or '
' characters.

Definition at line 36 of file Calibration.java.

double pixelDepth = 1.0

Pixel depth in 'unit's

Definition at line 19 of file Calibration.java.

double pixelHeight = 1.0

Pixel height in 'unit's

Definition at line 16 of file Calibration.java.

double pixelWidth = 1.0

Pixel width in 'unit's

Definition at line 13 of file Calibration.java.

double xOrigin

X origin in pixels (not currently used by ImageJ).

Definition at line 25 of file Calibration.java.

double yOrigin

Y origin in pixels (not currently used by ImageJ).

Definition at line 28 of file Calibration.java.

double zOrigin

Z origin in pixels (not currently used by ImageJ).

Definition at line 31 of file Calibration.java.


The documentation for this class was generated from the following file: