cdac.medinfo.sdk.dcm30_04.baselibs

Class BasicGrayscaleImageSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BasicGrayscaleImageSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

Direct Known Subclasses:

BasicColorImageSequenceItem

public class BasicGrayscaleImageSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes in Basic Grayscale Image Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitsAllocated() Retrieves the number of bits allocated.
short	getBitsStored() Retrieves the number of bits stored.
short	getColumns() Retrieves the number of columns.
short	getHighBit() Retrieves the high bit.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
java.lang.String[]	getPixelAspectRatio() Retrieves the pixel aspect ratio.
ISingleCollection<byte[]>	getPixelData() Retrieves the collection of pixel data.
short	getPixelRepresentation() Retrieves the pixel representation .
short	getRows() Retrieves the number of rows.
short	getSamplesPerPixel() Retrieves the samples per pixel.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Number of bits allocated for each pixel sample.
void	setBitsStored(EnumBitsStored enumBitsStored) Sets Number of bits stored for each pixel sample.
void	setColumns(short sColumns) Sets number of columns in the image.
void	setHighBit(EnumHighBit enumHighBit) Most significant bit for pixel sample data.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets the intended interpretation of the pixel data.
void	setPixelAspectRatio(java.lang.String[] strArrPixelAspectRatio) 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(ISingleCollection<byte[]> objCollectionOfPixelData) A data stream of the pixel samples that comprise the Image.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Data representation of the pixel samples.
void	setRows(short sRows) Sets number of rows in the image.This describes the images's height.
void	setSamplesPerPixel(short sSamplesPerPixel) Samples per Pixel (0028,0002) is the number of separate planes in the image.
boolean	validateForModule() Validates all the attributes in CodeSequenceMacro that are present in the DataSet.

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

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

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setSamplesPerPixel

public void setSamplesPerPixel(short sSamplesPerPixel)

Samples per Pixel (0028,0002) is the number of separate planes in the image. One, three, and four image planes are defined. For monochrome (gray scale) and palette color images, the number of planes is 1. For RGB and other three vector color models, the value of this attribute is 3. For four vector color models, the value of this attribute is 4.

Parameters:

sSamplesPerPixel - -specifies the samples per pixel in the image.

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the samples per pixel.

Returns:

short - returns the samples per pixel.

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets the intended interpretation of the pixel data.

Parameters:

enumPhotometricInterpretation- - Enum value Photometric Interpretation.

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the photometric interpretation.

Returns:

String - returns the photometric interpretation.

setRows

public void setRows(short sRows)

Sets number of rows in the image.This describes the images's height.

Parameters:

sRows - -specifies the number of rows.

getRows

public short getRows()

Retrieves the number of rows.

Returns:

short - returns the number of rows.

setColumns

public void setColumns(short sColumns)

Sets number of columns in the image. This describes the images's width.

Parameters:

sColumns - -specifies the number of columns.

getColumns

public short getColumns()

Retrieves the number of columns.

Returns:

short - returns the number of columns.

setPixelAspectRatio

public void setPixelAspectRatio(java.lang.String[] strArrPixelAspectRatio)

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.

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

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

Parameters:

enumBitsAllocated - -specifies the number of bits allocated.

getBitsAllocated

public short getBitsAllocated()

Retrieves the number of bits allocated.

Returns:

short - returns the number of bits allocated.

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.

setHighBit

public void setHighBit(EnumHighBit enumHighBit)

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

Parameters:

enumHighBit - -specifies the high bit.

getHighBit

public short getHighBit()

Retrieves the high bit.

Returns:

short - returns the high bit.

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

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

Parameters:

enumPixelRepresentation - -specifies the pixel representation.

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the pixel representation .

Returns:

short - returns the pixel representation .

setPixelData

public void setPixelData(ISingleCollection<byte[]> objCollectionOfPixelData)

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

Parameters:

objCollectionOfPixelData - -specifies the collection of pixel data

getPixelData

public ISingleCollection<byte[]> getPixelData()

Retrieves the collection of pixel data.

Returns:

collection of byte[] - returns the collection pixel data.