cdac.medinfo.sdk.dcm30_04.baselibs

Class ImagePixelMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ImagePixelMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ImagePixelMacro
extends Macro

This macro specifies the common attributes that describe the pixel data of the image.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImagePixelMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
ImagePixelMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
ImagePixelMacro(IItem objItem) This constructor constructs a Macro with the specified Item
ImagePixelMacro(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	getBitsAllocated() Retrieves Number of bits allocated for each pixel sample.
short	getBitsStored() Retrieves Number of bits stored for each pixel sample.
ISingleCollection<byte[]>	getBluePaletteColorLookupTableData() This method returns the value of the field Blue Palette Color Lookup Table Data
short[]	getBluePaletteColorLookupTableDescriptor() Retrieves the Blue Pallette Color Lookup Table Descriptor.
short	getColumns() Retrieves Number of columns in the image.
ISingleCollection<byte[]>	getGreenPaletteColorLookupTableData() This method returns the value of the field Green Palette Color Lookup Table Data
short[]	getGreenPaletteColorLookupTableDescriptor() Retrieves value that specifies the format of the Green Palette Color Lookup Table Data (0028,1202) Required if Photometric Interpretation (0028,0004) has a value of PALETTE COLOR or Pixel Presentation (0008,9205) at the image level equals COLOR or MIXED.
short	getHighBit() Retrieves most significant bit for pixel sample data.
short	getLargestImagePixelValue() Retrieves the maximum actual pixel value encountered in this image.
java.lang.String	getPhotometricInterpretation() Retrieves value that specifies the intended interpretation of the pixel data.
java.lang.String[]	getPixelAspectRatio() Retrieves the pixel aspect ratio
ISingleCollection<byte[]>	getPixelData() Retrieves data stream of the pixel samples that comprise the Image.
short	getPixelRepresentation() Retrieves data representation of the pixel samples.
short	getPlanarConfiguration() Retrieves value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.
ISingleCollection<byte[]>	getRedPaletteColorLookupTableData() Retrieves the Red Palette Color Lookup Table Data in the Image Pixel Macro
short[]	getRedPaletteColorLookupTableDescriptor() Retrieves value that specifies the format of the Red Palette Color Lookup Table Data (0028,1201)
short	getRows() Retrieves number of rows in the image.
short	getSamplesPerPixel() Retrieves Number of samples (planes) in this image.
short	getSmallestImagePixelValue() Retrieves the minimum actual pixel value encountered in this image.
void	setBitsAllocated(short shBitsAllocated) Sets Number of bits allocated for each pixel sample.
void	setBitsStored(short shBitsStored) Sets Number of bits stored for each pixel sample.
void	setBluePaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection) This method sets the Blue Palette Color Lookup Table Data in the Image Pixel Macro
void	setBluePaletteColorLookupTableDescriptor(short[] shBluePaletteColorLookupTableDescriptor) Sets the Blue Pallette Color Lookup Table Descriptor.
void	setColumns(short shColumns) Sets Number of columns in the image.
void	setGreenPaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection) Sets value of Green Palette Color Lookup Table Data
void	setGreenPaletteColorLookupTableDescriptor(short[] shGreenPaletteColorLookupTableDescriptor) Sets value that specifies the format of the Green Palette Color Lookup Table Data (0028,1202) Required if Photometric Interpretation (0028,0004) has a value of PALETTE COLOR or Pixel Presentation (0008,9205) at the image level equals COLOR or MIXED.
void	setHighBit(short shHighBit) Sets Most significant bit for pixel sample data.
void	setLargestImagePixelValue(short shLargestImagePixelValue) Sets the maximum actual pixel value encountered in this image.
void	setPhotometricInterpretation(java.lang.String strPhotometricInterpretation) Sets value that specifies the intended interpretation of the pixel data.
void	setPixelAspectRatio(java.lang.String strPixelAspectRatio) Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size.
void	setPixelData(IDicomStream objIDicomStream, int[] iFrameSizeArr, EnumPixelDataVRType enumPixelDataVRType, boolean isUndefined) Sets a data stream of the pixel samples that comprise the Image.
void	setPixelData(ISingleCollection<byte[]> objCollectionOfPixelData, EnumPixelDataVRType enumPixelDataVRType, boolean isUndefined) Sets a data stream of the pixel samples that comprise the Image.
void	setPixelRepresentation(short shPixelRepresentation) Sets Data representation of the pixel samples.
void	setPlanarConfiguration(short shPlanarConfiguration) Sets value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.
void	setRedPaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection) This method sets the Red Palette Color Lookup Table Data in the Image Pixel Macro
void	setRedPaletteColorLookupTableDescriptor(short[] shRedPaletteColorLookupTableDescriptor) sets value that specifies the format of the Red Palette Color Lookup Table Data (0028,1201)
void	setRows(short shRows) Sets Number of rows in the image.
void	setSamplesPerPixel(short shSamplesPerPixel) Sets Number of samples (planes) in this image.
void	setSmallestImagePixelValue(short shSmallestImagePixelValue) Sets the minimum actual pixel value encountered in this image.
boolean	validate() Validates all the attributes in CodeSequenceMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in CodeSequenceMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in CodeSequenceMacro 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

ImagePixelMacro

public ImagePixelMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

ImagePixelMacro

public ImagePixelMacro(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

ImagePixelMacro

public ImagePixelMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ImagePixelMacro

public ImagePixelMacro(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

setSamplesPerPixel

public void setSamplesPerPixel(short shSamplesPerPixel)

Sets Number of samples (planes) in this image.

Parameters:

shSamplesPerPixel - short value of Samples per Pixel.

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves Number of samples (planes) in this image.

Returns:

shSamplesperPixel - short value of Samples per Pixel.

setPhotometricInterpretation

public void setPhotometricInterpretation(java.lang.String strPhotometricInterpretation)

Sets value that specifies the intended interpretation of the pixel data.

Parameters:

strPhotometricInterpretation - String valeu of Photometric Interpretation.

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves value that specifies the intended interpretation of the pixel data.

Returns:

strPhotometricInterpretation - String valeu of Photometric Interpretation.

setRows

public void setRows(short shRows)

Sets Number of rows in the image.

Parameters:

shRows - short value of rows.

getRows

public short getRows()

Retrieves number of rows in the image.

Returns:

short - short value of rows.

setColumns

public void setColumns(short shColumns)

Sets Number of columns in the image.

Parameters:

shColumns - short value of Columns.

getColumns

public short getColumns()

Retrieves Number of columns in the image.

Returns:

short - short value of Columns.

setBitsAllocated

public void setBitsAllocated(short shBitsAllocated)

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

Parameters:

shBitsAllocated - short specifies the number of bits allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.

Returns:

short - specifies the number of bits allocated

setBitsStored

public void setBitsStored(short shBitsStored)

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

Parameters:

shBitsStored - specifies the number of bits stored

getBitsStored

public short getBitsStored()

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

Returns:

short - specifies the number of bits stored

setHighBit

public void setHighBit(short shHighBit)

Sets Most significant bit for pixel sample data. Each sample shall have the same high bit.

Parameters:

shHighBit - specifies the high bit

getHighBit

public short getHighBit()

Retrieves most significant bit for pixel sample data. Each sample shall have the same high bit.

Returns:

short specifies the high bit

setPixelRepresentation

public void setPixelRepresentation(short shPixelRepresentation)

Sets Data representation of the pixel samples. Each sample shall have the same pixel representation. Enumerated Values: 0000H = unsigned integer. 0001H = 2's complement

Parameters:

shPixelRepresentation - specifies the pixel representation

getPixelRepresentation

public short getPixelRepresentation()

Retrieves data representation of the pixel samples. Each sample shall have the same pixel representation. Enumerated Values: 0000H = unsigned integer. 0001H = 2's complement

Returns:

short specifies the pixel representation

setPixelData

public void setPixelData(ISingleCollection<byte[]> objCollectionOfPixelData,
                EnumPixelDataVRType enumPixelDataVRType,
                boolean isUndefined)

Sets a data stream of the pixel samples that comprise the Image.

Parameters:

objCollectionOfPixelData - the obj collection of pixel data

enumPixelDataVRType - VR type pf the pixel data . It can be OW/OB.

isUndefined - true then the Data Element created is of undefined length. false then the Data Element created is of defined length.

setPixelData

public void setPixelData(IDicomStream objIDicomStream,
                int[] iFrameSizeArr,
                EnumPixelDataVRType enumPixelDataVRType,
                boolean isUndefined)
                  throws java.io.IOException

Sets a data stream of the pixel samples that comprise the Image.

Parameters:

objIDicomStream - the Dicom Stream Containing pixel data

iFrameSizeArr - int array containing size of each frame.

enumPixelDataVRType - VR type pf the pixel data . It can be OW/OB.

isUndefined - true then the Data Element created is of undefined length. false then the Data Element created is of defined length.

Throws:

java.io.IOException

getPixelData

public ISingleCollection<byte[]> getPixelData()

Retrieves data stream of the pixel samples that comprise the Image.

Returns:

ISingleCollection specifies the collection of pixel data

setPlanarConfiguration

public void setPlanarConfiguration(short shPlanarConfiguration)

Sets value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.

Parameters:

shPlanarConfiguration - short value specifies planar configuration of the image.

getPlanarConfiguration

public short getPlanarConfiguration()

Retrieves value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.

Returns:

short specifies planar configuration of the image.

setPixelAspectRatio

public void setPixelAspectRatio(java.lang.String strPixelAspectRatio)

Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size.

Parameters:

sPixelAspectRatio - specifies the pixel aspect ratio.

getPixelAspectRatio

public java.lang.String[] getPixelAspectRatio()

Retrieves the pixel aspect ratio

Returns:

short - returns the pixel aspect ratio

setSmallestImagePixelValue

public void setSmallestImagePixelValue(short shSmallestImagePixelValue)

Sets the minimum actual pixel value encountered in this image.

Parameters:

shSmallestImagePixelValue - short specifies the value of smallest image pixel

getSmallestImagePixelValue

public short getSmallestImagePixelValue()

Retrieves the minimum actual pixel value encountered in this image.

Returns:

short specifies the value of smallest image pixel

setLargestImagePixelValue

public void setLargestImagePixelValue(short shLargestImagePixelValue)

Sets the maximum actual pixel value encountered in this image.

Parameters:

shLargestImagePixelValue - specifies the value of largest image pixel.

getLargestImagePixelValue

public short getLargestImagePixelValue()

Retrieves the maximum actual pixel value encountered in this image.

Returns:

short specifies the value of largest image pixel.

setRedPaletteColorLookupTableDescriptor

public void setRedPaletteColorLookupTableDescriptor(short[] shRedPaletteColorLookupTableDescriptor)

sets value that specifies the format of the Red Palette Color Lookup Table Data (0028,1201)

Parameters:

shRedPaletteColorLookupTableDescriptor - specifies the pallette color lookup table descriptor

getRedPaletteColorLookupTableDescriptor

public short[] getRedPaletteColorLookupTableDescriptor()

Retrieves value that specifies the format of the Red Palette Color Lookup Table Data (0028,1201)

Returns:

short specifies the pallette color lookup table descriptor

setGreenPaletteColorLookupTableDescriptor

public void setGreenPaletteColorLookupTableDescriptor(short[] shGreenPaletteColorLookupTableDescriptor)

Sets value that specifies the format of the Green Palette Color Lookup Table Data (0028,1202) Required if Photometric Interpretation (0028,0004) has a value of PALETTE COLOR or Pixel Presentation (0008,9205) at the image level equals COLOR or MIXED.

Parameters:

shGreenPaletteColorLookupTableDescriptor - specifies the Green Pallette Color Lookup Table Descriptor

getGreenPaletteColorLookupTableDescriptor

public short[] getGreenPaletteColorLookupTableDescriptor()

Retrieves value that specifies the format of the Green Palette Color Lookup Table Data (0028,1202) Required if Photometric Interpretation (0028,0004) has a value of PALETTE COLOR or Pixel Presentation (0008,9205) at the image level equals COLOR or MIXED.

Returns:

short specifies the Green Pallette Color Lookup Table Descriptor

setBluePaletteColorLookupTableDescriptor

public void setBluePaletteColorLookupTableDescriptor(short[] shBluePaletteColorLookupTableDescriptor)

Sets the Blue Pallette Color Lookup Table Descriptor.

Parameters:

shBluePaletteColorLookupTableDescriptor - specifies blue pallette color lookup table descriptor

getBluePaletteColorLookupTableDescriptor

public short[] getBluePaletteColorLookupTableDescriptor()

Retrieves the Blue Pallette Color Lookup Table Descriptor.

Returns:

short specifies blue pallette color lookup table descriptor

setRedPaletteColorLookupTableData

public void setRedPaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection)

This method sets the Red Palette Color Lookup Table Data in the Image Pixel Macro

Parameters:

objSingleCollection - SingleCollection of bytefor Red Palette Color Lookup Table Data.

getRedPaletteColorLookupTableData

public ISingleCollection<byte[]> getRedPaletteColorLookupTableData()

Retrieves the Red Palette Color Lookup Table Data in the Image Pixel Macro

Returns:

SISingleCollection of byte for Red Palette Color Lookup Table Data.

setGreenPaletteColorLookupTableData

public void setGreenPaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection)

Sets value of Green Palette Color Lookup Table Data

Parameters:

objSingleCollection - ISingleCollection of bytes

getGreenPaletteColorLookupTableData

public ISingleCollection<byte[]> getGreenPaletteColorLookupTableData()

This method returns the value of the field Green Palette Color Lookup Table Data

Returns:

objSingleCollection ISingleCollection of bytes

setBluePaletteColorLookupTableData

public void setBluePaletteColorLookupTableData(ISingleCollection<byte[]> objSingleCollection)

This method sets the Blue Palette Color Lookup Table Data in the Image Pixel Macro

Parameters:

objSingleCollection - of bytes

getBluePaletteColorLookupTableData

public ISingleCollection<byte[]> getBluePaletteColorLookupTableData()

This method returns the value of the field Blue Palette Color Lookup Table Data

Returns:

ISingleCollection of byte

validate

public boolean validate()
                 throws ValidationException

Validates all the attributes in CodeSequenceMacro

Returns:

int - Success -true, Failure -false.

Throws:

ValidationException - throws ValidationException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

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

Parameters:

objIDataSet - collection of DataElements

Returns:

int - Success -true, Failure - false

Throws:

ValidationException - throws ValidationException If Mandatory or Conditional element fails.

InvalidMacroException - Signals Macro Validation is failed.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

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

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

int - Success -true, Failure - false

Throws:

ValidationException - throws ValidationException If Mandatory or Conditional element fails.

InvalidMacroException - Signals Macro Validation is failed.