File: widarCommon.xsd (XML Schema)
Author: Sonja.Vrcic@nrc.gc.ca
Copyright: National Research Council of Canada and Associated Universities Inc., 2008 - 2013
Description: Elements and type defintions for the WIDAR Correlator Schemata.
2015.04.12 Updated by KRyan: changed minInclusive of SpectChannelsType from 64 to 32.
Version of the protocol: DRAO Document: VCI Protocol Specification, A25201N0000, Revision 3.15,
$Date: 2017-05-02 11:59:10 -0600 (Tue, 02 May 2017) $
$Revision: 7031 $
This is an attempt to define an XML element that could be used to
query or report status of any h/w or s/w component.
Element component can be generated both by the VCI client and by the correlator.
ID and type are enough to unquely identify any WIDAR component.
Optionally, a name can be assigned, but VCI clinet can not use the name
to identify component.
Attributes xmlTag and status are specified only by the correlator.
If an XML element is specified for the component,
the message generated by the correlator
Duration of dwell in seconds (for rollover and fast swtiching)
For rollover 0 means no rollover
For fast switching 0 means no fast switching.
Priority level for logs and alarms.
Also used to specify required logging level.
Log descriptor for logs and alarms. Log descriptor is used by the ALMA Common Software.
It is to be defined whether EVLA will use this.
"Instant" is used for events where concept of "termination" does not apply, i.e. when an alarm is raised the
device/subsystem does not enter an "alarm" state. Active and terminate are used for events where it is
meaninful to indicate beginning and end of an "alarm" state. Change is used to indicate a change for the
resource (device or subsystem) where an alarm is already active. For example, may be used to report
a change of temperature of the already overheated device.
Originator of the vciLog.
Depending on the type of event, name of the class, method and/or thread may be provided.
The component which is the source of the event or which is affected by the event.
For example, if a crash is being reported : the component that crashed.
Used to log Java exceptions (object trowable).
WIDAR host type. Host is a physical device. (As opposed to subsystem which refers to
a software entity. More than one s/w subsystem may be running on the same host computer.)
Set of parameters that unequely define a WIDAR host computer (physical device).
Obviously, IP address can be used to uniqely define a computer system, while type and instance are
more sutiable as information to be stored for future reference.
Decription used in log / alarm messages.
Used to report status of the parameters which are not defined in the WIDAR XML Schema.
Antenna Type. More types will be added.
Baseband polarization.
Number of bits per sample for
inital quantization (Station Board input)
Number of bits for Station Board re-quantizer.
Also correlation mode defined as the number of bits to correlate.
Source of the Station Board Input Data Stream.
Signal to noise ratio (percent of signal in the input data) for the Station Board Filter FPGA.
Alternatively could be specified as a set of five scaling factors (one for each stage plus quantizer scaling factor).
Station Board input band width.
TBD : specified in basic units (Herz) or in MHz and KHz (second set)
Station Board Filter output band width.
Number of spectral channels per product (for "narrow band" correlation on the Baseline Board).
Must be multiple of 64, i.e. 64*n, n=1,2,3,etc.
2015.05.26--kjr At Ken's request, made this to accept 32 to support the so-called
'half-lag' option whereby each transmitted lag frame has 32 lags/leads
instead of 64. This allows a bit more performance in the case when we want
very fast dumps and 4 Mhz channel widths are acceptable. It addresses
the case where the baseline board ethernet output rate is the bottleneck.
Recirculation factor.
Recirculation factor = 1 means NO recirculation.
Minimum Hadrware Integration Time in micro seconds.
Used by the Station Board to generate DUMPTRIG.
Integration Factor. Specifies how many times the same lag or measurement should be added before
off-loading the integrated value. On the Station Board integration is performed by software to reduce the
amount of output data and traffic generated by the Station Board. On the Baseline Board integration is
performed in hardware (polarization product lags, pulsar binning).
Pulsar gate width expressed in fractions of cycle.
Number of bits per sample for phased array
Station ID or "all"
Rack Identifier
Rack Identifier
Rack Identifier
Crate Identifier.
Slot Identifier.
Module Location Id as specified in the System Numbering Plan.
Defines the physical location of the module.
MLID in format Rack-Crate-Slot
Enumeration will be replaced by the regular expression.
Identifier of the "data path" on the Station Board.
A Station Board has two sets of 18 filters and associated devices,
so that two input streams (basebands) can be porcesses on a single Station Board.
Station Identifier.
The first within the set of the three identifiers that are inserted in the Station Board output data stream.
Baseband Identifier.
The second of the three identifiers that are inserted in the Station Board Output Data Stream.
Subband Identifier.
The third of the three identifiers that are inserted in the Station Board Output Data Stream.
Number of bands in the Station Board Input Data Stream.
Index of the band in the Station Board Input Data Stream.
X-Bar Board Switch ID.
There are 8 X-Bar boards in the Station rack.
Each X-Bar board has 2 cross-bar switches.
There are 16 cross bar switches per Station rack.
X-Bar board wafers consist of 3 streams:
streams A and B carry data (output of one filter from each of the two Station Board filter banks),
the 3rd stream is control stream.
Value "all" is provided for the case when all 3 streams from a X-Bar board input wafer are
switched to the same output wafer.
Correlator Chip Cell Quad Identifier
Correlator Chip Cell (CCC) Identifier.
Identifier assigned to a correlation product.
TBD: Do we allow VCI client to specify more than 4 products.
IP v4 address pattern.
IP v6 address pattern.
Number of the Baseline Board Pairs in the Quad
Station packing algorithm and product packing algorithm.
Station packing algorithm.
Values maxPack and minPack are supported for backwards compatibility.
maxPack = fourPerRowColumn
minPack = onePerRowColumn
Subset of auto-correlation products.
For packing algorithm
Used to identify Baseband in a pair
Used to identify Baseline Board Input
Used in Baseline Board Single to identify Baseline Board in a pair.
Baseband in a pair.
Control for the Station Board output data.
2012-02-29 Sonja.Vrcic@nrc.gc.ca: Tone extraction not implemented.
Noise Diode configuration.
Used in Baseline Board Single to identify Baseline Board in a pair.
Used in Baseline Board Single to identify Baseline Board in a pair.
Used to specify phase and bin width for phased binning.
Number of bins for phased binning.
There are two banks, each has 1000 bins.
If up to 1000 bins are used, the correlator alternates between two banks:
While transmitting the conent of one bank, integration is performed in the other, i.e. there is no data loss.
If more than 1000 bins are specified, integration can not be performed while data is being off-loaded (transmitted).
Gating has not been implemented in CM.
Schema for gating is likely to change.
Gating period in milliseconds (or frequency in Hz).
Gate width is specified as percent of the period (when the gate is on).
Epoch is specified as UT (or should it be the same as activation time).
Model for gating. Period in milliseconds.
Gate width is specified as percent of the period (when the gate is on).
Epoch is specified as UT (or should it be the same as activation time).
Coefficent for the gate models is the same as for delay models.
This format will be used during the testing.
When the full system is installed ASCII representation may be replaced by hexBinary.
Index of the band in the Station Board Input Data Stream.
Configuration parameters for the Station Board Filter (defines narrow band output of the filter).
Rack Identifier
Rack Identifier
Rack Identifier
Rack Identifier
Rack Identifier
Rack Identifier