Class Calibration

Method Details

• scaled

  public boolean scaled()

  Returns 'true' if this image is spatially calibrated.

• scaledOrOffset

  public boolean scaledOrOffset()

  Returns 'true' if this image is spatially calibrated or has offsets.

• setUnit

  public void setUnit(String unit)

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

• setXUnit

  public void setXUnit(String unit)

  Sets the X length unit.

• setYUnit

  public void setYUnit(String unit)

  Sets the Y length unit.

• setZUnit

  public void setZUnit(String unit)

  Sets the Z length unit.

• getUnit

  public String getUnit()

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

• getXUnit

  public String getXUnit()

  Returns the X length unit.

• getYUnit

  public String getYUnit()

  Returns the Y length unit, or the default unit if 'yunit' is null.

• getZUnit

  public String getZUnit()

  Returns the Z length unit, or the default unit if 'zunit' is null.

• getUnits

  public String getUnits()

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

• getXUnits

  public String getXUnits()

  Returns the plural form of the X length unit (e.g. "microns", "inches"), or of the default unit if 'xunit' is null.

• getYUnits

  public String getYUnits()

  Returns the plural form of the Y length unit (e.g. "microns", "inches"), or of the default unit if 'yunit' is null.

• getZUnits

  public String getZUnits()

  Returns the plural form of the Z length unit (e.g. "microns", "inches"), or of the default unit if 'zunit' is null.

• setTimeUnit

  public void setTimeUnit(String unit)

  Sets the time unit (e.g. "sec", "msec").

• getTimeUnit

  public String getTimeUnit()

  Returns the distance unit (e.g. "sec", "msec").

• getX

  public double getX(double x)

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

• getY

  public double getY(double y)

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

• getY

  public double getY(double y, int imageHeight)

  Converts a y-coordinate in pixels to physical units (e.g. mm), taking into account the invertY and global "Invert Y Coordinates" flags.

• getZ

  public double getZ(double z)

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

• getRawX

  public double getRawX(double x)

  Converts a x-coordinate in physical units to pixels.

• getRawY

  public double getRawY(double y)

  Converts a y-coodinate in physical units to pixels.

• getRawZ

  public double getRawZ(double z)

  Converts a z-coodinate in physical units to pixels.

• getRawY

  public double getRawY(double y, int imageHeight)

  Converts a y-coodinate in physical units to pixels, taking into account the 'invertY' flag.

• setFunction

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

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

• setFunction

  public void setFunction(int function, double[] coefficients, String unit, boolean zeroClip)

• setImage

  public void setImage(ImagePlus imp)

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

• disableDensityCalibration

  public void disableDensityCalibration()

• getValueUnit

  public String getValueUnit()

  Returns the value unit.

• setValueUnit

  public void setValueUnit(String unit)

  Sets the value unit.

• getCoefficients

  public double[] getCoefficients()

  Returns the calibration function coefficients.

• calibrated

  public boolean calibrated()

  Returns true if this image is density calibrated.

• getFunction

  public int getFunction()

  Returns the calibration function ID.

• getCTable

  public float[] getCTable()

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

• setCTable

  public void setCTable(float[] table, String unit)

  Sets the calibration table. With 8-bit images, the table must have a length of 256. With 16-bit images, it must be 65536.

• getCValue

  public double getCValue(int value)

  Converts a raw pixel value to a density calibrated value.

• getCValue

  public double getCValue(double value)

  Converts a raw pixel value to a density calibrated value.

• getRawValue

  public double getRawValue(double value)

  Converts a density calibrated value into a raw pixel value.

• copy

  public Calibration copy()

  Returns a clone of this object.

• clone

  public Object clone()

  Overrides:

  clone in class Object

• equals

  public boolean equals(Calibration cal)

  Compares two Calibration objects for equality.

• isSigned16Bit

  public boolean isSigned16Bit()

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

• setSigned16BitCalibration

  public void setSigned16BitCalibration()

  Sets up a calibration function that subtracts 32,768 from pixel values.

• zeroClip

  public boolean zeroClip()

  Returns true if zero clipping is enabled.

• setInvertY

  public void setInvertY(boolean invertYCoordinates)

  Sets the 'invertY' flag.

• getInvertY

  public boolean getInvertY()

  Returns the 'invertY' flag.

• setLoopBackAndForth

  public static void setLoopBackAndForth(boolean loop)

  Set the default state of the animation "Loop back and forth" flag

• toString

  public String toString()

  Overrides:

  toString in class Object