Package com.flir.thermalsdk.image

Class Scale

java.lang.Object

com.flir.thermalsdk.image.Scale

public final class Scale
extends Object

Defines an image's linear scale object and basic scale's parameters. The scale defines the way the Palette is applied to the ThermalImage. Scale is an interval of the temperature, where colors from a selected Palette is applied. The available temperature's range is defined by the ThermalImage.

Scale cannot be created directly, it should always be obtained from ThermalImage. To do so, the ThermalImage.getScale() method should be called.

Method Summary

Modifier and Type	Method	Description
void	enableAutoAdjust(boolean enable)	Deprecated. Use ImageColorizer.setAutoScale(boolean) instead.
@Nullable JavaImageBuffer	getFixedFullRangeScaleImage()	Deprecated. This feature will probably be removed in upcoming release.
static @Nullable JavaImageBuffer	getFixedFullRangeScaleImage(Palette palette)	Deprecated. This feature will probably be removed in upcoming release.
@Nullable JavaImageBuffer	getImage()	Deprecated. Use ImageColorizer.getScaleImage() instead.
ThermalValue	getRangeMax()	Gets the maximum range, where colors defined by the Palette are applied to the ThermalImage. Note: Use ImageColorizer.getScaleRangeMax() if auto scale is enabled.
ThermalValue	getRangeMin()	Gets the minimum range, where colors defined by the Palette are applied to the ThermalImage. Note: Use ImageColorizer.getScaleRangeMin() if auto scale is enabled.
boolean	isAutoAdjustEnabled()	Deprecated. Use ImageColorizer.isAutoScale() instead.
void	setRange(ThermalValue min, ThermalValue max)	Sets the minimum and maximum scale values.
void	setRangeMax(ThermalValue max)	Sets the maximum range, where colors defined by the Palette are applied to the ThermalImage. Note: Ensure ImageColorizer.isAutoScale() is disabled when setting this value.
void	setRangeMin(ThermalValue min)	Sets the minimum range, where colors defined by the Palette are applied to the ThermalImage. Note: Ensure ImageColorizer.isAutoScale() is disabled when setting this value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getRangeMin

public ThermalValue getRangeMin()

Gets the minimum range, where colors defined by the Palette are applied to the ThermalImage.
Note: Use ImageColorizer.getScaleRangeMin() if auto scale is enabled.

Returns:

the minimum scale value.

getRangeMax

public ThermalValue getRangeMax()

Gets the maximum range, where colors defined by the Palette are applied to the ThermalImage.
Note: Use ImageColorizer.getScaleRangeMax() if auto scale is enabled.

Returns:

the maximum scale value.

setRangeMin

public void setRangeMin(ThermalValue min)

Sets the minimum range, where colors defined by the Palette are applied to the ThermalImage.
Note: Ensure ImageColorizer.isAutoScale() is disabled when setting this value.

See Also:

• ImageColorizer.isAutoScale()

setRangeMax

public void setRangeMax(ThermalValue max)

Sets the maximum range, where colors defined by the Palette are applied to the ThermalImage.
Note: Ensure ImageColorizer.isAutoScale() is disabled when setting this value.

setRange

public void setRange(ThermalValue min,
 ThermalValue max)

Sets the minimum and maximum scale values. It will define, how colors defined by the Palette are applied to the ThermalImage.
Note: Ensure ImageColorizer.isAutoScale() is disabled when setting these values.

Parameters:

min - minimum scale value to be used.

max - maximum scale value to be used.

enableAutoAdjust

@Deprecated
public void enableAutoAdjust(boolean enable)

Deprecated.

Use ImageColorizer.setAutoScale(boolean) instead.

Sets auto adjust enabled or disabled. When auto adjust is enabled, the Scale will automatically update to match the image parameters.

Parameters:

enable - pass true to enable auto adjust, otherwise false.

isAutoAdjustEnabled

@Deprecated
public boolean isAutoAdjustEnabled()

Deprecated.

Use ImageColorizer.isAutoScale() instead.

Gets auto adjust setting.

Returns:

true if auto adjust is enabled, otherwise false.

getImage

@Deprecated
@Nullable
public @Nullable JavaImageBuffer getImage()

Deprecated.

Use ImageColorizer.getScaleImage() instead.

Gets a linear scale image as a JavaImageBuffer object. That image in the buffer is a visual representation of the Palette applied to the ThermalImage. It is used for drawing purposes.

Returns:

a linear scale image as a JavaImageBuffer object or null if image cannot be obtained.

See Also:

• getFixedFullRangeScaleImage()

getFixedFullRangeScaleImage

@Deprecated
@Nullable
public @Nullable JavaImageBuffer getFixedFullRangeScaleImage()

Deprecated.

This feature will probably be removed in upcoming release.

Gets an image representing the full thermal range scale using a current palette.

Returns:

a full thermal range scale image as a JavaImageBuffer object or null if image cannot be obtained.

See Also:

• getImage()
• getFixedFullRangeScaleImage(Palette)

getFixedFullRangeScaleImage

@Deprecated
@Nullable
public static @Nullable JavaImageBuffer getFixedFullRangeScaleImage(Palette palette)

Deprecated.

This feature will probably be removed in upcoming release.

Gets an image representing the full thermal range scale using a specified palette.

Parameters:

palette - a Palette to be used for rendering full scale image

Returns:

a full thermal range scale image as a JavaImageBuffer object or null if image cannot be obtained.

See Also:

• getImage()
• getFixedFullRangeScaleImage()
• PaletteManager.getDefaultPalettes()