Package org.anchoranalysis.mpp.mark.conic

Class Circle

Object

org.anchoranalysis.mpp.mark.Mark

org.anchoranalysis.mpp.mark.MarkWithPosition

org.anchoranalysis.mpp.mark.conic.MarkWithPositionAndSingleRadius

org.anchoranalysis.mpp.mark.conic.Circle

All Implemented Interfaces:

Serializable

public class Circle
extends MarkWithPositionAndSingleRadius

Represents a 2D circle mark.

This class extends MarkWithPositionAndSingleRadius to provide functionality specific to circular marks.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Circle()
Circle(Bound boundRadius)	Creates a circle with a radius within particular bounds.
Circle(Circle source)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Mark	duplicate()	Creates a duplicate of this mark.
String	getName()	Returns the name of this mark type.
int	numberDimensions()	Returns the number of dimensions of this mark.
String	toString()
double	volume(int regionID)	Calculates the volume of a specific region of the mark.

Methods inherited from class org.anchoranalysis.mpp.mark.conic.MarkWithPositionAndSingleRadius

box, boxAllRegions, equalsDeep, getBoundRadius, getRadius, isPointInside, numberRegions, quickOverlap, radiusForRegion, radiusForRegionSquared, scale, setRadius, strMarks

Methods inherited from class org.anchoranalysis.mpp.mark.MarkWithPosition

centerPoint, getPosition, positionString, setPosition

Methods inherited from class org.anchoranalysis.mpp.mark.Mark

deriveObject, equalsID, getIdentifier, identifier, setId

Methods inherited from class java.lang.Object

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

Constructor Details

Circle

public Circle(Bound boundRadius)

Creates a circle with a radius within particular bounds.

Parameters:

boundRadius - the bound for the circle's radius

Circle

public Circle(Circle source)

Copy constructor.

Parameters:

source - the Circle to copy from

Circle

public Circle()

Method Details

getName

public String getName()

Description copied from class: Mark

Returns the name of this mark type.

Specified by:

getName in class Mark

Returns:

the name of the mark

volume

public double volume(int regionID)

Description copied from class: Mark

Calculates the volume of a specific region of the mark.

Specified by:

volume in class Mark

Parameters:

regionID - the ID of the region

Returns:

the volume of the region

toString

public String toString()

Overrides:

toString in class Object

duplicate

public Mark duplicate()

Description copied from class: Mark

Creates a duplicate of this mark.

Specified by:

duplicate in class Mark

Returns:

a new Mark instance that is a copy of this one

numberDimensions

public int numberDimensions()

Description copied from class: Mark

Returns the number of dimensions of this mark.

Specified by:

numberDimensions in class Mark

Returns:

the number of dimensions