BasebandSignal (UnetStack 3.4.0 API)

org.arl.unet.bb.BasebandSignal

Baseband signal for transmission/reception.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`channels`	Number of channels.
`protected float`	`fs`	Sampling frequency (Hz), -1 if unknown.
`protected int`	`preamble`	Preamble identifier.
`protected float[]`	`signal`	Signal time series.

Properties Summary

Properties
Type	Name and description
`int`	`carrierFrequency`
`int`	`channels`
`float`	`fc`
`float`	`fs`
`int`	`preamble`
`int`	`preambleID`
`int`	`samplingRate`
`float[]`	`signal`
`float[]`	`signal`

Constructor Summary

Constructors
Constructor and description
`BasebandSignal (Performative perf)`
`BasebandSignal (AgentID aid, Performative perf)`
`BasebandSignal (Message inReplyTo, Performative perf)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getCarrierFrequency()` Gets the carrier frequency for the passband signal represented by this baseband signal.
	`int`	`getChannels()` Gets the number of channels.
	`float`	`getFc()` Gets the carrier frequency for the passband signal represented by this baseband signal.
	`float`	`getFs()` Gets the sampling rate of the signal.
	`int`	`getPreamble()` Gets the preamble identifier.
	`int`	`getPreambleID()` Gets the preamble identifier.
	`int`	`getSamplingRate()` Gets the sampling rate of the signal.
	`float[]`	`getSignal()` Gets the signal contents as an array of floats.
	`float[]`	`getSignal(int ch)` Gets the signal for a given channel.
	`String`	`getSignalAsBase64()` Gets a base64 representation of the baseband signal.
	`int`	`getSignalLength()` Gets the signal length per channel in samples.
	`boolean`	`isComplex()` Checks if the signal is complex or real.
	`void`	`setCarrierFrequency(int fc)` Sets the carrier frequency for the passband signal represented by this baseband signal.
	`void`	`setChannels(int ch)` Sets the number of channels.
	`void`	`setFc(float fc)` Sets the carrier frequency for the passband signal represented by this baseband signal.
	`void`	`setFs(float fs)` Sets the sampling rate of the signal.
	`void`	`setPreamble(int n)` Sets the preamble identifier (default is 0).
	`void`	`setPreambleID(int n)` Sets the preamble identifier (default is 0).
	`void`	`setSamplingRate(int fs)` Sets the sampling rate of the signal.
	`void`	`setSignal(float[] signal)` Sets the signal contents from an array of floats.
	`void`	`setSignalFromBase64(String s)` Sets the signal from a base64 representation of the baseband signal.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected int channels
    
    Number of channels.
  - protected float fs
    
    Sampling frequency (Hz), -1 if unknown.
  - protected int preamble
    
    Preamble identifier.
  - protected float[] signal
    
    Signal time series. For complex signals, real and imaginary parts are in consecutive floats. Multi-channel signals are interleaved.
- Property Detail
  - int carrierFrequency
  - int channels
  - float fc
  - float fs
  - int preamble
  - int preambleID
  - int samplingRate
  - float[] signal
  - float[] signal
- Constructor Detail
  - public BasebandSignal(Performative perf)
  - public BasebandSignal(AgentID aid, Performative perf)
  - public BasebandSignal(Message inReplyTo, Performative perf)
- Method Detail
  - @Deprecated public int getCarrierFrequency()
    
    Gets the carrier frequency for the passband signal represented by this baseband signal. If the carrier frequency is 0, then the signal represented here is passband real.
    deprecated:
    Use getFc() instead.
    
    Returns:
    carrier frequency in Hz
  - public int getChannels()
    
    Gets the number of channels.
    Returns:
    ch number of channels
  - public float getFc()
    
    Gets the carrier frequency for the passband signal represented by this baseband signal. If the carrier frequency is 0, then the signal represented here is passband real.
    Returns:
    carrier frequency in Hz
  - public float getFs()
    
    Gets the sampling rate of the signal.
    Returns:
    sampling rate in Hz
  - public int getPreamble()
    
    Gets the preamble identifier. For a transmission request, this is the detection preamble to add to the signal before transmission. A preamble id of 0 causes no preamble to be added. For a reception request, this is the id of the preamble that was detected.
    Returns:
    preamble identifier
  - @Deprecated public int getPreambleID()
    
    Gets the preamble identifier. For a transmission request, this is the detection preamble to add to the signal before transmission. A preamble id of 0 causes no preamble to be added. For a reception request, this is the id of the preamble that was detected.
    deprecated:
    Use getPreamble() instead.
    
    Returns:
    preamble identifier
  - @Deprecated public int getSamplingRate()
    
    Gets the sampling rate of the signal.
    deprecated:
    Use getFs() instead.
    
    Returns:
    sampling rate in Hz
  - public float[] getSignal()
    
    Gets the signal contents as an array of floats. If the signal is complex, alternate entries as real and imaginary. If the signal has multiple channels, the channel data is interleaved.
    Returns:
    an array of floats
  - public float[] getSignal(int ch)
    
    Gets the signal for a given channel. If the signal is complex, alternate entries as real and imaginary.
    Parameters:
    ch - channel number (base 1)
    Returns:
    signal for the channel
  - public String getSignalAsBase64()
    
    Gets a base64 representation of the baseband signal.
    Returns:
    base64 string
  - public int getSignalLength()
    
    Gets the signal length per channel in samples.
    Returns:
    signal length in samples
  - public boolean isComplex()
    
    Checks if the signal is complex or real. Baseband signals are complex, while passband signals (carrierFrequency of 0) are real.
    Returns:
    true if complex, false if real
  - @Deprecated public void setCarrierFrequency(int fc)
    
    Sets the carrier frequency for the passband signal represented by this baseband signal. If the carrier frequency is 0, then the signal represented here is passband real.
    deprecated:
    Use setFc(float) instead.
    
    Parameters:
    fc - carrier frequency in Hz
  - public void setChannels(int ch)
    
    Sets the number of channels.
    Parameters:
    ch - number of channels
  - public void setFc(float fc)
    
    Sets the carrier frequency for the passband signal represented by this baseband signal. If the carrier frequency is 0, then the signal represented here is passband real.
    Parameters:
    fc - carrier frequency in Hz
  - public void setFs(float fs)
    
    Sets the sampling rate of the signal.
    Parameters:
    fs - sampling rate in Hz
  - public void setPreamble(int n)
    
    Sets the preamble identifier (default is 0). For a transmission request, this is the detection preamble to add to the signal before transmission. A preamble id of 0 causes no preamble to be added. For a reception request, this is the id of the preamble that was detected.
    Parameters:
    n - preamble identifier
  - @Deprecated public void setPreambleID(int n)
    
    Sets the preamble identifier (default is 0). For a transmission request, this is the detection preamble to add to the signal before transmission. A preamble id of 0 causes no preamble to be added. For a reception request, this is the id of the preamble that was detected.
    deprecated:
    Use setPreamble(int) instead.
    
    Parameters:
    n - preamble identifier
  - @Deprecated public void setSamplingRate(int fs)
    
    Sets the sampling rate of the signal.
    deprecated:
    Use setFs(float) instead.
    
    Parameters:
    fs - sampling rate in Hz
  - public void setSignal(float[] signal)
    
    Sets the signal contents from an array of floats. If the signal is complex, the array must have an even number of floats with alternate entries as real and imaginary. If the signal has multiple channels, the array length must be an integer multiple of the number of channels, and the channel data is interleaved.
    Parameters:
    signal - array of floats
  - public void setSignalFromBase64(String s)
    
    Sets the signal from a base64 representation of the baseband signal.
    Parameters:
    s - base64 string
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class BasebandSignal

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int channels

protected float fs

protected int preamble

protected float[] signal

Property Detail

int carrierFrequency

int channels

float fc

float fs

int preamble

int preambleID

int samplingRate

float[] signal

float[] signal

Constructor Detail

public BasebandSignal(Performative perf)

public BasebandSignal(AgentID aid, Performative perf)

public BasebandSignal(Message inReplyTo, Performative perf)

Method Detail

@Deprecated public int getCarrierFrequency()

public int getChannels()

public float getFc()

public float getFs()

public int getPreamble()

@Deprecated public int getPreambleID()

@Deprecated public int getSamplingRate()

public float[] getSignal()

public float[] getSignal(int ch)

public String getSignalAsBase64()

public int getSignalLength()

public boolean isComplex()

@Deprecated public void setCarrierFrequency(int fc)

public void setChannels(int ch)

public void setFc(float fc)

public void setFs(float fs)

public void setPreamble(int n)

@Deprecated public void setPreambleID(int n)

@Deprecated public void setSamplingRate(int fs)

public void setSignal(float[] signal)

public void setSignalFromBase64(String s)

@Override public String toString()