Package qupath.lib.analysis.heatmaps

Enum Class DensityMaps.DensityMapType

java.lang.Object

java.lang.Enum<DensityMaps.DensityMapType>

qupath.lib.analysis.heatmaps.DensityMaps.DensityMapType

All Implemented Interfaces:

Serializable, Comparable<DensityMaps.DensityMapType>, Constable

Enclosing class:

DensityMaps

public static enum DensityMaps.DensityMapType
extends Enum<DensityMaps.DensityMapType>

Density map types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GAUSSIAN	Gaussian-weighted area normalization; maps provide weighted averaged object counts in a defined radius.
PERCENT	Maps contain at least two channels.
SUM	No normalization; maps provide raw object counts in a defined radius.

Method Summary

Modifier and Type	Method	Description
String	toString()
static DensityMaps.DensityMapType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DensityMaps.DensityMapType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUM

public static final DensityMaps.DensityMapType SUM

No normalization; maps provide raw object counts in a defined radius. This is equivalent to applying a circular sum filter to object counts per pixel.

GAUSSIAN

public static final DensityMaps.DensityMapType GAUSSIAN

Gaussian-weighted area normalization; maps provide weighted averaged object counts in a defined radius. This is equivalent to applying a Gaussian filter to object counts per pixel.

PERCENT

public static final DensityMaps.DensityMapType PERCENT

Maps contain at least two channels. The last channel contains the total count of objects within the density region. All other channels contain the proportion of objects meeting specific criteria, expressed as a percentage of the corresponding total object count.

This is useful, for example, to identify the Positive % cells.

Method Details

values

public static DensityMaps.DensityMapType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DensityMaps.DensityMapType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<DensityMaps.DensityMapType>