cdac.medinfo.sdk.dcm30_04.baselibs

Class ContributingImageSourcesMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ContributingImageSourcesMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ContributingImageSourcesMacro
extends Macro

This class contains macro which contains IOD attributes that describe the image related characteristics of the contributing image sources used to create a new SOP Instance (e.g., a volume SOP Instance).

Author:

saloni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContributingImageSourcesMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
ContributingImageSourcesMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
ContributingImageSourcesMacro(IItem objItem) This constructor constructs a Macro with the specified Item
ContributingImageSourcesMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitsStored() Retrieves the number of bits stored
short	getColumns() Retrieves Number of Columns in the images.
java.lang.String	getLossyImageCompression() Return whether the Source Images have undergone lossy compression(at a point in their lifetime).
java.lang.String[]	getLossyImageCompressionMethod() Retrieves label for the lossy compression method(s) that have been applied tothe source images.
java.lang.String[]	getLossyImageCompressionRatio() Retrieves Lossy Image Compression Ratio
short	getRows() Retrieves Number of rows in the images.
void	setBitsStored(EnumBitsStored enumBitsStored) Sets Number of bits stored for each pixel sample.
void	setColumns(short shColumns) Sets Number of Columns in the images.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) Sets whether the Source Images have undergone lossy compression(at a point in their lifetime).
void	setLossyImageCompressionMethod(java.lang.String strLossyImageCompressionMethod) Sets label for the lossy compression method(s) that have been applied tothe source images.
void	setLossyImageCompressionRatio(java.lang.String[] strLossyImageCompressionRatio) Sets Lossy Image Compression Ratio
void	setRows(short shRows) Sets Number of rows in the images.
boolean	validate() Validates all the attributes in ContributingImageSourcesMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in ContributingImageSourcesMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in ContributingImageSourcesMacro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

ContributingImageSourcesMacro

public ContributingImageSourcesMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

ContributingImageSourcesMacro

public ContributingImageSourcesMacro(IDataSet objDataSet,
                             IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

ContributingImageSourcesMacro

public ContributingImageSourcesMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ContributingImageSourcesMacro

public ContributingImageSourcesMacro(IItem objItem,
                             IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in ContributingImageSourcesMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in ContributingImageSourcesMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in ContributingImageSourcesMacro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setRows

public void setRows(short shRows)

Sets Number of rows in the images.

Parameters:

shRows - short value of Number of rows in the images.

getRows

public short getRows()

Retrieves Number of rows in the images.

Returns:

short - short value of Number of rows in the images.

setColumns

public void setColumns(short shColumns)

Sets Number of Columns in the images.

Parameters:

shColumns - short value of Number of Columns in the images.

getColumns

public short getColumns()

Retrieves Number of Columns in the images.

Returns:

short - short value of Number of Columns in the images.

setBitsStored

public void setBitsStored(EnumBitsStored enumBitsStored)

Sets Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.

Parameters:

enumBitsStored - specifies the number of bits stored

getBitsStored

public short getBitsStored()

Retrieves the number of bits stored

Returns:

short - returns the number of bits stored

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

Sets whether the Source Images have undergone lossy compression(at a point in their lifetime).

Parameters:

enumLossyImageCompression - enum value of Lossy Image Compression

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Return whether the Source Images have undergone lossy compression(at a point in their lifetime).

Returns:

String - value of Lossy Image Compression

setLossyImageCompressionRatio

public void setLossyImageCompressionRatio(java.lang.String[] strLossyImageCompressionRatio)

Sets Lossy Image Compression Ratio

Parameters:

strLossyImageCompressionRatio - String value of Lossy Image Compression Ratio

getLossyImageCompressionRatio

public java.lang.String[] getLossyImageCompressionRatio()

Retrieves Lossy Image Compression Ratio

Returns:

String - value of Lossy Image Compression Ratio

setLossyImageCompressionMethod

public void setLossyImageCompressionMethod(java.lang.String strLossyImageCompressionMethod)

Sets label for the lossy compression method(s) that have been applied tothe source images.

Parameters:

strLossyImageCompressionMethod - String Value component of Lossy Image CompressionMethod

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

Retrieves label for the lossy compression method(s) that have been applied tothe source images.

Returns:

String Array - Value component of a Lossy Image CompressionMethod