Package qupath.lib.objects

Class DefaultPathObjectConnectionGroup

java.lang.Object

qupath.lib.objects.DefaultPathObjectConnectionGroup

All Implemented Interfaces:

Externalizable, Serializable, PathObjectConnectionGroup

public class DefaultPathObjectConnectionGroup
extends Object
implements PathObjectConnectionGroup, Externalizable

Simple, default implementation of PathObjectConnectionGroup.

Author:

Pete Bankhead

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_OBJECT_CONNECTIONS	Key to use when storing object connections as a property of an ImageData object.

Constructor Summary

Constructors

Constructor	Description
DefaultPathObjectConnectionGroup()	Default constructor.
DefaultPathObjectConnectionGroup(PathObjectConnectionGroup connections)	Create a connections group, copying the connections from an existing group.

Method Summary

Modifier and Type	Method	Description
boolean	containsObject(PathObject pathObject)	Returns true if the specified PathObject is contained within this group.
List<PathObject>	getConnectedObjects(PathObject pathObject)	Get all the connections to a specified PathObject stored in this group.
Collection<PathObject>	getPathObjects()	Get an unmodifiable collection containing all the PathObjects contained within this group.
Collection<PathObject>	getPathObjectsForRegion(ImageRegion region)	Get all the objects with connections that may intersect the specified region.
void	readExternal(ObjectInput in)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Details

KEY_OBJECT_CONNECTIONS

public static final String KEY_OBJECT_CONNECTIONS

Key to use when storing object connections as a property of an ImageData object.

See Also:

• Constant Field Values

Constructor Details

DefaultPathObjectConnectionGroup

public DefaultPathObjectConnectionGroup()

Default constructor.

DefaultPathObjectConnectionGroup

public DefaultPathObjectConnectionGroup(PathObjectConnectionGroup connections)

Create a connections group, copying the connections from an existing group. This may be useful if the other PathObjectConnectionGroup is not itself serializable.

Parameters:

connections -

Method Details

getPathObjects

public Collection<PathObject> getPathObjects()

Description copied from interface: PathObjectConnectionGroup

Get an unmodifiable collection containing all the PathObjects contained within this group.

Specified by:

getPathObjects in interface PathObjectConnectionGroup

Returns:

getConnectedObjects

public List<PathObject> getConnectedObjects(PathObject pathObject)

Description copied from interface: PathObjectConnectionGroup

Get all the connections to a specified PathObject stored in this group.

If containsObject(pathObject) returns null, this will return an empty list (and not null).

Specified by:

getConnectedObjects in interface PathObjectConnectionGroup

Parameters:

pathObject -

Returns:

getPathObjectsForRegion

public Collection<PathObject> getPathObjectsForRegion(ImageRegion region)

Description copied from interface: PathObjectConnectionGroup

Get all the objects with connections that may intersect the specified region.

Specified by:

getPathObjectsForRegion in interface PathObjectConnectionGroup

Parameters:

region -

Returns:

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

containsObject

public boolean containsObject(PathObject pathObject)

Description copied from interface: PathObjectConnectionGroup

Returns true if the specified PathObject is contained within this group.

Specified by:

containsObject in interface PathObjectConnectionGroup

Parameters:

pathObject -

Returns: