Package qupath.lib.objects.classes

Class PathClassFactory

java.lang.Object

qupath.lib.objects.classes.PathClassFactory

@Deprecated
public final class PathClassFactory
extends Object

Deprecated.

since v0.4.0 in favor of methods added to PathClass directly.

Factory for creating PathClasses.

This must be used in favor of creating PathClass objects directly to ensure that only one PathClass with a specified name (and, optionally, ancestry) can exist at any time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PathClassFactory.StandardPathClasses	Deprecated. Enum representing standard classifications.

Method Summary

Modifier and Type	Method	Description
static PathClass	getDerivedPathClass(PathClass parentClass, String name, Integer rgb)	Deprecated. since v0.4.0, use PathClass.getInstance(PathClass, String, Integer)
static PathClass	getNegative(PathClass parentClass)	Deprecated. since v0.4.0, use PathClass.getNegative(PathClass)
static PathClass	getOnePlus(PathClass parentClass)	Deprecated. since v0.4.0, use PathClass.getOnePlus(PathClass)
static PathClass	getPathClass(String name)	Deprecated. Get a PathClass, without specifying any color.
static PathClass	getPathClass(String name, Integer rgb)	Deprecated. since v0.4.0 in favor of PathClass.getInstance(String, Integer) or PathClass.fromString(String, Integer)
static PathClass	getPathClass(String baseName, String... names)	Deprecated. since v0.4.0 in favor of PathClass.fromArray(String...)
static PathClass	getPathClass(List<String> names)	Deprecated. since v0.4.0 in favor of PathClass.fromCollection(java.util.Collection)
static PathClass	getPathClass(PathClassFactory.StandardPathClasses pathClass)	Deprecated. since v0.4.0, use PathClass.StandardPathClasses
static PathClass	getPathClassUnclassified()	Deprecated. since v0.4.0, use instead PathClass.NULL_CLASS
static PathClass	getPositive(PathClass parentClass)	Deprecated. since v0.4.0, use PathClass.getPositive(PathClass)
static PathClass	getSingletonPathClass(PathClass pathClass)	Deprecated. since v0.4.0 in favor of PathClass.getSingleton(PathClass)
static PathClass	getThreePlus(PathClass parentClass)	Deprecated. since v0.4.0, use PathClass.getThreePlus(PathClass)
static PathClass	getTwoPlus(PathClass parentClass)	Deprecated. since v0.4.0, use PathClass.getTwoPlus(PathClass)

Methods inherited from class java.lang.Object

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

Method Details

getPathClass

public static PathClass getPathClass(String name)

Deprecated.

Get a PathClass, without specifying any color.

Parameters:

name -

Returns:

getPathClass

@Deprecated
public static PathClass getPathClass(String name,
 Integer rgb)

Deprecated.

since v0.4.0 in favor of PathClass.getInstance(String, Integer) or PathClass.fromString(String, Integer)

Get the PathClass object associated with a specific name. Note that this name must not contain newline; doing so will result in an IllegalArgumentException being thrown. If the name contains colon characters, it will be treated as a derived class.

Parameters:

name -

rgb -

Returns:

getPathClass

@Deprecated
public static PathClass getPathClass(String baseName,
 String... names)

Deprecated.

since v0.4.0 in favor of PathClass.fromArray(String...)

Get a derived PathClass object representing all the provided names, using default colors.

Note that names must not contain newline or colon characters; if they do an IllegalArgumentException will be thrown.

Parameters:

baseName - name of the base classification

names - array of names for each constituent part of the classification. For each name, a new class will be derived, starting from the base.

Returns:

a PathClass, as defined above

getPathClass

@Deprecated
public static PathClass getPathClass(List<String> names)

Deprecated.

since v0.4.0 in favor of PathClass.fromCollection(java.util.Collection)

Get a PathClass object representing all the provided names. The first entry in the list corresponds to the base name.

Parameters:

names - list of names for each constituent part of the classification.

Returns:

a PathClass containing all names

getSingletonPathClass

@Deprecated
public static PathClass getSingletonPathClass(PathClass pathClass)

Deprecated.

since v0.4.0 in favor of PathClass.getSingleton(PathClass)

Return a singleton version of a specific PathClass. This is useful during deserialization, which can circumvent the 'right' way to request PathClass objects via static methods.

Parameters:

pathClass -

Returns:

getDerivedPathClass

@Deprecated
public static PathClass getDerivedPathClass(PathClass parentClass,
 String name,
 Integer rgb)

Deprecated.

since v0.4.0, use PathClass.getInstance(PathClass, String, Integer)

Get a PathClass that has been derived from a parent class.

Parameters:

parentClass -

name -

rgb -

Returns:

getOnePlus

@Deprecated
public static PathClass getOnePlus(PathClass parentClass)

Deprecated.

since v0.4.0, use PathClass.getOnePlus(PathClass)

Get a standalone or derived 1+ classification, indicating weak positivity

Parameters:

parentClass - parent classification (may be null)

Returns:

getTwoPlus

@Deprecated
public static PathClass getTwoPlus(PathClass parentClass)

Deprecated.

since v0.4.0, use PathClass.getTwoPlus(PathClass)

Get a standalone or derived 2+ classification, indicating moderate positivity

Parameters:

parentClass - parent classification (may be null)

Returns:

getThreePlus

@Deprecated
public static PathClass getThreePlus(PathClass parentClass)

Deprecated.

since v0.4.0, use PathClass.getThreePlus(PathClass)

Get a standalone or derived 3+ classification, indicating strong positivity

Parameters:

parentClass - parent classification (may be null)

Returns:

getNegative

@Deprecated
public static PathClass getNegative(PathClass parentClass)

Deprecated.

since v0.4.0, use PathClass.getNegative(PathClass)

Get a standalone or derived Negative classification

Parameters:

parentClass - parent classification (may be null)

Returns:

getPositive

@Deprecated
public static PathClass getPositive(PathClass parentClass)

Deprecated.

since v0.4.0, use PathClass.getPositive(PathClass)

Get a standalone or derived Positive classification

Parameters:

parentClass - parent classification (may be null)

Returns:

getPathClass

@Deprecated
public static PathClass getPathClass(PathClassFactory.StandardPathClasses pathClass)

Deprecated.

since v0.4.0, use PathClass.StandardPathClasses

Get a standard PathClass.

Parameters:

pathClass -

Returns:

getPathClassUnclassified

@Deprecated
public static PathClass getPathClassUnclassified()

Deprecated.

since v0.4.0, use instead PathClass.NULL_CLASS

Return a special 'null' class to represent no classification.

This is useful for displaying available classes; it should not be set as the class for any object, rather an object that is unclassified should have a classification of null.

Returns: