Package qupath.lib.display.settings

Class ChannelSettings

java.lang.Object

qupath.lib.display.settings.ChannelSettings

public class ChannelSettings
extends Object

A simple class to store the main information needed by QuPath to display an image channel with a requested color and brightness/contrast setting.

Constructor Summary

Constructors

Constructor	Description
ChannelSettings()

Method Summary

Modifier and Type	Method	Description
static ChannelSettings	create(String name, float minDisplay, float maxDisplay, ChannelColor color, boolean isShowing)	Create a new channel settings object.
ChannelColor	getColor()	Get the color used to display the channel, or null if a color is not relevant.
float	getMaxDisplay()	Get the requested maximum display value for the channel, This should be used with the last entry in any lookup table.
float	getMinDisplay()	Get the requested minimum display value for the channel.
String	getName()	Get the name of the channel.
boolean	isShowing()	Get whether the channel should be displayed.

Methods inherited from class java.lang.Object

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

Constructor Details

ChannelSettings

public ChannelSettings()

Method Details

create

public static ChannelSettings create(String name,
 float minDisplay,
 float maxDisplay,
 ChannelColor color,
 boolean isShowing)

Create a new channel settings object.

Parameters:

name -

minDisplay -

maxDisplay -

color -

isShowing -

Returns:

getName

public String getName()

Get the name of the channel.

Returns:

getMinDisplay

public float getMinDisplay()

Get the requested minimum display value for the channel. This should be used with the first entry in any lookup table.

Returns:

getMaxDisplay

public float getMaxDisplay()

Get the requested maximum display value for the channel, This should be used with the last entry in any lookup table.

Returns:

getColor

public ChannelColor getColor()

Get the color used to display the channel, or null if a color is not relevant.

Returns:

isShowing

public boolean isShowing()

Get whether the channel should be displayed.

Returns: