File List

Here is a list of all documented files with brief descriptions:

[detail level 1234]

▼ base
const.m	Global variable holding physical constants
module.m	Superclass: collection/sequence of unit
signal_interface.m	Signal interface class definition
sink.m	Stores the input signal
unit.m	Superclass: basic building block to hold functions
▼ doc
► pages
DocumentationGeneration.m	Documentation generation
Groups.m
QuickStart.m	Quick start guide
▼ library
► ch
EDFA_v1.m	Implementation of a liner EDFA model
LinChBulk_v1.m	Contains implementation of linear channel model
NonlinearChannel_v1.m	Nonlinear fiber optical channel model class definition
OSNR_v1.m	OSNR loading class definition file
SNR_v1.m	SNR loading class definition file
► demo
ClassTemplate_v1.m	A short description of the file containing a class or function
createDummySignal_v1.m	Create a dummy signal
functionTemplate_v1.m	A short description of the general idea behind the function
TestCh2x2_v1.m	Simple "channel" that passes two inputs to two outputs
TestSink_v1.m	Simple "receiver" that prints the input to the command window
TestSource_v1.m	Simple "transmitter" that generates a dummy output signal
► displays
DSO_v1.m	Digital storage oscilloscope
► electronics
ElectricalFilter_v1.m	Electrical filtering of a driver device
Negator_v1.m	Negates the input
Quantizer_v1.m	Quantizer is a unit that outputs a quantized version of input signal interface
► optics
BC_Nx1_v1.m	Implementation of a non-polarizing beam combiner
BS_1xN_v1.m	Implementation of a non-polarizing beam splitter
Gain_v1.m	Implements user defined arbitrary signal gain in power
Laser_v1.m	Laser model
OpticalHybrid_v1.m	Passive part of an optical hybrid
PBC_Nx1_v1.m	Implementation of a polarizing beam combiner
PBS_1xN_v1.m	Implementation of a polarizing beam splitter
PhaseNoiseModel_v1.m	Helper class for phase noise modeling
Polarizer_v1.m	Polarizer model
PolMux_v1.m	Polmux emulation - delay, rotate polarization, add
► rx
► DSP
AdaptiveEqualizer_MMA_RDE_v1.m	Radius directed equalization
BaseBandFilter_v1.m	This class implements a baseband filter
BERT_v1.m	Contains the implementation of a BER counter
CDCompensation_v1.m	FFT-based chromatic dispersion compensation
DCblock_v1.m	DC block
DDPLL_v1.m	Implementation of decision-directed PLL
Decimate_v1.m	Decimator
QuadratureImbalanceCompensation_v1.m	I-Q imbalance correction
Resample_v1.m	Resampling
BalancedPair_v1.m	Balanced pair model
CoherentFrontend_v1.m	Coherent front-end with polarization diversity
CoherentFrontend_v2.m	Coherent front-end with polarization diversity
PD_v1.m	Photodiode class definition file
► tx
ChannelCombiner_v1.m	Combines signals with different carrier frequency
DAC_v1.m	Digital to analog converter class implementation
DACPrecompensator_v1.m	Digital to analog conversion precompensator class implementation
DigitalPreFilter_v1.m	A prefilter for digital signals
ExtendedAWG_v1.m	Extended arbitrary waveform generator class implementation
ExtendedCoherentTransmitter_v1.m	Extended coherent transmitter class implementation
ExtendedWDMTransmitter_v1.m	Extended WDM transmitter class implementation
IntensityModulator_v1.m	Linear or Mach-Zehnder intensity modulator
IQModulator_v1.m	I-Q modulator model
Mapper_v1.m	Implementation of a mapper
OrthogonalCodeGenerator_v1.m	Contains the implementation of a binary/n-ary orthogonal code generator
PatternGenerator_v1.m	Pattern generator class implementation
PPG_v1.m	PPG Pulse pattern generator class implementation
PulseShaper_v1.m	Pulse shaper
PulseTrainGenerator_v1.m	Generates train of pulses with different shapes
SimpleAWG_v1.m	Simple arbitrary waveform generator class implementation
SimpleCoherentTransmitter_v1.m	Simple coherent transmitter class implementation
SimpleWDMTransmitter_v1.m	Simple WDM transmitter class implementation
SymbolGenerator_v1.m	Symbol generator class implementation
WaveformGenerator_v1.m
BranchSignal_v1.m	Branches the input signal
Combiner_v1.m	Contains the implementation of a signal combiner utility
Crop_v1.m	Contains the implementation of a signal cropping utility
Delay_v1.m	Applies a time delay to a signal
ResampleSkewJitter_v1.m	Resampler, rectangular anti-aliasing, and timing impairments insertion
Splitter_v1.m	Contains the implementation of a signal splitter utility
▼ utils
► constutils
bits2symb.m
combvec.m
constmap.m
constref.m	Constellation reference
constutils_example.m
cplx2mat.m
defaultargs.m
hd_euclid.m	Minimun euclidean distance symbol decisor
mat2cplx.m
meanpow.m
sd_kmeans.m
symb2bits.m
► errorCounter_v7
count_binary_runs.m
error_counter_miguel.m
error_counter_v7b.m
error_counter_v7c.m	General error counter
log2M.m
► figures
append_pdfs.m
colormapRGBmatrices.m
colors.m
constcmap.m
copyfig.m
eps2pdf.m
export_fig.m
exportfig.m
fix_lines.m
fixPSlinestyle.m
getEVM.m
ghostscript.m
gridxy.m
im2gif.m
isolate_axes.m
lims.m
magnifyOnFigure.m
myaa.m
niceconstplots3a.m
parseArgs.m
patchline.m
pdf2eps.m
pdftops.m
plotCool.m
plotLIV.m
print2array.m
print2eps.m
progressbar.m
saveFigure.m
scaledata.m
screen.m
subaxis.m
user_string.m
using_hg2.m
► plotting
genTimeAxisSig.m	Generate a time axis from signal_interface parameters
pabs.m	Fast plot pulse power envelope
pabsang.m	Fast plot power envelope and phase of signal
pabsh.m	Fast plot pulse power envelope
pconst.m	Fast plot constellation of signal
preim.m	Fast plot real and imaginary part of signal
► robotools
createRoboUnit.m	Robochameleon utility to create a new unit with a basic template
getAllFiles.m	Get a list of all files in the given folder and subfolders
increaseClassVersion.m	Robochameleon utility to increase class version safetly
robohelp.m	Open the robochameleon help main page or a class/function documentation in the browser
robolog.m	Robochameleon log utility
sumbitxor.m
arecells.m	Checks if all input variables are cell arrays
bandHz2bandNM.m	Converts band from Hz to nm
bandNM2bandHz.m	Converts band from nm to Hz
catstruct.m	Concatenate or merge structures with different fieldnames
clearall.m	Clear all variables but preserve breakpoints
close_biographs.m	Closes all open biographs
compileMex.m
dB2lin.m	Convert dB to linear units
EVM_Analysis.m	Performance analysis of square QAM based on the EVM of symbols
findrange.m	Finds min-max range of a vector/matrix
findUnit.m	Finds a unit within a module
formatPrefixSI.m	Formats a number for printing using SI prefixes
gen_prbs.m	Generate PRBS sequence
getClusters.m
getPColFromNumeric_v1.m	Construct array of pwr objects from a numeric signal
inherits_from.m	Determine whether an object inherits from a specified superclass
intersections.m	Intersections of curves. Computes the (x,y) locations where two curves intersect. The curves can be broken with NaNs or have vertical segments
isModule.m	Checks whether the class name is a module
iswhole.m	Determine whether or not input is a whole number
kmeans_v1.m	K-means clustering algorithm for complex-valued data
lin2dB.m	Convert linear units to dB
minIdx.m	Returning id instead of value of min()
paramDeepCopy.m	Copy parameters aligned to the properties of a module/unit
paramdefault.m	Set default parameter values
paramParser.m	This function translates structures of parameters into strings and strings into structrues
plotSignal.m	Plot signal using options based on signal properties
progress.m	Display progress on command line
pwr.m	Pwr class definition
robopath.m	Outputs the full path of whatever is passed
setParamFsRssNss.m	Utility function to compute the missing parameter among Fs, Rs, Nss in a param structure
spectra.m	Returns the single-sided amplitude spectrum and plots (optional)
varOrCell.m	Returns variable or specified element of cell array
▼ view
module_view.m	Superclass: graphical interface for units
unit_view.m	Superclass: graphical interface for units
robochameleon.m	Robochameleon initialization script