cdac.medinfo.sdk.dcm30_04.baselibs

Class ChannelDefinitionSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ChannelDefinitionSequenceItem

All Implemented Interfaces:

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

public class ChannelDefinitionSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Channel Definition Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getChannelBaseline() Return attribute Offset of encoded sample value 0 from actual 0 using the units defined in the Channel Sensitivity Units
java.lang.String	getChannelDerivationDescription() Return description of waveform channel derivation
java.lang.String	getChannelLabel() Return attribute identifies Text label for channel which may be used for display purposes
ISingleCollection<byte[]>	getChannelMaximumValue() Return value of the Maximum valid sample value as limited by the acquisition equipment
ISingleCollection<byte[]>	getChannelMinimumValue() Return value of the attribute Minimum valid sample value as limited by the acquisition equipment
java.lang.String	getChannelOffset() Return attribute identifies Additional offset of first sample of channel to be used in aligning multiple channels for presentation or analysis, in seconds
java.lang.String	getChannelSampleSkew() Return attribute identifies Offset of first sample of channel from waveform multiplex group start time, in samples
java.lang.String	getChannelSensitivity() Return Channel Sensitivity.
java.lang.String	getChannelSensitivityCorrectionFactor() Return attribute identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity
ChannelSensitivityUnitsSequence	getChannelSensitivityUnitsSequence() Retrieves pre-initialized object of Channel Sensitivity Units Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ChannelSourceModifiersSequence	getChannelSourceModifiersSequence() Retrieves pre-initialized object of Channel Source Modifiers Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
ChannelSourceSequence	getChannelSourceSequence() Retrieves pre-initialized object of Channel Source Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String[]	getChannelStatus() Retrieves Channel Status
java.lang.String	getChannelTimeSkew() Return attribute identifies Offset of first sample of channel from waveform multiplex group start time, in seconds
java.lang.String	getFilterHighFrequency() Return attribute Nominal 3dB point of upper frequency of pass band; in Hz
java.lang.String	getFilterLowFrequency() Return attribute identifies Nominal 3dB point of lower frequency of pass band; in Hz
java.lang.String	getNotchFilterBandwidth() Return Nominal 3dB bandwidth of notch filter(s); in Hz
java.lang.String	getNotchFilterFrequency() Return Center frequency of notch filter(s); in Hz
SourceWaveformSequence	getSourceWaveformSequence() Retrieves pre-initialized object of Source Waveform Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
short	getWaveformBitsStored() Retrieves Number of significant bits within the waveform samples
java.lang.String	getWaveformChannelNumber() Returns Waveform Channel Number.
void	setChannelBaseline(java.lang.String StrChannelBaseline) Sets attribute Offset of encoded sample value 0 from actual 0 using the units defined in the Channel Sensitivity Units
void	setChannelDerivationDescription(java.lang.String StrChannelDerivationDescription) Sets attribute specifies description of waveform channel derivation
void	setChannelLabel(java.lang.String StrChannelLabel) Sets attribute identifies Text label for channel which may be used for display purposes
void	setChannelMaximumValue(ISingleCollection<byte[]> objChannelMaximumValue) Sets Maximum valid sample value as limited by the acquisition equipment
void	setChannelMinimumValue(ISingleCollection<byte[]> objChannelMinimumValue) Sets Minimum valid sample value as limited by the acquisition equipment
void	setChannelOffset(java.lang.String StrChannelOffset) Sets attribute identifies Additional offset of first sample of channel to be used in aligning multiple channels for presentation or analysis, in seconds
void	setChannelSampleSkew(java.lang.String StrChannelSampleSkew) Sets attribute identifies Offset of first sample of channel from waveform multiplex group start time, in samples
void	setChannelSensitivity(java.lang.String StrChannelSensitivity) Sets Channel Sensitivity .
void	setChannelSensitivityCorrectionFactor(java.lang.String StrChannelSensitivityCorrectionFactor) Sets attribute identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity
void	setChannelStatus(EnumChannelStatus[] enumChannelStatus) Sets One or more values for the status of this channel within this SOP Instance.
void	setChannelTimeSkew(java.lang.String StrChannelTimeSkew) Sets attribute identifies Offset of first sample of channel from waveform multiplex group start time, in seconds
void	setFilterHighFrequency(java.lang.String StrFilterHighFrequency) Sets attribute Nominal 3dB point of upper frequency of pass band; in Hz
void	setFilterLowFrequency(java.lang.String StrFilterLowFrequency) Sets attribute identifies Nominal 3dB point of lower frequency of pass band; in Hz
void	setNotchFilterBandwidth(java.lang.String StrNotchFilterBandwidth) Sets attribute identifies Nominal 3dB bandwidth of notch filter(s); in Hz
void	setNotchFilterFrequency(java.lang.String StrNotchFilterFrequency) Sets attribute identifies Center frequency of notch filter(s); in Hz
void	setWaveformBitsStored(short shWaveformBitsStored) Sets Number of significant bits within the waveform samples
void	setWaveformChannelNumber(java.lang.String StrWaveformChannelNumber) Sets Waveform Channel Number.
boolean	validateForModule() Validates all the attributes in FixationDeviceSequence 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 FixationDeviceSequence 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.

setWaveformChannelNumber

public void setWaveformChannelNumber(java.lang.String StrWaveformChannelNumber)

Sets Waveform Channel Number.

Parameters:

StrWaveformChannelNumber - String identifies channel number used for acquisition.

getWaveformChannelNumber

public java.lang.String getWaveformChannelNumber()

Returns Waveform Channel Number.

Returns:

String - identifies channel number used for acquisition.

setChannelLabel

public void setChannelLabel(java.lang.String StrChannelLabel)

Sets attribute identifies Text label for channel which may be used for display purposes

Parameters:

StrChannelLabel - S-tring identifies Text label for channel

getChannelLabel

public java.lang.String getChannelLabel()

Return attribute identifies Text label for channel which may be used for display purposes

Returns:

String - identifies the referenced SOP Class.

setChannelStatus

public void setChannelStatus(EnumChannelStatus[] enumChannelStatus)

Sets One or more values for the status of this channel within this SOP Instance. Defined terms: OK TEST DATA DISCONNECTED QUESTIONABLE INVALID UNCALIBRATED UNZEROED

Parameters:

enumChannelStatus- - Enum array of Channel Status

getChannelStatus

public java.lang.String[] getChannelStatus()

Retrieves Channel Status

Returns:

String Array of Channel Status

getChannelSourceSequence

public ChannelSourceSequence getChannelSourceSequence()

Retrieves pre-initialized object of Channel Source Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ChannelSourceSequence - instance of Channel Source Sequence

getChannelSourceModifiersSequence

public ChannelSourceModifiersSequence getChannelSourceModifiersSequence()

Retrieves pre-initialized object of Channel Source Modifiers Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ChannelSourceModifiersSequence - instance of Channel Source Modifiers Sequence

getSourceWaveformSequence

public SourceWaveformSequence getSourceWaveformSequence()

Retrieves pre-initialized object of Source Waveform Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

SourceWaveformSequence - instance of Source Waveform Sequence

setChannelDerivationDescription

public void setChannelDerivationDescription(java.lang.String StrChannelDerivationDescription)

Sets attribute specifies description of waveform channel derivation

Parameters:

StrChannelDerivationDescription - -String description of waveform channel derivation

getChannelDerivationDescription

public java.lang.String getChannelDerivationDescription()

Return description of waveform channel derivation

Returns:

String - attribute specifies description of waveform channel derivation

setChannelSensitivity

public void setChannelSensitivity(java.lang.String StrChannelSensitivity)

Sets Channel Sensitivity .

Parameters:

StrChannelSensitivity - -String value of Channel Sensitivity.

getChannelSensitivity

public java.lang.String getChannelSensitivity()

Return Channel Sensitivity.

Returns:

String - value of Channel Sensitivity.

getChannelSensitivityUnitsSequence

public ChannelSensitivityUnitsSequence getChannelSensitivityUnitsSequence()

Retrieves pre-initialized object of Channel Sensitivity Units Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ChannelSensitivityUnitsSequence - instance of Channel Sensitivity Units Sequence

setChannelSensitivityCorrectionFactor

public void setChannelSensitivityCorrectionFactor(java.lang.String StrChannelSensitivityCorrectionFactor)

Sets attribute identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity

Parameters:

StrChannelSensitivityCorrectionFactor - -String identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity

getChannelSensitivityCorrectionFactor

public java.lang.String getChannelSensitivityCorrectionFactor()

Return attribute identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity

Returns:

String - identifies Multiplier to be applied to encoded sample values to match units specified in Channel Sensitivity

setChannelBaseline

public void setChannelBaseline(java.lang.String StrChannelBaseline)

Sets attribute Offset of encoded sample value 0 from actual 0 using the units defined in the Channel Sensitivity Units

Parameters:

StrChannelBaseline - -String identifies Offset of encoded sample value

getChannelBaseline

public java.lang.String getChannelBaseline()

Return attribute Offset of encoded sample value 0 from actual 0 using the units defined in the Channel Sensitivity Units

Returns:

String - identifies Offset of encoded sample value

setChannelTimeSkew

public void setChannelTimeSkew(java.lang.String StrChannelTimeSkew)

Sets attribute identifies Offset of first sample of channel from waveform multiplex group start time, in seconds

Parameters:

StrChannelTimeSkew- - String identifies Offset of first sample of channel

getChannelTimeSkew

public java.lang.String getChannelTimeSkew()

Return attribute identifies Offset of first sample of channel from waveform multiplex group start time, in seconds

Returns:

String - identifies Offset of first sample of channel

setChannelSampleSkew

public void setChannelSampleSkew(java.lang.String StrChannelSampleSkew)

Sets attribute identifies Offset of first sample of channel from waveform multiplex group start time, in samples

Parameters:

StrChannelSampleSkew - -String identifies the Offset of first sample of channel

getChannelSampleSkew

public java.lang.String getChannelSampleSkew()

Return attribute identifies Offset of first sample of channel from waveform multiplex group start time, in samples

Returns:

String - identifies the Offset of first sample of channel

setChannelOffset

public void setChannelOffset(java.lang.String StrChannelOffset)

Sets attribute identifies Additional offset of first sample of channel to be used in aligning multiple channels for presentation or analysis, in seconds

Parameters:

StrChannelOffset - String identifies Additional offset of first sample of channel

getChannelOffset

public java.lang.String getChannelOffset()

Return attribute identifies Additional offset of first sample of channel to be used in aligning multiple channels for presentation or analysis, in seconds

Returns:

String - identifies Additional offset of first sample of channel

setWaveformBitsStored

public void setWaveformBitsStored(short shWaveformBitsStored)

Sets Number of significant bits within the waveform samples

Parameters:

shWaveformBitsStored - short value of Number of significant bits

getWaveformBitsStored

public short getWaveformBitsStored()

Retrieves Number of significant bits within the waveform samples

Returns:

short - short value of Number of significant bits

setFilterLowFrequency

public void setFilterLowFrequency(java.lang.String StrFilterLowFrequency)

Sets attribute identifies Nominal 3dB point of lower frequency of pass band; in Hz

Parameters:

StrFilterLowFrequency - String identifies Nominal 3dB point of lower frequency

getFilterLowFrequency

public java.lang.String getFilterLowFrequency()

Return attribute identifies Nominal 3dB point of lower frequency of pass band; in Hz

Returns:

String - identifies Nominal 3dB point of lower frequency

setFilterHighFrequency

public void setFilterHighFrequency(java.lang.String StrFilterHighFrequency)

Sets attribute Nominal 3dB point of upper frequency of pass band; in Hz

Parameters:

StrFilterHighFrequency - String identifies the attribute Nominal 3dB point of upper frequency

getFilterHighFrequency

public java.lang.String getFilterHighFrequency()

Return attribute Nominal 3dB point of upper frequency of pass band; in Hz

Returns:

String - identifies the attribute Nominal 3dB point of upper frequency

setNotchFilterFrequency

public void setNotchFilterFrequency(java.lang.String StrNotchFilterFrequency)

Sets attribute identifies Center frequency of notch filter(s); in Hz

Parameters:

StrNotchFilterFrequency - String identifies Center frequency of notch filter(s); in Hz

getNotchFilterFrequency

public java.lang.String getNotchFilterFrequency()

Return Center frequency of notch filter(s); in Hz

Returns:

String - identifies the Center frequency of notch filter(s); in Hz

setNotchFilterBandwidth

public void setNotchFilterBandwidth(java.lang.String StrNotchFilterBandwidth)

Sets attribute identifies Nominal 3dB bandwidth of notch filter(s); in Hz

Parameters:

StrNotchFilterBandwidth - String identifies Nominal 3dB bandwidth of notch filter(s); in Hz

getNotchFilterBandwidth

public java.lang.String getNotchFilterBandwidth()

Return Nominal 3dB bandwidth of notch filter(s); in Hz

Returns:

String identifies Nominal 3dB bandwidth of notch filter(s); in Hz

setChannelMinimumValue

public void setChannelMinimumValue(ISingleCollection<byte[]> objChannelMinimumValue)

Sets Minimum valid sample value as limited by the acquisition equipment

Parameters:

objChannelMinimumValue - ISingle Collection of bytes.

getChannelMinimumValue

public ISingleCollection<byte[]> getChannelMinimumValue()

Return value of the attribute Minimum valid sample value as limited by the acquisition equipment

Returns:

Collection of byte[] - returns the collection of inimum valid sample value as limited by the acquisition equipment

setChannelMaximumValue

public void setChannelMaximumValue(ISingleCollection<byte[]> objChannelMaximumValue)

Sets Maximum valid sample value as limited by the acquisition equipment

Parameters:

objChannelMaximumValue - ISingle Collection of bytes.

getChannelMaximumValue

public ISingleCollection<byte[]> getChannelMaximumValue()

Return value of the Maximum valid sample value as limited by the acquisition equipment

Returns:

Collection of byte[] - returns Maximum valid sample value.