agi.foundation.communications.signalprocessing

(agi.foundation.communications-2025r1.jar)

Class ModulationOok

java.lang.Object

agi.foundation.communications.signalprocessing.DigitalModulation

agi.foundation.communications.signalprocessing.ModulationOok

public class ModulationOok
extends DigitalModulation

Digital modulation representing "Binary On-Off Keying" (OOK). Depending on the selected duty cycle, this model can represent OOK non-return-to-zero (OOK-NRZ) when duty cycle is equal to 1, or OOK return-to-zero when the duty cycle is less than 1 but greater than zero.

For the equations used in computing Eb/No and BER for the OOK modulation, see Section 4.3.3 page 172 of "Optical Wireless Communications - System and Channel Modeling with MATLAB" by Z. Ghassemlooy, W. Popoola, and S. Rajbhandari.

Constructor Summary

Constructors

Constructor and Description
ModulationOok() Initializes a new instance.
ModulationOok(double dutyCycle) Create a new instance based on the given duty cycle.

Method Summary

Modifier and Type	Method and Description
double	computeBitErrorRate(double bitEnergyPerNoiseDensity) A method to decode the digital signal and produce the probability that any given bit will be incorrect.
double	computeBitErrorRate(Signal intendedSignal) A method to decode the digital signal and produce the probability that any given bit will be incorrect.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
double	getDutyCycle() Gets the duty cycle which is the percentage of one period in which the signal is active.
double	getSpectralEfficiency() Gets the spectral efficiency representing the number of bits that can be represented per unit bandwidth, in bps/Hz.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModulationOok

public ModulationOok()

Initializes a new instance.

ModulationOok

public ModulationOok(double dutyCycle)

Create a new instance based on the given duty cycle.

Parameters:

dutyCycle - The percentage of one period in which the signal is active. Valid values are greater then zero and less than or equal to one. A value of one represents non-return-to-zero OOK while a duty cycle less than 1 represents a return-to-zero (RZ) type OOK modulation.

Method Detail

computeBitErrorRate

public double computeBitErrorRate(Signal intendedSignal)

A method to decode the digital signal and produce the probability that any given bit will be incorrect.

Overrides:

computeBitErrorRate in class DigitalModulation

Parameters:

intendedSignal - The signal object which represents the digital data.

Returns:

The bit error rate.

Throws:

ArgumentNullException - Thrown when intendedSignal is null.

computeBitErrorRate

public double computeBitErrorRate(double bitEnergyPerNoiseDensity)

A method to decode the digital signal and produce the probability that any given bit will be incorrect.

Specified by:

computeBitErrorRate in class DigitalModulation

Parameters:

bitEnergyPerNoiseDensity - The bit energy per noise density ratio (Eb/No).

Returns:

The bit error rate.

getSpectralEfficiency

public double getSpectralEfficiency()

Gets the spectral efficiency representing the number of bits that can be represented per unit bandwidth, in bps/Hz.

This specifies the bandwidth needed to represent a certain SignalDataRate successfully. The half-bandwidth (or base-band bandwidth) of the corresponding signal is the data rate divided by the spectral efficiency.

Specified by:

getSpectralEfficiency in class DigitalModulation

getDutyCycle

public final double getDutyCycle()

Gets the duty cycle which is the percentage of one period in which the signal is active. Valid values are greater then zero and less than or equal to one. A value of one represents non-return-to-zero OOK while a duty cycle less than 1 represents a return-to-zero (RZ) type OOK modulation.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)