gov.nih.nci.mageom.domain.Array
Interface Fiducial

All Superinterfaces:
Describable, Extendable
All Known Implementing Classes:
FiducialImpl

public interface Fiducial
extends Describable

A marking on the surface of the array that can be used to identify the array's origin, the coordinates of which are the fiducial's centroid.

Version:
%I%, %G%

Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this Fiducial object's distanceUnit attribute.
 OntologyEntry getFiducialType()
          Returns the value of this Fiducial object's fiducialType attribute.
 Position getPosition()
          Returns the value of this Fiducial object's position attribute.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setFiducialType(OntologyEntry p_fiducialType)
          Sets the fiducialType attribute.
 void setPosition(Position p_position)
          Sets the position attribute.
 
Methods inherited from interface gov.nih.nci.mageom.domain.Describable
getAuditTrail, getDescriptions, getSecurity, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Method Detail

setDistanceUnit

void setDistanceUnit(DistanceUnit p_distanceUnit)
Sets the distanceUnit attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Parameters:
p_distanceUnit - The new value for distanceUnit.
See Also:
getDistanceUnit()

getDistanceUnit

DistanceUnit getDistanceUnit()
Returns the value of this Fiducial object's distanceUnit attribute.

Returns:
gov.nih.nci.mageom.bean.Measurement.DistanceUnit The value of distanceUnit.
See Also:
DistanceUnit

setFiducialType

void setFiducialType(OntologyEntry p_fiducialType)
Sets the fiducialType attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Parameters:
p_fiducialType - The new value for fiducialType.
See Also:
getFiducialType()

getFiducialType

OntologyEntry getFiducialType()
Returns the value of this Fiducial object's fiducialType attribute.

Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of fiducialType.
See Also:
OntologyEntry

setPosition

void setPosition(Position p_position)
Sets the position attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Parameters:
p_position - The new value for position.
See Also:
getPosition()

getPosition

Position getPosition()
Returns the value of this Fiducial object's position attribute.

Returns:
gov.nih.nci.mageom.bean.DesignElement.Position The value of position.
See Also:
Position