org.dcm4che2.iod.module.spatial
Class Fiducial

java.lang.Object
  org.dcm4che2.iod.module.Module
      org.dcm4che2.iod.module.spatial.GraphicCoordinatesData
          org.dcm4che2.iod.module.spatial.Fiducial

Direct Known Subclasses:

FiducialSet

public class Fiducial
extends GraphicCoordinatesData

This class represents a Fiducial.

Version:

$Revision: 720 $ $Date: 2006-11-26 18:40:54 +0100 (Sun, 26 Nov 2006) $

Author:

Antonio Magni , Gunter Zeilinger

Field Summary

Fields inherited from class org.dcm4che2.iod.module.Module

dcmobj

Constructor Summary

Fiducial()

Fiducial(DicomObject dcmobj)

Method Summary

float[]	getContourData() Specifies the coordinates of this item's fiducial.
double	getContourUncertaintyRadius() The estimated uncertainty radius.
java.lang.String	getFiducialDescription() User description or comments about the fiducial.
java.lang.String	getFiducialIdentifier() A fiducial assignment identifier.
Code	getFiducialIdentifierCode() Sequence A code sequence for a term that identifies a well-known fiducial type (potentially including methodology, anatomy, tools, etc.).
java.lang.String	getFiducialUID() Globally unique identifier for the fiducial instance of this fiducial assignment.
GraphicCoordinatesData[]	getGraphicCoordinatesData() The image pixel locations of the fiducial�s points.
int	getNumberOfContourPoints() Number of points (triplets) in Contour Data (3006,0050).
java.lang.String	getShapeType() Geometric interpretation of countour and graphic data.
void	setContourData(float[] ds) Specifies the coordinates of this item's fiducial.
void	setContourUncertaintyRadius(double fd) The estimated uncertainty radius.
void	setFiducialDescription(java.lang.String st) User description or comments about the fiducial.
void	setFiducialIdentifier(java.lang.String sh) A fiducial assignment identifier.
void	setFiducialIdentifierCode(Code code) Sequence A code sequence for a term that identifies a well-known fiducial type (potentially including methodology, anatomy, tools, etc.).
void	setFiducialUID(java.lang.String ui) Globally unique identifier for the fiducial instance of this fiducial assignment.
void	setGraphicCoordinatesData(GraphicCoordinatesData[] gcds) The image pixel locations of the fiducial�s points.
void	setNumberOfContourPoints(int is) Number of points (triplets) in Contour Data (3006,0050).
void	setShapeType(java.lang.String cs) Geometric interpretation of countour and graphic data.
static Fiducial[]	toFiducials(DicomElement sq)

Methods inherited from class org.dcm4che2.iod.module.spatial.GraphicCoordinatesData

getGraphicData, getReferencedImage, setGraphicData, setReferencedImage, toGraphicCoordinatesData

Methods inherited from class org.dcm4che2.iod.module.Module

getDicomObject, getType1Tags, getType2Tags, init, updateSequence, updateSequence, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Fiducial

public Fiducial(DicomObject dcmobj)

Fiducial

public Fiducial()

Method Detail

toFiducials

public static Fiducial[] toFiducials(DicomElement sq)

getFiducialIdentifier

public java.lang.String getFiducialIdentifier()

A fiducial assignment identifier. A fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.

Type 1

Returns:

setFiducialIdentifier

public void setFiducialIdentifier(java.lang.String sh)

A fiducial assignment identifier. A fiducial assignment identifier that is unique within this Fiducial Sequence item but may match the fiducial identifier of an equivalent feature in another item.

Type 1

Parameters:

s -

setFiducialIdentifierCode

public void setFiducialIdentifierCode(Code code)

Sequence A code sequence for a term that identifies a well-known fiducial type (potentially including methodology, anatomy, tools, etc.). Only one item shall be present. Required if Identifier (0070,0310) isabsent. May be present otherwise.

Type 1C

Parameters:

code -

getFiducialIdentifierCode

public Code getFiducialIdentifierCode()

Sequence A code sequence for a term that identifies a well-known fiducial type (potentially including methodology, anatomy, tools, etc.). Only one item shall be present. Required if Identifier (0070,0310) isabsent. May be present otherwise.

Type 1C

Returns:

getFiducialUID

public java.lang.String getFiducialUID()

Globally unique identifier for the fiducial instance of this fiducial assignment.

Type 3

Returns:

setFiducialUID

public void setFiducialUID(java.lang.String ui)

Globally unique identifier for the fiducial instance of this fiducial assignment.

Type 3

Parameters:

ui -

getFiducialDescription

public java.lang.String getFiducialDescription()

User description or comments about the fiducial.

Type 3

Returns:

setFiducialDescription

public void setFiducialDescription(java.lang.String st)

User description or comments about the fiducial.

Type 3

Parameters:

st -

getShapeType

public java.lang.String getShapeType()

Geometric interpretation of countour and graphic data. Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050) and Graphic Data (0070,0022). A point is defined as a triplet (x,y,z) in the case of spatial data or a pair (x,y) in the case of graphic data.

Type 1

Returns:

setShapeType

public void setShapeType(java.lang.String cs)

Geometric interpretation of countour and graphic data. Shape Type (0070,0306) defines the geometric interpretation of the Contour Data (3006,0050) and Graphic Data (0070,0022). A point is defined as a triplet (x,y,z) in the case of spatial data or a pair (x,y) in the case of graphic data.

Type 1

Parameters:

cs -

getNumberOfContourPoints

public int getNumberOfContourPoints()

Number of points (triplets) in Contour Data (3006,0050). Required if Contour Data is present.

Type 1C

Returns:

setNumberOfContourPoints

public void setNumberOfContourPoints(int is)

Number of points (triplets) in Contour Data (3006,0050). Required if Contour Data is present.

Type 1C

Parameters:

is -

getContourData

public float[] getContourData()

Specifies the coordinates of this item's fiducial. One triplet (x,y,z) shall be present for each point in the fiducial. See C.21.2.1.2 for further explanation. Required if Frame of Reference UID (0020,0052) is present in this item of the Fiducial Set Sequence (0070,031C). Shall not be present otherwise.

Note: Contour Data may not be properly encoded if Explicit-VR transfer syntax is used and the VL of this attribute exceeds 65534 bytes.

Type 1C

Returns:

setContourData

public void setContourData(float[] ds)

Specifies the coordinates of this item's fiducial. One triplet (x,y,z) shall be present for each point in the fiducial. See C.21.2.1.2 for further explanation. Required if Frame of Reference UID (0020,0052) is present in this item of the Fiducial Set Sequence (0070,031C). Shall not be present otherwise.

Note: Contour Data may not be properly encoded if Explicit-VR transfer syntax is used and the VL of this attribute exceeds 65534 bytes.

Type 1C

Parameters:

ds -

getContourUncertaintyRadius

public double getContourUncertaintyRadius()

The estimated uncertainty radius. The estimated uncertainty radius for the Contour Data in mm. See C.21.2.1.3

Type 3

Returns:

setContourUncertaintyRadius

public void setContourUncertaintyRadius(double fd)

The estimated uncertainty radius. The estimated uncertainty radius for the Contour Data in mm. See C.21.2.1.3

Type 3

Parameters:

fd -

getGraphicCoordinatesData

public GraphicCoordinatesData[] getGraphicCoordinatesData()

The image pixel locations of the fiducial�s points. Shall contain one or more items. More than one item shall be present only if a fiducial spans more than one image. Required if Contour Data is not present. May be present otherwise.

Type 1C

Returns:

setGraphicCoordinatesData

public void setGraphicCoordinatesData(GraphicCoordinatesData[] gcds)

The image pixel locations of the fiducial�s points. Shall contain one or more items. More than one item shall be present only if a fiducial spans more than one image. Required if Contour Data is not present. May be present otherwise.

Type 1C

Parameters:

gcds -