DocsIf3CmSpectrumAnalysisCtrlCmd

Leafs

class DOCSIF3MIB.DocsIf3CmSpectrumAnalysisCtrlCmd

Bases: Entity

Class Hierarchy : DOCSIF3MIB DocsIf3CmSpectrumAnalysisCtrlCmd

This class represents state data.

docsif3cmspectrumanalysisctrlcmdenable

This attribute is used to enable or disable the spectrum analyzer feature. Setting this attribute to true triggers the CM to initiate measurements for the spectrum analyzer feature based on the other configuration attributes for the feature. By default, the feature is disabled unless explicitly enabled. Note that the feature may be disabled by the system under certain circumstances if the spectrum analyzer would affect critical services. In such a case, the attribute will return ‘false’ when read, and will reject sets to ‘true’ with an error. Once the feature is enabled, any Set operation on the docsIf3CmSpectrumAnalysisCtrlCmd MIB group might not be effective until the feature is re-enabled again

type: bool

config: False

docsif3cmspectrumanalysisctrlcmdinactivitytimeout

This attribute controls the length of time after the last spectrum analysis measurement before the feature is automatically disabled. If set to a value of 0, the feature will remain enabled until it is explicitly disabled

type: int

range: 0..86400

config: False

units: seconds

docsif3cmspectrumanalysisctrlcmdfirstsegmentcenterfrequency

This attribute controls the center frequency of the first segment for the spectrum analysis measurement. The frequency bins for this segment lie symmetrically to the left and right of this center frequency. If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin. If the number of bins in a segment is even, the segment center frequency lies halfway between two bins. Changing the value of this attribute may result in changes to the docsIf3CmSpectrumAnalysisMeasTable. Note that if this attribute is set to an invalid value, the device may return an error, or may adjust the value of the attribute to the closest valid value

type: int

range: 0..4294967295

config: False

units: Hz

docsif3cmspectrumanalysisctrlcmdlastsegmentcenterfrequency

This attribute controls the center frequency of the last segment of the spectrum analysis measurement. The frequency bins for this segment lie symmetrically to the left and right of this center frequency. If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin. If the number of bins in a segment is even, the segment center frequency lies halfway between two bins. The value of the LastSegmentCenterFrequency attribute should be equal to the FirstSegmentCenterFrequency plus and integer number of segment spans as determined by the SegmentFrequencySpan. Changing the value of this attribute may result in changes to the docsIf3CmSpectrumAnalysisMeasTable. Note that if this attribute is set to an invalid value, the device may return an error, or may adjust the value of the attribute to the closest valid value

type: int

range: 0..4294967295

config: False

units: Hz

docsif3cmspectrumanalysisctrlcmdsegmentfrequencyspan

This attribute controls the frequency span of each segment (instance) in the docsIf3CmSpectrumAnalysisMeasTable. If set to a value of 0, then a default span will be chosen based on the hardware capabilities of the device. Segments are contiguous from the FirstSegementCenterFrequency to the LastSegmentCenterFrequency and the center frequency for each successive segment is incremented by the SegmentFequencySpan. The number of segments is (LastSegmentCenterFrequency - FirstSegmentCenterFrequency)/SegmentFrequencySpan + 1. A segment is equivalent to an instance in the docsIf3CmSpectrumAnalysisMeasTable. The chosen SegmentFrequencySpan affects the number of entries in the docsIf3CmSpectrumAnalysisMeasTable. A more granular SegmentFrequencySpan may adversely affect the amount of time needed to query the table entries in addition to possibly increasing the acquisition time. Changing the value of this attribute may result in changes to the docsIf3CmSpectrumAnalysisMeasTable. Note that if this attribute is set to an invalid value, the device may return an error, or may adjust the value of the object to the closest valid value

type: int

range: 1000000..900000000

config: False

units: Hz

docsif3cmspectrumanalysisctrlcmdnumbinspersegment

This attribute controls the number of bins collected by the measurement performed for each segment (instance) in the docsIf3CmSpectrumAnalysisMeasTable. Note that if this attribute is set to an invalid value, the device may return an error, or may adjust the value of the attribute to the closest valid value

type: int

range: 2..2048

config: False

units: bins-per-segment

docsif3cmspectrumanalysisctrlcmdequivalentnoisebandwidth

This attribute allows the user to request an equivalent noise bandwidth for the resolution bandwidth filter used in the spectrum analysis. This corresponds to the spectral width of the window function used when performing a discrete Fourier transform for the analysis. The window function which corresponds to a value written to this object may be obtained by reading the value of the WindowFunction attribute. If an unsupported value is requested, the device may return an error, or choose the closest valid value to the one which is requested. If the closest value is chosen, then a subsequent read of this attribute will return the actual value which is in use

type: int

range: 50..500

config: False

units: hundredthsbin

docsif3cmspectrumanalysisctrlcmdwindowfunction

This attribute controls or indicates the windowing function which will be used when performing the discrete Fourier transform for the analysis. The WindowFunction and the Equivalent Noise Bandwidth are related. If a particular WindowFunction is selected, then the EquivalentNoiseBandwidth for the function which is in use, will be reported by the EquivalentNoiseBandwidth attribute. Alternatively if an EquivalentNoiseBandwidth value is chosen then if a WindowFunction function representing that EquivalentNoiseBandwidth is defined in the CM, that value will be reported in the WindowFunction MIB object, or a value of ‘other’ will be reported. Use of ‘modern’ windowing functions not yet defined will likely be reported as ‘other’. Note that all window functions may not be supported by all devices. If an attempt is made to set the object to an unsupported window function, or if writing of the WindowFunction is not supported, an error will be returned

type: SpectrumAnalysisWindowFunction

config: False

docsif3cmspectrumanalysisctrlcmdnumberofaverages

This attribute controls the number of averages that will be performed on spectral bins. The average will be computed using the ‘leaky integrator’ method, where: reported bin value = alpha*accumulated bin values + (1-alpha)*current bin value. Alpha is one minus the reciprocal of the number of averages. For example, if N=25, then alpha = 0.96. A value of 1 indicates no averaging. Re-writing the number of averages will restart the averaging process. If there are no accumulated values, the accumulators are made equal to the first measured bin amplitudes. If an attempt is made to set the attribute to an unsupported number of averages, an error will be returned

type: int

range: 1..1000

config: False