org.dcm4che2.iod.module.composite
Class GeneralImageModule

java.lang.Object
  org.dcm4che2.iod.module.Module
      org.dcm4che2.iod.module.composite.ImagePixel
          org.dcm4che2.iod.module.composite.GeneralImageModule

Direct Known Subclasses:

CRImageModule, IntraOralImageModule, LutModule, MammographyImageModule

public class GeneralImageModule
extends ImagePixel

Class to represent the General Image Module (C.7.6.1)

This class is the parent class for all Image Modules, as it contains attributes that are image specific. It extends ImagePixel, so the child classes have all necessary attributes to correctly describe images.

Since:

Jun 9, 2006

Version:

$Revision: 6915 $ $Date: 2008-08-31 23:36:20 +0200 (Sun, 31 Aug 2008) $

Author:

gunter zeilinger(gunterze@gmail.com)

Field Summary

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

dcmobj

Constructor Summary

GeneralImageModule(DicomObject dcmobj)

Method Summary

java.util.Date	getAcquisitionDateAndTime()
java.util.Date	getAcquisitionDateTime()
java.lang.String	getAcquisitionNumber() A number identifying the single continuous gathering of data over a period of time that resulted in this image.
java.lang.String	getBurnedInAnnotation()
java.util.Date	getContentDateTime()
Code[]	getDerivationCodes()
java.lang.String	getDerivationDescription()
ImagePixel	getIconImage()
java.lang.String	getImageComments()
int	getImagesInAcquisition()
java.lang.String[]	getImageType()
java.lang.String	getInstanceNumber() A number that identifies this image.
java.lang.String	getIrradiationEventUID()
java.lang.String	getLossyImageCompression()
java.lang.String[]	getLossyImageCompressionMethod()
float[]	getLossyImageCompressionRatio()
java.lang.String[]	getPatientOrientation()
java.lang.String	getPixelDataProviderURL()
java.lang.String	getPresentationLUTShape()
java.lang.String	getQualityControlImage()
ImageSOPInstanceReferenceAndPurpose[]	getReferencedImages()
SOPInstanceReferenceAndPurpose[]	getReferencedInstances()
SourceImage[]	getSourceImages()
void	init()
void	setAcquisitionDateAndTime(java.util.Date d)
void	setAcquisitionDateTime(java.util.Date d)
void	setAcquisitionNumber(java.lang.String s) A number identifying the single continuous gathering of data over a period of time that resulted in this image.
void	setBurnedInAnnotation(java.lang.String s)
void	setContentDateTime(java.util.Date d)
void	setDerivationCodes(Code[] codes)
void	setDerivationDescription(java.lang.String s)
void	setIconImage(ImagePixel icon)
void	setImageComments(java.lang.String s)
void	setImagesInAcquisition(int i)
void	setImageType(java.lang.String[] s)
void	setInstanceNumber(java.lang.String s) A number that identifies this image.
void	setIrradiationEventUID(java.lang.String s)
void	setLossyImageCompression(float[] floats)
void	setLossyImageCompression(java.lang.String s)
void	setLossyImageCompressionMethod(java.lang.String[] ss)
void	setPatientOrientation(java.lang.String[] s)
void	setPixelDataProviderURL(java.lang.String s)
void	setPresentationLUTShape(java.lang.String s)
void	setQualityControlImage(java.lang.String s)
void	setReferencedImages(ImageSOPInstanceReferenceAndPurpose[] sops)
void	setReferencedInstances(SOPInstanceReferenceAndPurpose[] sops)
void	setSourceImages(SourceImage[] sops)
void	validate(ValidationContext ctx, ValidationResult result) Check validity of this Module.

Methods inherited from class org.dcm4che2.iod.module.composite.ImagePixel

getBitsAllocated, getBitsStored, getBluePaletteColorLookupTableData, getBluePaletteColorLookupTableDescriptor, getColumns, getGreenPaletteColorLookupTableData, getGreenPaletteColorLookupTableDescriptor, getHighBit, getICCProfile, getLargestImagePixelValue, getPhotometricInterpretation, getPixelAspectRatio, getPixelData, getPixelRepresentation, getPlanarConfiguration, getRedPaletteColorLookupTableData, getRedPaletteColorLookupTableDescriptor, getRows, getSamplesPerPixel, getSmallestImagePixelValue, maxPossibleStoredValue, minPossibleStoredValue, setBitsAllocated, setBitsStored, setBluePaletteColorLookupTableData, setBluePaletteColorLookupTableDescriptor, setColumns, setGreenPaletteColorLookupTableData, setGreenPaletteColorLookupTableDescriptor, setHighBit, setICCProfile, setLargestImagePixelValue, setPhotometricInterpretation, setPixelAspectRatio, setPixelData, setPixelRepresentation, setPlanarConfiguration, setRedPaletteColorLookupTableData, setRedPaletteColorLookupTableDescriptor, setRows, setSamplesPerPixel, setSmallestImagePixelValue

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

getDicomObject, getType1Tags, getType2Tags, updateSequence, updateSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralImageModule

public GeneralImageModule(DicomObject dcmobj)

Method Detail

init

public void init()

Overrides:

init in class Module

validate

public void validate(ValidationContext ctx,
                     ValidationResult result)

Description copied from class: Module

Check validity of this Module.

Checks all Type 1 tags to make sure they exist and are non-zero. Check all Type 2 tags to make sure they exist.

Overrides:

validate in class Module

getInstanceNumber

public java.lang.String getInstanceNumber()

A number that identifies this image.

Please not that this is an IS DICOM value, which is supposed to be encoded in JAVA as an int. Nevertheless, String has been chosen because:

• I have already seen objects, which uses non-numeric values for this identifiers.
• For identifiers, the non-numeric value may still of some use/information as opposed to e.g. a non-numeric Frame Number..

Type 2

Returns:

setInstanceNumber

public void setInstanceNumber(java.lang.String s)

A number that identifies this image.

Please not that this is an IS DICOM value, which is supposed to be encoded in JAVA as an int. Nevertheless, String has been chosen because:

• I have already seen objects, which uses non-numeric values for this identifiers.
• For identifiers, the non-numeric value may still of some use/information as opposed to e.g. a non-numeric Frame Number..

Type 2

Parameters:

s -

getPatientOrientation

public java.lang.String[] getPatientOrientation()

Returns:

See Also:

PatientOrientation

setPatientOrientation

public void setPatientOrientation(java.lang.String[] s)

Parameters:

s -

See Also:

PatientOrientation

getContentDateTime

public java.util.Date getContentDateTime()

setContentDateTime

public void setContentDateTime(java.util.Date d)

getImageType

public java.lang.String[] getImageType()

setImageType

public void setImageType(java.lang.String[] s)

getAcquisitionNumber

public java.lang.String getAcquisitionNumber()

A number identifying the single continuous gathering of data over a period of time that resulted in this image.

Please not that this is an IS DICOM value, which is supposed to be encoded in JAVA as an int. Nevertheless, String has been chosen because:

• I have already seen objects, which uses non-numeric values for this identifiers.
• For identifiers, the non-numeric value may still of some use/information as opposed to e.g. a non-numeric Frame Number..

Type 3

Returns:

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String s)

A number identifying the single continuous gathering of data over a period of time that resulted in this image.

Please not that this is an IS DICOM value, which is supposed to be encoded in JAVA as an int. Nevertheless, String has been chosen because:

• I have already seen objects, which uses non-numeric values for this identifiers.
• For identifiers, the non-numeric value may still of some use/information as opposed to e.g. a non-numeric Frame Number..

Type 3

Parameters:

s -

getAcquisitionDateAndTime

public java.util.Date getAcquisitionDateAndTime()

setAcquisitionDateAndTime

public void setAcquisitionDateAndTime(java.util.Date d)

getAcquisitionDateTime

public java.util.Date getAcquisitionDateTime()

setAcquisitionDateTime

public void setAcquisitionDateTime(java.util.Date d)

getReferencedImages

public ImageSOPInstanceReferenceAndPurpose[] getReferencedImages()

setReferencedImages

public void setReferencedImages(ImageSOPInstanceReferenceAndPurpose[] sops)

getDerivationDescription

public java.lang.String getDerivationDescription()

setDerivationDescription

public void setDerivationDescription(java.lang.String s)

getDerivationCodes

public Code[] getDerivationCodes()

setDerivationCodes

public void setDerivationCodes(Code[] codes)

getSourceImages

public SourceImage[] getSourceImages()

setSourceImages

public void setSourceImages(SourceImage[] sops)

getReferencedInstances

public SOPInstanceReferenceAndPurpose[] getReferencedInstances()

setReferencedInstances

public void setReferencedInstances(SOPInstanceReferenceAndPurpose[] sops)

getImagesInAcquisition

public int getImagesInAcquisition()

setImagesInAcquisition

public void setImagesInAcquisition(int i)

getImageComments

public java.lang.String getImageComments()

setImageComments

public void setImageComments(java.lang.String s)

getQualityControlImage

public java.lang.String getQualityControlImage()

setQualityControlImage

public void setQualityControlImage(java.lang.String s)

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

setBurnedInAnnotation

public void setBurnedInAnnotation(java.lang.String s)

getLossyImageCompression

public java.lang.String getLossyImageCompression()

setLossyImageCompression

public void setLossyImageCompression(java.lang.String s)

getLossyImageCompressionRatio

public float[] getLossyImageCompressionRatio()

setLossyImageCompression

public void setLossyImageCompression(float[] floats)

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

setLossyImageCompressionMethod

public void setLossyImageCompressionMethod(java.lang.String[] ss)

getIconImage

public ImagePixel getIconImage()

setIconImage

public void setIconImage(ImagePixel icon)

getPresentationLUTShape

public java.lang.String getPresentationLUTShape()

setPresentationLUTShape

public void setPresentationLUTShape(java.lang.String s)

getIrradiationEventUID

public java.lang.String getIrradiationEventUID()

setIrradiationEventUID

public void setIrradiationEventUID(java.lang.String s)

getPixelDataProviderURL

public java.lang.String getPixelDataProviderURL()

setPixelDataProviderURL

public void setPixelDataProviderURL(java.lang.String s)