THE reference for power system transients

EMTP® Overview

1 Introduction

This document presents an overview of available options in EMTP®-EMTPWorks. More details can be found in other documents and help tools.

Since the top view to all EMTP® simulations is the graphical user interface EMTPWorks, the main objective of this document is to show how required network data can be assembled and what is the expressive power of EMTPWorks for managing EMTP® simulations.

The picture of Figure 1 is showing a simple circuit assembled in EMTPWorks. The various parts, also called devices, are dragged in from the parts library (Parts palette shown on the right hand side by default) into the design, placed and connected using signals.

EMTPWorks allows working at different levels: from simple designs to extremely large designs and from simple drawings to customized drawings.

Figure 1 A simple (see simple.ecf in Examples\ApplicationCases\simple) circuit assembled in EMTPWorks The design shown in Figure 1 has a top level circuit. This is called a top circuit. A design can be organized on one or more pages: design pages. The design may also have one or more subcircuits. Subcircuits may also contain one or more subcircuits. The circuits are the children of the design. The top part of the circuit above is shown in Figure 2. All devices, signals and names can be clicked and right-clicked for entering data or controlling other aspects. The circuit itself also has a right-click menu. Right and bottom elevator bars can be used to move around a large circuit. The Zoom tool (View ribbon) can be used to zoom and unzoom. The useful zoom keyboard shortcuts are CTRL-SHIFT-E (enlarge) and CTRL-SHIFT-R (reduce). Panning is available by holding the CTRL key and clicking and holding anywhere in the circuit page. The users can also select this option directly from the Zoom tool found in the View ribbon. The size of the circuit page can be changed using the menus in “Options>Design”. The default size is the size taken from the connected printer. The devices are given an automatic visible name. This name can be changed by double-clicking on the name. The signals are given an automatic name. The user can change a signal name by right-clicking on the signal name or by selecting the Name tool (see Home ribbon Tools section) and clicking on the signal or signal name. Signal naming is generally less useful than device naming. It should be only used for creating some specific connections by name as discussed further in this document. Signal naming is not a good practice in a graphical user interface. EMTPWorks has internal automatic methods for maintaining internal signal names and connectivity. Meaningful naming is key to making designs decipherable and verifiable by self and by others. Meaning is added when renaming key devices to indicate more precisely their specific function in the diagram.

Figure 2 Simple first example

After creating the design circuit of Figure 2 the following steps must be followed to run a simulation:

1 Enter data into devices (double-click each device) according to the simulated circuit.

2 Select the menu “Simulate>Advanced>Simulation Options” and enter the simulation parameters.

3 Push the Run button in the Simulate ribbon to start the simulation.

The simulation progress panel (also called wait bar) is appearing at the bottom of the design in Figure 1.

When the simulation ends, simulation results saved as waveforms can be visualized using waveform visualization tools. The program also generates output webs, that can be accessed from the wait bar (see “Case web” and “Steady-State web” buttons in Figure 1.

The default waveform visualization and analysis tool is called ScopeView. It can be started by clicking on the command button “View Scopes with ScopeView” found in the Scopes group of the Simulate ribbon.

Another waveform visualization tool is available by clicking on the “View Scopes with MPLOT” button found in the same Scopes group. The MPLOT command is also available from the right-click menu (right-click on an empty space) of the circuit.

When the Run button is pushed, EMTPWorks creates a Netlist file and submits it to the EMTP® computational engine. The Netlist file contains only specific information needed by EMTP® to simulate the design. The entire design with all other data including geographical positions, is saved into a design file with the extension “.ecf”.

More details on input/output files can be found in the help section of the “Simulate>Advanced>View Output Files” panel.

The help section of the menu “Simulate>Advanced>Simulation Options” is a starting point for learning about EMTP® simulation methods. Each device is also given its own help section. The best approach for learning is to start by reading the current document and then by exploring available menus and options. Help hyperlinks and tabs are available everywhere.

In addition to a design file, EMTPWorks can be used to visualize ASCII files. It also has a JavaScript command console and a “Report Script” language.

2 Devices

Devices are dragged in from the Parts Library (on the right hand side of EMTPWorks main window, see Figure 1) and placed on the Design circuit at the desired location. The Parts Library can be turned on and off from the View ribbon (View>Panels>Parts Library). Each device has a default orientation in its library. The orientation can be changed after placement in the circuit. The initial orientation can be also changed from the Home ribbon menu Operations>Orientation.

Once a device is positioned in a circuit it can be moved around using the mouse key or the keyboard arrow keys. When a device moves it tries to maintain existing connectivity, but this is a complex task and the user may have to redo connectivity manually under some conditions.

A device may have no pins, one or more pins. A two-pin device is shown in Figure 3. The left-pin or the pin close to the “+” sign is also called a k-pin. The right-pin or the other pin, is also called an m-pin. The plus “+” sign is used to provide polarity for power devices.

Figure 3 A device with two pins

Pins can be clicked on to select. There is also a right-click menu.

The design may have network (circuit) devices: electrical devices or simulated devices recognized in EMTP®. The libraries in the “Parts by Library” palette allow to select the circuit devices. There are also various other types of devices. The options.clf library, for example, has devices for selecting EMTP® simulation options and the symbols.clf library has several devices for symbol editing.

A Symbol Editor function invoked through the device right-click menu “Edit Symbol”, can be used to edit (modify) a device’s symbol (drawing).

Some devices have color coding options. The voltage source in Figure 2 is shown with a red line to indicate that it is active in the steady-state solution of EMTP®.

2.1 Device data

2.1.1 Properties GUI

Devices have a right-click menu. In most cases there is also a double-click method. If the device of Figure 3 is double-clicked the Properties GUI of Figure 4 appears. This is called the device data web. The data web is organized using data tabs. Data tabs have data input fields. The data web is programmed using DHTML. The appearing web can be located on the user’s computer or anywhere on the internet.

Figure 4 The data tabs of the RLC device

Data entered in data fields is tested when the user unclicks a field. Data is also tested when moving between tabs and clicking on the OK button. The blue color is for existing data. When a data field is unclicked, the olive color indicates accepted data and the red color signals a corrected problem. An arbitrary correction is applied in most cases and the user must verify the faulty field.

The OK button registers all data changes.

Almost all data fields have default data. Data errors can revert to default data.

2.1.2 Tooltips and help

Tooltips and hyperlinks are provided everywhere in data tabs. To learn about a given device model parameter (such as R) the user can move the mouse pointer over the parameter’s name. This is shown in Figure 5. The tooltip panel stays up for an amount of time fixed by the operating system. The user can continue moving the mouse pointer to keep the tooltip up indefinitely. For some longer tooltips a right-click method is available to keep it up until the user clicks anywhere else into the window. More help is available through hyperlinks and/or in the Help tab.

Figure 5 The tooltip option

2.1.3 Named values: simple data field programming

The data fields have programming options. If the equality sign is the first character in a data field, it can be followed by a mathematical expression. The JavaScript syntax is used. An example is shown in Figure 6. The expression is evaluated when the data field is unclicked.

Another programming method is the usage of named values (programmed value or variable data). A named value is a string enclosed between two ‘#’ characters and entered in device data fields instead of entering numeric values. Example:

#Rfault#

This is a data programming method. In this version of EMTP®-EMTPWorks it is not allowed to use named values for devices appearing in the top circuit. More details on this approach can be found in the documentation of subnetwork masking methods (see section 5.2).

Usage of named values is part of the open architecture methods available in EMTPWorks. Entered data is being determined only after making data substitutions and no testing is available in data tabs. Usage of such options can result in major data errors if the user does not follow the data rules and limitations. Only limited testing is available on EMTP® side for the final device data.

Figure 6 Using the equality sign for simple expressions

2.1.4 Attribute probe

The Attribute Probe tool (also called sniffer) can be used to provide quick info on a device. To activate this option, it is needed to click on the Attribute Probe tool (Home>Tools) and then single-click on any device. The spacebar deactivates.

2.2 Device right-click menu

In addition to the double-click method, each device has a right-click menu (Figure 7) with submenus.

  1. Copy/Paste: This feature is used to copy and paste device data (simulation data) between devices of the same type.
  2. Device Data: This is the same as double-clicking on the device symbol.
  3. Extras/Summary: Various options related to the device. For most devices this menu calls a script for preparing and showing data summary on the device using its attributes. Some devices do not provide a script for this menu item.
  4. Steady-State view: selections for steady-state view options of the device.
  5. Exclude/Include: The Exclude action will exclude the selected device from the Netlist, it will not be seen by EMTP® and will not be part of the simulation. It becomes an open circuit. Excluded devices have a grey color code. The Include action will revert to Include back the device.
  6. Properties: Shows device info, this is the same as selecting the device and using CTRL-I.
  7. Copy name to clipboard: Copies the device name to the clipboard for a subsequent paste (Ctrl+V) command.
  8. Attributes: Provides access to device attributes.
  9. Name: Another method for entering the device name.
  10. Line Colour: Changes the line color of the device.
  11. Fill Colour: Changes the fill color of the device.

The remaining options are self-explanatory.

The “Edit Symbol” option starts the EMTPWorks symbol editor and allows modifying the device symbol.

The “Part” menu is not shown for all devices. It will be used in future versions of EMTPWorks for part switching from library.

For applying Exclude/Include actions to several devices selected by clicking while holding down the SHIFT button or using the mouse bounding box selection method: select the Design menu “Device Operations>Exclude” or “Device Operations>Include”.

Other global functions for both signals and devices are available through the Design menu.

Figure 7 The device right-click menus

2.3 Devices recognized in EMTP®

A design circuit can hold various device types. EMTP® can recognize option devices and simulated devices. There are also model data function devices.

The primitive devices are recognized in EMTP® using the Part device attribute. The primitive devices can be of power type or control type. A power type device is for modeling an actual physical electrical component. A primitive control type device is a block diagram device. It can be used to simulate actual control system behavior or for creating electrical network models using function blocks.

Power type devices are devices with power pins. Such as the device of Figure 3.

Control type devices are devices with control pins. Such a device is shown in Figure 8. The control type devices are interfaced with power type devices using sensors (meters) and actuators.

Figure 8 A primitive control type device A control component is built in EMTPWorks as a directed graph containing elements joined by oriented signals, together forming a block-diagram description of the component to be represented. An example is shown in Figure 9.

Figure 9 Sample control diagram

In a lot of designs it is preferable to present the control function in a procedural manner. This can be achieved using the virtual connection method described below. The design of Figure 10 is functionally identical to the one in Figure 9.

Figure 10 Virtual connection method for procedural assembly of a control diagram

2.4 Device pin types

There are currently 3 pin types (also called Pin Functions): Power-pin, Input-pin and Output-pin. The Power-pin is for power devices. A control device may have input pins and/or output pins.

Signals connected to control device pins are control signals and do not connect to power pins directly, meter (sensor) functions are needed. An example of sensor device is shown in Figure 11. It has a power pin that allows connecting to a power signal. It also has an output pin that allows connecting into a control device.

Figure 11 A device with power and output pins: v(t) probe from meters.clf

Some devices may have control and power pins. This is the case of the controlled thyristor found in the switches.clf library:

It has two power pins and one control pin which is for the firing signal.

Subcircuits may have mixed pin types.

Signals connected to output pins can only connect to input pins.

Pins that can be interconnected are called compatible pins.

Device pin settings are made during the device creation using the Symbol Editor.

2.5 Device attributes

Device attributes are used for controlling various device properties. They constitute the device’s memory and provide behavior rules. The device attributes are accessible through the right-click device menu. It is only for advanced usage and programming in the EMTPWorks environment. Erroneous usage can corrupt device data and create other problems, so extreme caution must be used when manipulating attribute data.

An example of simple usage is for altering the default name prefix. If it is desired to change the name prefix of the RLC device shown in Figure 3:

1 right click on the device

2 select Attributes

3 scroll down to locate the attribute Name.Prefix and select it by single-click

4 change to “Load”, for example

5 click on Done

Next time this device is copied (CTRL-C) or duplicated (CTRL-D) it will change its name prefix to “Load”.

The device attributes used for saving EMTP® data into the design and sending into the Netlist file are:

§ ParamsA

§ ParamsB

§ ParamsC

§ ModelData

All device data webs are based on scripting using JavaScript with extensions from EMTPWorks and DHTML. Scripts have access to device attributes for saving data.

Device data formats are documented in the Help section of each device. Advanced users can apply programming methods by directly entering device data through its attribute. This is only for advanced usage.

Other important device attributes are:

§ Description: used for saving and making visible device scope requests or initialization options

§ DrawingData: used for saving device drawing data

§ Exclude: used for excluding a device from the Netlist

§ FormData: used for maintaining device data not used in the Netlist of copies of various data fields

§ Function: when set to “OPTION” makes a device for saving and sending simulation options

§ Name: device’s name

§ Name.Prefix: device’s name prefix

§ Part: a unique device identification

§ Script.Info.Dev the script started from the “Extras/Summary” right-click menu item

§ Script.Open.Dev the script started when the device is double-clicked

§ Value: for showing device data in the circuit page

The user can also add attributes into a design for performing various data manipulations. Attributes are also part of the template system available in EMTPWorks. A template file can maintain specific attributes and features for creating design customization.

A device may have one or more visible attributes. These are for providing visual feedback for entered data. The RLC device, for example, shows the R, L and C values in the Value attribute. The Description attribute is used to show requested device scopes or indicate manual initialization options. These attributes are automatically filled by device data scripts.

In the example shown below the visible Value attribute shows comma separated R, L and C values respectively. In the Description attribute, “!iv” means that this device has initial conditions (IC) on both voltage and current. As for “?vip” it gives a visual indication that this device has voltage, current and power scopes turned on.

Figure 12 Device with visual attributes for presenting essential data and identifiers

2.6 Device libraries

EMTP®-EMTPWorks built-in devices are available from the built-in libraries. Users can create other devices and save in new libraries for later usage in other designs. EMTPWorks has several library options selectable from the “Options>Part Type” menu. Right-clicking on the library parts list provides library maintenance options.

3 Signals

3.1 Signal names

A signal name must be visible to keep its name. The current version of EMTPWorks has the freedom to change user given signal names during rerouting if the signal is not visible. EMTPWorks maintains a default signal naming system. The default signal naming features are modifiable through the menus in “Options>Naming Options”.

Signals connected to control (input or output) pins are control signals. Signals connected to power pins are power signals.

The currently reserved power pin signal name is GND. If a signal is named GND then it is automatically connected to ground (zero-volts). This is only true for power signals.

For control devices the currently reserved signal name is the number 0. If an input signal is given the name 0 then it will take the value 0 for the entire simulation.

If an input signal (connected to an input pin) is not connected to any output signal, EMTP® assumes that its value is always zero.

Generally speaking it is not useful and not recommended to name individual signals manually and to make them visible, unless one needs to create a special reference or apply connection by name (see description below). Most designs can be carried on without naming any signal. The power system bus name is on by default, since in this case the name is a useful reference in the power network diagram.

If it is absolutely needed to apply virtual connections (connections by name) then a better approach is to use page connectors. Page connectors can be used on the same page or on multiple pages (see section 4).

You must clearly understand the rules and consequences on maintaining signal names before heavy usage of such methods. The case of signal names in bundles is more complex and it should be avoided when possible.

3.2 Signal connectors

EMTPWorks also provides signal connector devices. A built-in signal connector device is the “Ground” device:

The “Ground” device has one pin and its signal name is GND:

The GND name is an enforced signal name. It is the pin name of the “Ground” device which is given the primitive Part type “Signal Connector” in the Symbol Editor. It is illegal to change the name of such a signal manually.

The user can create other signal connector devices using the Symbol Editor. This is useful for making connections by fixing a given signal name through the pin name. In this example the fixed signal name is SOURCE:

3.3 Connection methods

The standard method for interconnecting devices is to draw a signal (click near a pin, hold down the mouse pointer and move) line between device pins or to connect into an existing signal from another signal or pin. There are also signal drawing tools that allow starting anywhere on a circuit page and draw. Figure 13 shows the signal drawing tools from the EMTPWorks toolbar “Home>Tools”.

Figure 13 Signal drawing tools

It is also feasible to connect signals using signal names. This is shown in Figure 14. The signal SOURCE is used to connect the upper and lower circuit sections in the design without drawing an actual signal line. This is called a virtual connection or connection by name. The connected by name signal names must be made visible, or this option will not work. The name of a signal can be changed through the right-click signal menu item Name. It is required to check “Apply to all connected segments” to change all virtual connection names.

Signals connected by name are not automatically checked for pin compatibility!

The connection by name method is dangerous and when the user decides to disconnect two or more signals connected by name, then it is needed to make the signal name invisible (uncheck visible). In this case EMTPWorks will normally change the hidden name, but it is recommended to go back, open the name dialog and validate the new name.

Figure 14 Connecting by signal name

A better approach when connection by name is absolutely necessary, is to use Page Connectors (also called Inter-Page Connectors). Page connectors are available in the library “Pseudo Devices.clf”. It is possible to use them for multipage designs or on the same page. The page connector approach is shown in Figure 15. Connection is created by naming the page connector instead of the attached signal.

This approach is more robust and provides visual location feedback (automatic display of page references) on the locations of connected signals. In this case it indicates that 1-B3 (coordinates using design sheet border numbers) the connected signal is found on page 1 at the geographical location B3. The same applies to all pages connectors. The connection is created using the same name for the two page connectors. Two or more page connectors can be used. Page connectors can appear on the same page or on different pages when using multipage designs (see section 4).

 

Figure 15 Creating a virtual connection using Page Connectors

To turn on the visual location feedback it is needed to go to the menu “Options>Design Preferences” and select the “Page Refs” tab. In this tab the checkbox “Enable Automatic Page References” must be checked. This is shown in the figure below.

 

Figure 16 Design Preferences for setting up page references used in Page Connector devices

The library “Pseudo Devices.clf” contains other types of page connectors.

In addition to connecting by drawing a signal, a device can be connected to a signal by moving the device near the signal and touching the signal with its compatible pin. This is called connect-by-proximity. Under some circumstances when entire circuit sections or devices are moved near or over other circuit sections, the connect-by-proximity can become a nuisance, and can be turned-off by holding down the CTRL key after starting the move.

3.4 Showing and selecting connectivity

A single-click on a signal, highlights the signal and shows its connectivity. A double-click on a signal shows virtual connectivity. A single-click on a signal name highlights its parent signal.

Holding the CTRL button and double-clicking on a device selects the entire interconnected circuit, but not the virtually connected circuit. The selected circuit can be moved around using the mouse pointer (hold down any device and move) or use the keyboard arrow keys.

3.5 Signal paths

The signal path can be modified and only parts of a signal can be deleted using the Zap tool. The user can also experiment with:

12. hold SHIFT and draw

13. hold CTRL and draw

14. hold ALT and draw

15. hold CTRL-ALT and draw

Figure 17 Signal paths

The tip of a signal which is not physically connected is a T-shape.

The “View>Redraw” or End button can be used to refresh the design drawing.

3.6 Signal Line Type

The default signal is called a general signal. It is a 1-phase signal. It can be drawn by starting from an existing signal or device pin or by using the “Draw signal tool” shown as the first tool button in Figure 13.

A control signal can only be a general signal. A power signal can be a: 3-Phase Signal, 3-Phase Bus, Phase A signal, Phase B signal or Phase C signal.

The signal Line Type is selectable through the signal right-click menu item “Line Type”. If any of the signals shown in Figure 2 is right-clicked and set to become a “3-Phase Signal” then EMTPWorks propagates the phase setting to the entire circuit (see Figure 18).

Figure 18 The 3-phase version of the circuit shown in Figure 2

A 3-phase signal internally carries 3 names, one for each phase. For the signal SOURCE shown in Figure 18, the internal names are SOURCEa, SOURCEb and SOURCEc. The same is done for device names. A 3-phase device can be decoupled or internally coupled.

It is allowed to move back to the 1-phase version of a signal, again using the signal “Line Type” option.

The signal propagation may give an error message if at least one device in the circuit does not accept 3-phase signals. The user can go back by selecting Undo (CTRL+Z), the 1-phase devices will become otherwise disconnected in the Netlist and errors may occur.

Some device pins can only be 1-phase (general signal). This the case of a diode model, for example, which exists only as a 1-phase device.

Some device pins can only be 3-phase. This is the case of a 3-phase machine, for example.

The signal drawn from a pin takes its phase property. The user can also create separate signals using the signal drawing tools shown in Figure 13. The second option in this figure is the “Draw 3-phase Bus” tool. A 3-phase bus can only connect to 3-phase signals. It is also allowed connecting to individual phases, as shown in Figure 19.

Figure 19 3-phase bus with color code phase signals

Phase signals are drawn using the phase signal buttons shown in Figure 13. Phase signals are also created by converting a 3-phase signal line type to “Phase A” (or B or C) type.

The 3-phase bus acts as a signal concentrator, it has only one name, but appends the phase character to each phase signal, such BUS1a, BUS1b and BUS1c. If a phase name is changed then the parent bus name is also changed.

Naming a phase signal or bus GND will ground all phase signals. The ground signal GND is not replicated using phase characters.

It is not allowed to connect phase signals of a given 3-phase bus together directly. In Figure 19, for example, phase a will not connect to phase b. There are two options for achieving such connections. The first option is to use an ideal closed switch device. The second option is to use a node shorter (“Node connector”) device created using subcircuits. A similar approach can be used for connecting the 3-phase signal or any phase signals to ground. Several types of node connector devices are available in the library “Pseudo Devices.clf”.

If a phase signal is drawn separately in a design using the “Draw Phase” tool, then its name is internally concatenated with the phase character. In this example:

the actual signal name is BLUEb.

More details on 3-phase and 1-phase signals are given in Figure 20. This design is available in the example three_and_one_phase_diagrams.ecf under the EMTPWorks directory Examples\ShowHow.

3.7 The bundle

The bundle is a special signal that allows gathering and sending several signals through a single channel (or signal bus). It can also act as a multiplexer. The bundle is also used to interconnect device bundle pins. It is a visual concentration of signals.

The bundle uses bundle pins. Signals are connected to bundle pins. Bundle pins are added using the bundle right-click Breakout menu or the keyboard shortcut CTRL-B (Edit Breakout function).

Transmitting through a bundle can become complex and mixed signal types may remain undetected. This feature must be used with caution.

Bundles are drawn using the “Draw Bundle” tool (Draw Signal menu, Home ribbon) from Figure 13. An example is shown in Figure 21. It is important to remember that signals going through a bundle have the bundle name as a prefix. In Figure 21, D1 is actually BUND_D1.

The bundle pin name forces the name of the connecting signal. The signal inherits the bundle pin name when it connects to the pin. The bundle pin signal name is always prefixed by its bundle name.

The right-click command on the bundle of Figure 21 opens the “Edit Breakout” menu shown below. This menu is also accessible through the command “New Breakout” shown in Figure 13. New pins can be entered or selected from this menu. Any number of pins can be selected for establishing connections anywhere on the bundle path. In Figure 21 the breakout pins on the right are created and those on the right are selected.

Changing a bundle pin name manually (double-click on the name and change) will not change the name of the corresponding signal, but will add a new pin in the bundle. In this example changing the name of D1 on the left to NewD actually creates a new pin and abandons the previous connection to D1. The “New Breakout” menu now shows 3 pins (see figure below). This is the case when the bundle pin has been already used as in Figure 21.

Bundle pins can be of type Power-pin, Input-pin or Output-pin. All signal line types are accepted. A pin created using the “New Breakout” has no initial type and inherits its type from the signal connected at a later stage.

As for the case of 3-phase signals, it is not allowed to connect bundle signals together. It is however feasible to use ideal switches as jumpers or to use specific shorting devices (“Node connector” or “Control signal connector” devices are found in the library “Pseudo Devices”).

It is also possible to connect directly into bundles by drawing a signal into the bundle. This method shown in Figure 24. When a signal is directly connected to a bundle, a connection menu (Bundle Connection) appears and allows to specify the connection with signals in the bundle.

When two bundles are connected together, it is necessary to specify the connections between existing signals. This is also performed using Bundle Connection menu that appears automatically when a connection is maded.

Figure 20 EMTPWorks options for 3-phase and 1-phase diagrams

Figure 21 Bundle usage example

Figure 22 “New Breakout” menu

Figure 23 “New Breakout” menu after changing the name of a pin

Figure 24 Connecting directing into a bundle without breakout usage

4 Multipage designs

An EMTPWorks design can have one or more pages.

Steps for adding pages and using page connectors:

1 right-click in the circuit and select the “Pages” menu.

2 give a name to the current page

3 click on “New Page”

4 give a name to the new page

When circuits appearing on one or more pages are interconnected, it is needed to use the same signal names (virtual connections). Before placing page connectors, it is useful to select “Options>Design Preferences” and then “Page Refs”. In the “Page Refs” panel all the checkboxes must be on (see Figure 16).

Page connectors are available in the “Pseudo Devices.clf” library. It is needed to select a “Page Conn Power Signal” for adding page connectors to power signals. If the signal SOURCE is used to connect pages then the circuit pages will give the page connectors shown in Figure 25. The first character is the page number and the following two characters give the geographical position in the page. A right-click selection of “Properties” of a page connector shows all related page connections and allows to jump between page connectors.

a) Page 1

b) Page 2

Figure 25 Page connector usage

5 Subnetworks (Subcircuits)

Subcircuits are an important design feature. They are used to simplify drawings, to provide encapsulation and to create modules. Another important feature available through subcircuits is masking and user-defined modeling.

EMTPWorks offers several methods for creating subcircuits. Subcircuits can be created from any location in a circuit. It is also possible to make a subcircuit from the entire circuit.

The subcircuit of Figure 26 is created from the switch of Figure 2. The “Options>Subcircuit>Create Subcircuit Block” (CTRL+SHIFT+Q) menu is used to create a subcircuit from parts of a circuit. If port connectors are not placed before using CTRL+SHIFT+Q, then EMTPWorks suggests automatic port positions, such as “Add port connectors to all signals with visible names” or “Add port connectors to all signals with loose ends”.

A subcircuit may have zero, one or more pins. Any pin types can be used.

The top circuit can contain several subcircuits and each subcircuit can also contain subcircuits with unlimited number of levels.

The default subcircuit symbol is a square box. The Symbol Editor can be used to modify the subcircuit symbol.

After creating the subcircuit it can be opened in a separate circuit drawing by double-clicking on its symbol. The available keyboard shortcuts are: “CTRL+SHIFT+I” (in) for getting into the subcircuit and “CTRL+SHIFT+U” (up) for going up.

The first time a subcircuit is entered it is locked. It is needed to unlock the subcircuit for making changes. There are two methods for unlocking: through the “Circuit Info” menu (CTRL+I) or by moving a device in the subcircuit and accepting to unlock from the subsequent panel popup.

Figure 26 Subcircuit FAULT_switch created from the circuit of Figure 2

The contents of FAULT_switch are shown in Figure 27. The square with an X is a device used for pin interface location with the parent circuit.

Figure 27 Subcircuit FAULT_switch

5.1 Subcircuit uniqueness

A fundamental feature that must be clearly understood before using subnetworks (subcricuits) is explained below.

When a subcircuit is created and duplicated, EMTPWorks continues keeping only one copy of its internal circuit. Which means that any changes inside one subcircuit are automatically reflected into the other subcircuit instance. EMTP® also sees only one copy of the circuit, but two separate calls. This is similar to programming using a given function from different locations in the program. The two subcircuits of Figure 28 are identical. They have the same Part attribute and same Type name. This is a powerful feature for large designs. If a large number of subcircuit devices of the same type are used in a design, then by changing only one device allows changing all other devices automatically.

Figure 28 Identical subcircuits

The Type name of a device can be found by selecting the device and using the right-click Properties command.

If it desired to detach one subcircuit definition from the other, then the detached subcircuit must be made unique. This is completed through the “Options>Part Type>Make Unique Type” menu. In Figure 29, the subcircuit DEV2 is first created by duplicating DEV1 and then made unique. To ensure circuit data integrity and to manage subcircuits, it is very important to enable visual feedback for distinguishing dissimilar subcircuits. A suggested approach is to show the Part name assuming that the user is maintaining appropriate Part names. An even better approach is to change the subcircuit symbol using the Symbol Editor.

 

It is very important to understand the implications of the “Make Unique Type” command and the notion of subcircuit uniqueness before making any changes to subcircuits. The user should never modify a built-in EMTPWorks subcircuit based device before applying the “Make Unique Type” command to the device. A built-in device may be used by other devices and thus modify their contents if not made unique before changing. More details can be found by looking into the “Make Unique Type” index in “File>Help&Support>Help Documentation>Using EMTP -Tutorials and Reference”

 

EMTPWorks also keeps a separate attribute PartTemp for verifying uniqueness when the user makes mistakes by using existing part names or makes attribute changes without making a unique type.

Figure 29 Making a subcircuit unique

At this stage DEV2 is detached from DEV1 and FAULT_switch: it has its own copy of the original subcircuit. This is similar to making a copy of a function and renaming it to allow new contents, calling methods and usage.

If a subcircuit is available in a library and if it is dragged into the design and modified, then it becomes automatically unique: detached from the library copy. The user should change the symbol and make the new Part name visible to avoid confusion. Any new copy dragged in from the original library remains detached from the one modified in the design.

Locking the contents of a subcircuit after its creation is used for reminding the user about the potential repercussions of changes made in the subcircuit.

The contents of a subcircuit are only visible from the subcircuit. This means that two devices with the same name but in two different subcircuits do not actually have the same internal name. The same is true for internal signals, but not for interfacing signals. An interfacing signal is a signal connected to a subcircuit pin. Such a signal will keep its name when propagating downwards from parent circuit or subcircuit into lower level subcircuits.

It is allowed to add and delete subnetwork pins after subnetwork creation. When a signal line type is changed in a subnetwork after its creation, it will not propagate to its parent circuit. Such changes must be performed manually. Changing signal line types in the parent circuit must be also achieved by changing the subnetwork pin types manually.

In the current version of EMTPWorks, subcircuit control input and output pins are not automatically given an arrow tip. This is only achievable by modifying the subcircuit symbol using the Symbol Editor.

If after exiting a subcircuit, the user receives an error message, it means that there is pin interface corruption in the subcircuit and the resulting Netlist will also have problems. Error and warning messages should not be ignored before continuing.

5.2 Subcircuit masking

After creating the subcircuit the right-click device menu item “Subcricuit Info” becomes enabled. The “Subcircuit Properties” has a mask tab with a default mask.

Masking is a powerful feature for data hiding and encapsulation. It provides a high-level access to subcircuit contents and allows creating user defined models.

Help on masking methods is available after selecting this option and looking into the Help tab of the default mask.

5.3 Subcircuit contents

Subcircuits can contain subcircuits which can also contain subcircuits. This is called hierarchical design.

Subcircuits can have any number of pins. The pin names are used for connecting signals to subcircuit contents. It is also allowed to create subcircuits without pins. Subcircuits can contain devices explicitly recognized by EMTP®, generic symbols or drawing annotations.

When a signal is entering a subcircuit pin, its name is automatically propagated downwards into subcircuit contents. The subcircuit contents are only visible at its circuit level. The subcircuit has its own data scope. Each subcircuit has its own pathname. The device named SW1 in the Fault_switch subcircuit of Figure 26 is referred to as Fault_switch/SW1. If Fault_switch contained another subcircuit, named Inside, for example, then it would be also referred to as Fault_switch/Inside.

As long as the pin interface with subcircuit contents is correctly setup, there are no limitations in the internal subcircuit connectivity rules. In the example of Figure 30, a dummy device is created for shorting signals (nodes) together. Such a device can be used, for example, when it is not allowed to connect given signals together directly. It is used in Figure 31 (black square) for shorting BUS12a and BUS12b phases. Such a connection is not allowed otherwise.

Figure 30 Subcircuit for shorting signals: Node connecter

Figure 31 Shorting phase signals using a “Node connecter”

5.4 Subcircuits within subcircuits

As understood in the previous section, a subcircuit may contain other subcircuits and the contained subcircuits may contain subcircuits, which results into a tree of subcircuits.

The best way to understand multilevel designs and Unique property of a subcircuit, is to view a subcircuit as a program function. A function is a program building block. A given function has only one version and can be called from other functions. If it is desired to change a function, then its name must be changed (made unique) in order to change its contents. A subcircuit level can be viewed as the body of the function.

The best way to illustrate this concept is to create a simple example.

Two subcircuits FUN1 and FUN2 are contained in a subcircuit TOPSUB.

Initially there is only one copy of TOPSUB in the memory. There is also only one copy of FUN1 and one copy of FUN2. Making any changes in the TOPSUB level is automatically reflected into all copies of TOPSUB. The same is true for FUN1 and FUN2.

If we make a copy of TOPSUB to create DEV4 it is like calling the same function tree from another location in the main program (the top circuit).

Making any changes in the DEV4 level is automatically reflected into DEV3 level. If it is desired to modify FUN2 in DEV3 without modifying FUN2 in DEV4, DEV3 must be first converted to become unique using the Make Unique Type procedure. Its level will then become separated in memory from DEV4. Then DEV2 can be also set to a new type using again Make Unique Type. This last action will detach DEV2 and allow modifying its level contents. Here is a visual representation of the steps. First DEV3 and DEV4 are sharing the same body:

Then DEV3 becomes unique, holds its own body, but continues sharing DEV1 and DEV2:

The next step detaches DEV2 by making it unique.

This means that if you want to modify a multilevel subcircuit to make it completely detached from others in all its levels and used subcircuits, you must modify all hierarchical levels.

It is also feasible to propagate uniqueness from top down for a subcircuit device containing other subcircuits by checking the option “Apply to subcircuit contents” on the Make Unique Type command panel.

One exception to the explanation above is when a subcircuit contained within a subcircuit is also available at the top level design (not in a subcircuit). In this case it is possible to create two separate definitions by making one of the subcircuits unique.

6 Search options

Search options are available from “Home>Find” or CTRL-F shortcut as shown in Figure 32.

The “Quick Find” method can be used by searching for devices and signals. The object name must entered into the indicated field. This function will also look at any name string and search for entered characters.

Figure 32 Search options

The Advanced Find method opens a tab on the right hand side and allows to select options. There are currently 4 options.

“EMTP Error Check” is the first option. It can be used to detect potential problems and verify error messages. Some warning messages can be inconsequential. The most common sources of errors are devices with incomplete data. Other important messages are related to mixed signal types.

“Find Devices by Name” allows searching for devices in the entire design (all circuit levels).

“Find Devices by Name (cc)” allows searching for devices in the current circuit level.

“Find Signals by Name” is for searching for signals in the current circuit level.

7 Copying and pasting

Entire circuits or circuit parts can be copied within the same design or into other designs. Due to the signal naming methods explained before, the user must be careful not to create virtual connections or duplicate device names at the same circuit level.

Pasting options are selectable from the “Home>Clipboard>Paste Special” menu.

To copy circuits into other applications is achieved by simply selecting the desired circuit section and pasting. Best quality is achieved by copying at the highest zoom level in EMTPWorks drawing pages.

If a circuit contains text annotations, then it is required to select a paste-special option in the target application and specify “Picture (Enhanced Metafile)”.

It is also allowed to copy into a circuit page from other applications. A useful application is the copying of mathematical equations or other text annotations from separate tools.

8 Scripting

EMTPWorks is an object-oriented application with scripting. Scripting allows customizing the application in all its aspects. Scripting is used for the data management of all devices. It is also used for manipulating design data. There are two scripting languages used in EMTPWorks: a proprietary “Report Script” (“Export Script Language”) language and JavaScript with EMTPWorks extensions. A collection of methods (extensions) allows calling internal EMTPWorks methods from standard JavaScript programming. JavaScript (also called Jscript) is available on all computers.

JavaScript is used for:

1 Scripting the data functions of all devices. All data webs are based on JavaScript and DHTML. JavaScript programs have access to all device attributes.

2 Scripting device drawings (symbols). A set of extensions allows modifying or redrawing devices symbols based on data or user requests. It includes drawing basic shapes, coloring, adding or deleting pins.

3 Scripting design signal properties.

4 Scripting library functions.

5 Collecting and changing design data.

6 A large set of data file functions is used to provide data file services to devices.

The scripts can be called from script files associated to objects. As indicated above, the Script.Open.Dev attribute of a devices is the script started when the device is double-clicked. Advanced users can also create their own scripts specially useful for sophistication in subcircuit masking.

EMTPWorks also has a “script console” action. If a JavaScript file is opened is using “File>New>JavaScript” then the contents of the file can be executed using the keyboard shortcut CTRL-R. An example is shown in Figure 33. The contents of the script are:

var cct=currentCircuit();

var all_sigs=cct.signals(1); //all selected signals in the current circuit

var cct=currentCircuit();

var all_sigs=cct.signals(1); //all selected signals in the current circuit

//*Show the name

if(all_sigs.length >0){

for (i=0;i<all_sigs.length;i++)
{

all_sigs[i].setAttributeVis(“Name”, true )

}

}else{

alert(‘No selected signals’);

}

It is a small program for making the names of all selected signals visible. The script is executed for the last opened (clicked on) tab.

Figure 33 Scripting through a JavaScript file

More sophistication is added by scripting library functions. This example programs a device switcher:

//*A device switcher
dev = defaultObject(); // Get the currently selected device

if (dev == null) halt(); // If nothing selected, bail out now

Selected=dev.getAttribute(‘Selected’); //Find the new selection

Selected=Selected.replace(/_/g,’ ‘);

lib=DWLibrary(‘RLC branches.clf’);

newType=lib.loadType(Selected);

if ( newType != null) {

dev.type=newType;

}

9 Libraries

EMTP®-EMTPWorks provides a built-in set of libraries. The user should not save data into these libraries, but should create own separate libraries. A default user-accessible empty library Work.clf is available. It is strongly recommended not to save user-defined libraries into the EMTPWorks program directory. Library files carry the extension “.clf” and can be saved anywhere on the computer and accessed from the EMTPWorks “File>Open” menu or by double-clicking on the library file name. The default set of libraries automatically loaded at EMTPWorks startup is found under the EMTPWorks directory “Libs”. The default set is read-only.

  • The next step detaches DEV2 by making it unique.

hju

  1. <098″> introduction

<099″>1.1. IN SHORT…

SCOPEVIEW is a mathematical and graphical data acquisition and signal processing soft­ware. It is used to simultaneously view and process data from many sources, such as:

HYPERSIM®;

EMTP-RV;

EMTP-V3 .pl4 files;

MATLAB and;

COMTRADE.

The results are displayed graphically for further analysis and processing.

<100″>1.2. SCOPEVIEW DETAILS

ScopeView:

Runs under Unix®;

Runs under Linux® RedHat 7.2 / 7.3 with Linux 2.4 kernel;

Runs under Linux® Enterprise WS4 with Linux 2.6 kernel:

Runs under Windows®;

Supports off-line and real-time simulations.

<101″>1.3. MAIN FEATURES

Here are the main features of the software:

Simultaneously view and process data from many sources (multi source and multi domain);

Execute a variety of mathematical functions on signals (e.g. spectral density, frequency re-sponse, coherence, etc.);

Offer an interpreter for mathematical formulas that handle signals and scalars;

Execute many types of graphic processing on signals (e.g. zoom, superimposition, versus, tracking cursor, interactive displacement of graphs, etc.);

Save signal processing and editing information in a model acquisition file for later use;

Allow exporting signals acquired in different formats (e.g. MATLAB, ASCII, PDF, POST-SCRIPT)

<102″>1.4. ENVIRONMENT VARIABLES

ScopeView may be used in either English or French.

In Microsoft Windows:

From the Windows control Panel, click on the Regional Settings;

In the General Options, select English (Canada) or French (Canada);

Launch ScopeView.

To change ScopeView language, if it’s already running, shut down ScopeView, change the language setting then start ScopeView again.

  1. <103″> TUTOrIAL

<104″>2.1. TUTORIAL

This is a quick tutorial to use ScopeView and to be used as an example.

<105″>2.1.1. HYPERSIM® START-UP

Launch HYPERSIM®[1] and load the CIGRE_3 example file.

Start the simulation.

Load sensors using the saved signals file.

<106″>2.1.2. SCOPEVIEW START-UP

Launch ScopeView.

Click on the Data Source button in the Signals Window of ScopeView. Then select HYP tab and Load.

Figure 1: ScopeView Signal Form Window

Figure 2: Data Sources Chooser

Figure 3: Signals displayed

Using the mouse left click, select signals from the top part of the signal window. The chosen signals move automatically to the Selected Signals table at the bottom of the window.

Select all signals by clicking on Add All or use <Ctrl+A> keys to select all the signals at once then click on the Add Selected button.

Finally, click on the Start icon.

Results are displayed in the ScopeView Graphic.

Figure 4: Results displayed in the Graphic Page

  1. <107″> Main Window

When ScopeView opens, the Signals form and the Main window are present on the screen. The ScopeView Signals form shows on top of the main window in order to first choose a source of signals and a template to be displayed by the Main window.

The Main window is described in this Chapter and the Signals form features are presented in Chapter 4.

<108″>3.1. MAIN WINDOW

This section describes the major elements displayed in the main window of ScopeView. For a clearer understanding, it is subdivided in different areas, which are described in this chapter. These areas are the following:

Control buttons area.

Graphic page area.

Edit graphs area.

Information area.

Figure 5: Main Window Area

The two following figures give a brief description of each control button. The same shows a description that will appear when you leave your mouse cursor on the chosen button.

Figure 6: Icon related function

Figure 7: Zoom options

<109″>3.2. MAIN WINDOW MENUS

<110″>3.2.1. FILE MENU

Figure 8: File menu

3.2.1.1. OPEN DATA SOURCE FILE…

Displays the window below. Select a file that was previously generated or select HYP for connecting to a HYPERSIM® model, TestView to connect to a TestView model. Clicking Load will load the data source of interest.

Figure 9: Data sources chooser window File and HYP tabs

3.2.1.2. NEW TEMPLATE

This item from the menu clears the graphic page area to let you create your own new template.

3.2.1.3. OPEN TEMPLATE

Allows opening template used with another simulation session. Template files have.xml or.mod extension. The name of the template file will then appear at the top of the main window.

Figure 10: Open Template Window

3.2.1.4. SAVE TEMPLATE

Allows saving a study set-up in a file for future use as a template or to help in setting up a new study in your current directory. The template is saved under ScopeView\templates\…

3.2.1.5. SAVE TEMPLATE AS…

Allows to save a study set-up in a file for future use as a template or to help in setting up a new study in the directory of your choice.

Figure 11: Save Template As window

3.2.1.6. DELETE TEMPLATE

To erase a template from your work station

3.2.1.7. EXPORT…

Used to transfer a result file in a different format to be used with simulation software or in a convenient format for visualization or printing purposes. Available formats are:

Comtrade (*.cfg)

Encapsulated Post Script (EPS) (*.eps);

Joint Photographic Expert Group (*.jpg)

MATLAB Binary (*.mat);

Portable Document Format (PDF) (*.pdf);

Portable Network Graphic (*.webp);

Post Script (PS) (*.ps);

Text (tab separator) (*.txt).

Figure 12: Export Action Window

3.2.1.8. PRINT…

Print the actual window (results) displayed on screen. Allows selecting one of the printers installed on your workstation.

3.2.1.9. PRINT PREVIEW…

Displays the actual graphical page area (results) before printing is released.

3.2.1.10. EXIT

Quits and closes ScopeView.

<111″>3.2.2. EDIT MENU

Figure 13: Edit menu

3.2.2.1. CUT

Select a graph from the main window and click on this function to remove the graph from the graphic page area and put it on the clipboard.

3.2.2.2. COPY

Select the graph you want and click on this function to copy the graph on the clipboard. The selected graph remains on the graphic page area.

3.2.2.3. PASTE

This function displays the content of the clipboard on the actual graphic page area.

3.2.2.4. PASTE ON A NEW PAGE

A variant from the Paste option. This function will create a new page and displays the content of the clipboard.

3.2.2.5. DELETE

Remove definitely the selected graph from graphic page area displayed.

3.2.2.6. SELECT ALL

Select all the graphs displayed on the graphic page area.

Another way to select all graphs is, move the cursor in the graphic page area then press the <CTRL> and <a> keys.

3.2.2.7. SELECT NONE

Deselect all the graphs selected before.

<112″>3.2.3. VIEW MENU

Figure 14: View menu

3.2.3.1. TOOLBAR

Allows user to show or hide the different menus from the Toolbar.

3.2.3.2. CANVAS FOOTER

Allows showing or hiding the Edit Graph buttons at the lower left hand side of the ScopeView window.

3.2.3.3. ACQUISITION PARAMETERS…

Allows selecting the starting time, sampling time length (duration) and, number of acquisitions to execute.

Synchronization (when ticked) specifies if a synchronization signal should be used during data acquisition[2].

3.2.3.4. SHOW GRID

Displays grid on all graphs on the graphic page area.

3.2.3.5. SHOW SELECTED GRAPHS ONLY

Select the graph(s) you want to display and click on this option.

If you select, for example, only one graph, the later will occupy the complete area of the graphic page area.

Unselected graphs are hidden not deleted.

3.2.3.6. SHOW ALL GRAPHS

Displays all the graphs including the ones that were hidden before.

<113″>3.2.4. ZOOM MENU

Figure 15: Zoom Menu

The zoom options from the menu or the control buttons at the top of the main window allow viewing parts of graphs with a greater resolution in order to focus on selected parts of graphs.

The following types of zoom are available:

X;

Y;

XY;

X Y Auto;

Moreover, ScopeView remembers the zooms made to revert to a previous state or an original state.

<114″>3.2.5. GRAPH MENU

Figure 16: Graph menu

3.2.5.1. SUPERIMPOSED

ScopeView will display two or more traces in the same graph (depending how many signals you have selected).

3.2.5.2. UNDO SUPERIMPOSED

ScopeView will display one signal per graph.

3.2.5.3. CURSOR

ScopeView will display a Region cursor and a corresponding table. This type of cursor selects an area of interest of a graph and displays the coordinates and other information as per the table below.

To activate this feature, select the Cursor item; click your mouse to the beginning of the area you want then at the other end of the same area.

Figure 17: Region cursor table

3.2.5.4. TRACKING CURSOR MODE

Change the default cursor to a cross-hair cursor. The tracking cursor follows the graph curve and displays axis values at the lower left hand side of the graph.

To activate the cross-hair cursor function, first select the graph(s) of interest.

To select many graphs, press and hold the <CTRL> key then click on the graphs you want to select.

To select all the graphs, click on the Select All button at the lower left corner of the graphic page area.

<115″>3.3. THE GRAPHIC PAGE MENUS

<116″>3.3.1. IN SHORT…

Once the data acquisition is executed, the software displays the results graphically. It is pos­sible to process and analyse the acquired signals. This section covers the part after the acqui­sition, which is usually referred to as post processing.

This section explains the different methods used to access post-processing functions. Since many of these functions require the selection of one or many graphs, the method used to select graphs is also described.

Most of the post processing functions offered by ScopeView can be selected from the tool bar or the background menu of the graphic page area.

Most graphic actions can be executed on one or many graphs simultaneously. The software uses a general procedure to select graphs of interest.

Figure 18: Graph Selection

3.3.1.1. TO SELECT GRAPHS OF INTEREST:

Hold down the <CTRL> key and click on each graph of interest. A frame is displayed around the graph.

Deselect a graph by holding down the <CTRL> key and clicking on the graph again. The frame disappears.

3.3.1.2. TO SELECT ALL THE GRAPHS SIMULTANEOUSLY:

Use the Edit Graph buttons at the left bottom corner of the window.

3.3.1.3. TO DESELECT THE GRAPHS:

Use the Edit Graph buttons at the left bottom corner of the window. Or from Edit menu, choose Select None (<Ctrl+Alt+N>) item.

3.3.1.4. EDITING

This section details the methods available to edit each graphic page created during an acquisition. The following topics are covered:

Selecting the Graphic page to display;

Graph layout;

Changing the appearance of graphs;

Editing form;

Adding specific notes;

Saving the editing information. (ScopeView saves the editing information in the template files).

3.3.1.5. SELECTING THE GRAPHIC PAGE TO DISPLAY

The Page selection tab at the bottom of the Graphic page enables you to navigate between the different graphic pages created during an acquisition.

To change the graphic page to be displayed, click on the desired page tab at the bottom in the main window.

3.3.1.6. GRAPH LAYOUT

Changing the Number of Columns. You can change the number of columns of the current page using the Number of columns item at the bottom of the graphic page.

For ease of use, the software allows a maximum of six columns and each column can consist of six graphs. ScopeView will deny or change without a warning message any selection over¬riding this limit.

To change the number of columns in the current page: Click on the number of columns you want in the Number of Columns buttons at the bottom of the main window.

3.3.1.7. AUTO LAYOUT

The Auto layout button tells ScopeView if it should or not arrange graphs automatically when changing the number of columns in a graphic page. In automatic mode, ScopeView attempts to place an identical number of graphs in each column.

3.3.1.8. MOVING GRAPHS MANUALLY

To allow for the maximum of freedom in editing graphs, ScopeView offers the possibility of moving a graph interactively to another location in the same column, in a different column or even to another graphic page.

3.3.1.9. MOVING MANY GRAPHS TO ANOTHER PAGE:

Select the graphs to be moved;

From the background menu, select Copy;

Then, select Paste on a new page.

If you select a graph then select Paste on a new page without selecting Copy, ScopeView will create a new page (after the last one) and will move the graph. Or, select the destination page from the page tabs and select Paste. ScopeView then moves the graph to the last column on the destination page.

3.3.1.10. TO MOVE A GRAPH TO ANOTHER LOCATION ON THE SAME PAGE:

Select the graph of interest;

Move the cursor in the top banner and a small hand will appear;

Press and hold the mouse left button to grab and move the graph to the desired position in the page. Release the button.

<117″>3.4. BACKGROUND MENU

To display the background menu of the Graphic page, position the cursor on the graphic page;

Click the mouse right button.

Figure 19: Background Menu

The left (or top) series of icons have been described in Section Edit Menu and are standard MS Windows icons and functions.

<118″>3.4.1. GRID

Grid item allows showing or hiding the grid in the selected graph.

To add a grid to the graph, select the graph(s); from the background menu select Grid then Show from the sub-menu.

To hide a grid from a graph, select the graph(s); from the background menu select Grid then Hide from the sub-menu

<119″>3.4.2. X AND Y TYPE AXIS

X and Y type axis item allows the user to select either Linear or Logarithmic type of graph.

<120″>3.4.3. WINDOW PROPERTIES

Window Properties opens an info form (see Figure 3-15) that displays the software identifi­cation; the software icon used on the graphic area page and the computer user ID.

Figure 20: Window Properties

<121″>3.4.4. PAGE PROPERTIES

Page Properties opens the following form:

Figure 21: Page Properties

ScopeView allows you to customize editing of each page used for acquisition. You can change or add information relating to each page and also control the display of such informa­tion.

Header tab. Used to display a header title on the top of the page.

Footer tab. Used to display a footer title at the bottom of the page.

<122″>3.4.5. GRAPH PROPERTIES

Graph Properties allows the user to change many aspects of the selected graph. Not selected graph can be modified from the list displayed at the left of the form.

Type tab displays the ordinary line traced on the graph page;

X and Y axis tabs allows to change the selected graph title, text and unit factor;

Figure 22: X and Y axis tabs

Label can be either scientific or engineer;

The scale minimum/maximum can be set to the user needs; same for the tick marks spacing and precision and;

Grid can be changed from linear to logarithmic.

Chart colour tab allows the user to change the colour of

(i) Chart

(ii) Chart Area

(iii) Plot Area

Figure 23: Chart Colour Tab

Chart

Foreground: Graph title.

Background: Banner above graph.

Chart area

Foreground: X and Y axis units’ characters.

Background: Graph background (behind the plot area).

Plot area

Foreground: X and Y axis lines.

Background: Graph drawing area inside X and Y axis.

Line style tab displays this mode of the graph properties form.

Figure 24: Line Style Tab

The plotted line colour can be changed as per the user needs;

It is also possible to use symbols on the plotted line with user-defined size and col­our.

Legend tab allows to display or not the title show at the top of the chart.

Header and Footer tabs are used to add text or comments in the Header/Footer areas.

A note can be added to the plotted area of the selected chart from this mode of the Graph properties form.

To add a note to a graph, select the Note tab from the Graph Properties window, enter the desired note in the text field then click the Add button to move the text in the Notes field.

Select the note you want to see in the graph from the Notes field and click Apply.

You can drag and drop the note anywhere on the graph.

To erase a note, select the Remove or the Remove all button to erase the note. Click Apply.

Figure 25: Note Tab

<123″>3.4.6. CLIPBOARD PROPERTIES

Select the format you want to store information on the clipboard (from the Copy command/ icon) to be printed, pasted or exported. To copy and paste in Word, use Bit­map, to export use Encapsulated PostScript.

Figure 26: Clipboard Properties

<124″>3.5. TOOL BAR MENU

To accelerate handling, the most common graphic page functions can also be accessed directly through the buttons at the top of the graphic page. For example, one of the buttons allows you to zoom in quickly on the selected graphs.

The Zoom options from the tool bar menu or from the accelerator buttons allow viewing parts of graphs with a greater resolution in order to focus on selected parts of the graphs.

Moreover, ScopeView stores the zooms made to revert to a previous state or an original state.

<125″>3.5.1. ZOOM IN OPTIONS

Figure 27: Zoom In Options

To execute an X zoom, click on the graph(s) of interest;

Then click the button at the top of the graphic page.

Position the mouse cursor at the left of the region of interest. Hold down the left button then drag the mouse to the right to sweep the region of interest and finally, release the button.

Figure 28: Before and After Zooming X Axis

There is almost no limit to the number of horizontal zooms that can be applied to a given curve. The only limit is that at least two points should always be displayed.

There are two ways to cancel the effect of zooms in: last or all levels.

<126″>3.5.2. ZOOM OUT LAST LEVEL OPTION

The last level option of the tool bar allows reverting one-step to the previous zoom. ScopeView cancels only the effect of the last step.

To execute a last level zoom out, click on the graph(s) of interest then click the button in the tool bar.

The selected graph(s) reverts to the last level in X-axis automatically;

The same action can be performed in Y-axis or in XY axis together as per the icon selected respectively.

<127″>3.5.3. ZOOM OUT ALL LEVELS OPTIONS

The All levels option allows you to revert to the initial display state. ScopeView then cancels the effect of all the previous zooms.

To execute a global zoom out, click on the graph(s) of interest then click the button in the tool bar.

The selected graph(s) reverts to the original level in X-axis automatically;

The same action can be performed in Y-axis or in XY axis together as per the icon selected.

<128″>3.6. ADVANCED GRAPHIC ACTIONS

ScopeView enables you to execute many graphic actions on one or many graphs in the current page. These actions are intended to facilitate analyzing the results. The Advance Graphic Ac­tions are:

Superimposition;

Undo superimposition`;

Cursor;

Tracking cursor;

Select Signals;

Plot signals.

<129″>3.6.1. SUPERIMPOSITION

In order to provide a simple way of comparing curves, you can superimpose them on the same graph. Moreover, ScopeView saves all the super impositions made to revert to each of the previous acquisitions.

To execute a Superimposition, click on the graph(s) of interest then click the button in the tool bar. The selected graphs will superimpose automatically.

Superimposition is also available in the ScopeView – Signals window.

If the graphs of interest do not have the same X display range, ScopeView then uses the union of these ranges, in other words the minimum lower delimiter and the upper maximum delim­iter of all the graphs to superpose.

A different colour and type of trace is used to set apart each of the superimposed curves. A legend at the top of the graph identifies each curve.

When executing a superimposition, the selected graphs are hidden and the resulting graph is displayed at the position of the first selected graph.

<130″>3.6.2. UNDO SUPERIMPOSITION

The undo option of the Graph menu allows you to cancel the superimposition and return to the initial configuration.

To revert from a superimposition of graphs, select the graph of interest then click the button in the tool bar. The selected graph will revert to their original state automatically.

The “revert” superimposition is also available in the ScopeView – Signals window.

<131″>3.6.3. TRACKING CURSOR

With the tracking cursor, ScopeView gives you the possibility of measuring signals displayed on the graphic page.

To switch to the tracking mode, click the cross-hair cursor icon in the tool bar. Scope­View displays the Tracking cursor on all graphs selected on the graphic page

Figure 29: Tracking Cursor

To switch off the tracking mode click the cross-hair cur­sor icon again. It has a toggle action.

It also displays, on the status line, the coordinates of the current point of each curve (simul­taneously above each graph). ScopeView updates instantaneously the coordinates when the cursor moves.

In tracking mode, you can:

Move the cursor by moving the mouse laterally. A lateral displacement brings about the automatic positioning of the horizontal line on the current point. The intersection of the vertical line with the horizontal line indicates the position of the point whose coordinates are displayed on the status line.

Use the LEFT or RIGHT arrow keys to move from one point to another on the curve.

Use the UP or DOWN arrow keys or the space bar to move the cursor from one curve to another (superimposition).

<132″>3.6.4. CURSOR

The Cursor, or the region cursor, allows the user to delimit a region of interest on the graph and display a pop-up result window. This function is very useful to compare a wider range of information, particularly in superimposed graphs, than with the tracking cursor. The tracking cursor displays results in an information window.

Figure 30: Region Cursor

<133″>3.7. DATA MANAGEMENT

<134″>3.7.1. EXPORTING THE RESULTS

It is possible to transfer a result file in a different format to be used with simulation software or in a convenient format for visualization or printing purposes. Available formats are:

Comtrade (*.cfg)

Encapsulated Post Script (EPS) (*.eps);

Joint Photographic Expert Group (*.jpg)

MATLAB Binary (*.mat);

Portable Document Format (PDF) (*.pdf);

Portable Network Graphic (*.webp);

Post Script (PS) (*.ps);

Text (tab separator) (*.txt).

To export a result file, click on the Export button at the top of the window

Type in the file name

Then select the file format;

Click the Export button.

Figure 31: Exporting Results Window

<135″>3.7.2. PRINTING

The Print button in the main window is used to print the content of the graphic page with a PostScript laser printer, or to a PostScript format file.

It is possible to change the printer or the print orientation by modifying the items on the Print Options form.

To access the Print Options form, click the print button or click the print option from the File menu

Figure 32: Print Options Window

Select the desired options.

In accordance with the printer installed on your system, select the desired options from the General, Page set-up and Appearance tabs.

Each printer and system have different options like colour output, A4 or A3 paper size etc. It is up to the user to set his printer. ScopeView on Personal Computer (PC) uses the MS Win­dows® drivers.

  1. <136″> The Signals Form

<137″>4.1. GENERAL

It is necessary to configure a series of items before starting data acquisition. For example, you must select the signals to acquire, the corresponding mathematical operations to per­form and to specify the number of acquisition. This is the preparation phase of the acquisition and this chapter describes the steps involved.

In the Signals Form below, four areas are accessible:

The command buttons area;

The available signals area;

Signal processing;

The selected signals area

Figure 33: Signal Form Window

<138″>4.2. SIGNALS FORM MENUS

In the following Figure, the File and Edit menus have the same functions as already described.

Figure 34: ScopeView – Signals form

<139″>4.3. VIEW MENU

Figure 35: View Menu

<140″>4.3.1. TOOL BAR

Allows user to show or hide the different menus from the Toolbar.

<141″>4.3.2. ADVANCE FUNCTION EDITOR

Allows user to display the advanced mathematical functions in editor mode. Detailed instruction on this mode is given later.

Figure 36: Signals form in Advance Function Editor mode

<142″>4.4. DATA SOURCE MENU

Figure 37: Data source menu

<143″>4.4.1. LOAD

Displays the Data Sources Chooser window and allows the user to load a particular plot file or signals from Hypersim® sensors.

Figure 38: Data sources chooser window

<144″>4.4.2. REPLACE

Displays the Data Sources Chooser window and allows the user to replace (delete the previ­ous if any) and load a new file.

The Data Sources Chooser window displays a Replace button instead of the Load button.

<145″>4.4.3. RELOAD ALL

Reload the plot file already loaded when new sensors had been added in your HYPERSIM® sim­ulation as per example.

<146″>4.4.4. REMOVE ALL

Remove all the data sources already loaded.

<147″>4.5. GRAPH MENU

Figure 39: Graph menu

<148″>4.5.1. PLOT SIGNALS

Traces the graphs from the selected signals displayed in the selected signals area of the Sig­nals window.

This menu item is the same command as the Plot icon on the tool bar or the Start button at the top of the window.

<149″>4.6. ACCESSIBLE AREAS

<150″>4.6.1. COMMAND BUTTONS

The first group of buttons at the left of the window are the usual functions from MS Win­dow®.

The button gives you access to the mathematical functions. (The access is duplicated at the far right middle of the window).

The Start button tells ScopeView to trace the selected signals in the graphic page ar­ea.

<151″>4.6.2. AVAILABLE SIGNALS AREA

This area gives a detailed list of the available signals from the selected data source file dis­played in the small window beside the Data Source button.

<152″>4.6.3. SELECTED SIGNALS AREA

This section displays the description of the selected signals to be plotted on each graphic page and the mathematical functions applied to the same signals.

<153″>4.6.4. SIGNAL PROCESSING

This area has a selection of functions modifying the graphic page area when ScopeView plots the selected signals.

4.6.5. <154″>SIGNAL SELECTION

The Signals form allows you to specify the signals to acquire and the corresponding mathe­matical operations to apply. The data source file is generated by the active simulation soft­ware, i.e. EMTP-RV.

You can also open a previously saved source file.

The Data Source… button reveals a menu (same menu as the one displayed by the Data Source item on the toolbar). From that menu, select the option you need.

Figure 40: Data source menu

Figure 41: Data source chooser window

ScopeView can acquire data from many sources (Files of type). This section describes how to specify the data sources you want to use during a work session.

4.6.5.1. EMTP

The EMTP source allows importing signals saved previously in an .m, or .pl4, file generated by the EMTP simulation software.

4.6.5.2. MATLAB

The MATLAB source is used to import signals saved previously in a .mat file generated by the MATLAB processing software.

The .mat file must contain a list of vectors with at least one of these vectors representing the abscissa (or time axis).

4.6.5.3. COMTRADE

The COMTRADE source allows importing signals saved previously in a .cfg file generated under the COMTRADE format.

To load previously saved sources, click on the file you want.

Select the signal type tab (EMTP, Matlab etc.);

Select the file format in accordance with the type of work station you are using, PC or UNIX

Click the button. (The Load button moves the files in the available signals area.).

Below the Loaded Data Source box is the Signal Type identification. From the pull-down list, select the type of signal you want to study. The list corresponds to the sensors installed in your simulation software or the usable Database.

It is possible to select files from the Loaded Data Source box (scroll-down-list) in order to display or delete them. It is possible to remove a single file or Remove All the files from the list and, finally the user can reload all or replace a file.

Remember, it is possible to study signals from two or more different sources at the same time.

<155″>4.7. SIGNAL PROCESSING

Below the Available Signals area, six cells and one button are present.

<156″>4.7.1. SIGNAL SELECTION MODE

Single: Any selected (mouse click) signal will move automatically to the Selected sig­nals list.

Multiple: Click the signals you want then click the Add Signals button to add signals to the Selected Signals. Multiple selection is possible by clicking and holding the CTRL key.

The Add Signals button will show only when the multiple option is selected.

<157″>4.7.2. GRAPH CREATION

Normal: ScopeView will display one signal per graph.

Superimposed: ScopeView will display two or more traces in the same graph (depend­ing how many signals you have selected.

<158″>4.7.3. X AXIS

Grid or Log: ScopeView will display, according to the ticked box, either a graph with or with­out a grid. The other option is used to display a linear or a logarithmic graph in the X axis.

<159″>4.7.4. Y AXIS

Grid or Log: ScopeView will display, according to the ticked box, either a graph with or with­out a grid. The other option is used to display a linear or a logarithmic graph in the Y axis.

<160″>4.7.5. PAGE

Select the page number where you want to display the selected signal.

<161″>4.7.6. FUNCTION

From the pull-down list select the function you want to apply to the selected signal. The list contains simple functions (one signal per argument).

Advance functions are available by clicking one of the buttons.

When Multiple Signal Selection Mode is used, this button will add the selected signals to the list at the bottom part of the Selected Signal area.

<162″>4.8. SELECTED SIGNALS

This area shows all the selected signals and their description. The two right hand columns are used to display or not the result on the page of your choice.

By default the Signal column displays and confirms the selection of different signals.

To edit a signal, click on its cell, type in your changes and, hit <ENTER>. You must press <ENTER> to commit the changes or <ESC> to cancel. Either of these actions will return user to the default mode.

The Description column shows the signal description (often the same as the signal name un­der the Signal column.

The Show column, when “ticked” , the signal will be acquired and displayed in Scope­View.

In Page column, the number written under this column tells ScopeView on what page to dis­play the result from that signal.

The numbered column at the far left is use to show the background edit menu. Right click on the line you want to edit.

<163″>4.8.1. SPLIT SCREEN OPTION

Scope View offers a split screen option to ease the multiple data source use. Simply click the mouse in the Signals area to see the background menu. You can split the area either horizon­tally or vertically. To revert to a single screen, click on Close View. Below is an example of horizontally split screen from the data sources loaded in two sections.

Figure 42: Signals form in split window option

<164″>4.8.2. REMOVING A SOURCE

The Remove button enables you to remove the current source or the Remove All button re­moves all the sources files from the scroll list.

To remove file (s) from the active list, display the source file you want to remove in the Loaded Data source file list;

Display the Data Source menu, and click on the Remove current data source item.

Or click on the Remove All button if desired.

If some formulas contain signals from a removed source, ScopeView displays a message ask­ing to confirm this action. If you confirm, the formulas affected by the removal are automat­ically withdrawn from the list of formulas to evaluate.

<165″>4.8.3. REPLACE A SOURCE

The Replace button is used to change the characteristics of a source. This action is useful when you want to keep evaluating the same formulas, but with signals from a different source. The only restriction to replace a source is that the list of available signals should be the same.

To replace a source, in the Signal Form window, display the Data source menu;

Click on the source to change, select the Replace item.

ScopeView makes sure that the changes you make follow the replacement criteria. Otherwise, it refuses to execute the requested action.

<166″>4.9. INSERTING A FUNCTION

The Signals section allows you to insert a new signal or function to the list of Selected Signals to evaluate.

<167″>4.9.1. ADVANCE FUNCTION

To apply an advance function to a signal, click on the name of the signal;

Select the category of function you want to apply to a signal (or select “All” to see all the available functions;

In the Function Name drop list, select a function;

Click the Add Function button.

Figure 43: Signal form in advanced function option

<168″>4.9.2. SIMPLE FUNCTION

The Simple Function (far right of the ScopeView – Signals form) section allows you to spec­ify the mathematical operations to apply to the signals you select in the list of available sig­nals. You can also configure other characteristics such as:

abs: absolute value;

acos: arc cosine

asin: arc sine

atan: arc tangent

cos: cosine

densp: spectral density

deriv: derivative

integ: integer

i2T: integral Time reverse sequence

log: logarithm

log10: logarithm base 10

min: minimum

max: maximum

moy: average

rms: root mean square

sin: sine

sqrt: square root

tan: tangent

To apply a simple function to a signal, select the mathematical function to be applied to a signal using the menu related to the Function item.

Select a signal; Click Add Signals button.

<169″>4.9.3. LIST OF FORMULAS TO EVALUATE

The Selected Signals area contains the list of formulas to evaluate during the acquisition. Each line in the list describes a signal (and a function in some cases) to evaluate and specifies characteristics such as:

Description;

Show;

Page.

Initially, ScopeView displays the results in a graphic page corresponding to their appearance order in the list of Selected Signals. After a first acquisition, you can change the display order by displacing the graphs interactively.

The Selected Signal field specifies a formula to evaluate. A new formula can be generated automatically by ScopeView or built manually.

To insert automatically a new formula, click on the selected source in the Data Source list;

Click on the signal you want in the list of Signals.

Select the processing to be applied from the pull-down list under Function to apply;

To edit manually a formula, click in the Formula field of the formula to edit.

Type the formula.

If this formula reuses a signal from another formula, you can then enter manually the identi­fier that was assigned to it by ScopeView. However, if the formula contains signals, which are not yet part of other formulas, you must insert them as follows to allow ScopeView to assign an identifier to each new signal:

Click on the selected source in the list of Data sources.

Click on the Multiple Signal Selection Mode and the function to be applied from the pull-down list under Simple Function to apply.

Click on the name of the chosen signal in the list of Signals.

ScopeView has a formula interpreter to evaluate complex formulas. This interpreter supports the following operators and functions:

Standard arithmetic operators (+, -, *, /, ** or ^, vs);

Assigning in one or many variables that can be reused by other formulas;

Standard mathematical functions (sine, cosine, logarithm, etc.);

Internal functions for spectral analysis (spectral density, frequency response, etc.);

TYRAN functions (calculation of module and phase for a symmetric, integral component, etc.);

External functions for signal processing (calculation of fundamental frequency, harmonics, digital filters, etc.).

<170″>4.9.4. DESCRIPTION

You can specify in the Description field the description to identify the result of the formula during graphic display.

ScopeView automatically generates a default description when inserting a new formula. This description consists of an abbreviation representing the mathematical operation applied to the signal and the signal name (or signals) selected.

<171″>4.9.5. SHOW

The Show checkmark box specifies to ScopeView if it must display the formula result in a graph.

ScopeView automatically selects this item when a signal or a function is inserted from the list of Signals.

If you build manually a formula and you select this item, ScopeView will automatically ini­tialize at 1 the Page field for the formula. You can change this page number if you wish.

<172″>4.9.6. PAGE

The Page field specifies the destination graphic page for the formula.

<173″>4.9.7. EDITING THE LIST OF FORMULAS

The list of signals can be edited to change the display order of the formulas or to delete them from the list.

You can edit the list of formulas either using the menu associated with the Edit menu, or the background menu associated with the scroll list. This menu allows executing the following commands:

To select one signal only, click in the far left column beside the required signal.

Select all: to select all the formulas.

Select none: to unselect all the formulas.

Cut: To cut selected formulas and save them in the buffer

Copy: To copy selected formulas in the buffer

Paste: To add to the list formulas from the buffer

Delete: To remove selected formulas without affecting the content of the buffer

<174″>4.9.8. CUT

To cut one or more formulas, move your cursor in the far left column and right click to display the background menu.

Click on Cut to cut and save in the buffer.

<175″>4.9.9. COPY

To copy one or more formulas, move your cursor in the far left column and right click to display the background menu.

Select the Copy option from the Edit menu.

<176″>4.9.10. PASTE

To paste the content of the buffer, move your cursor in the far left column and right click to display the background menu.

Select paste the content of the buffer:

<177″>4.9.11. DELETE

To delete one or more formulas, move your cursor in the far left column and right click to display the background menu.

Select the Delete option from the background menu.

<178″>4.10. TEMPLATE

In order to accelerate the configuration of repetitive and identical acquisitions from one ses­sion to another, ScopeView allows you to save and retrieve the information on the formulas to evaluate.

The following information is contained in a template acquisition:

List of sources used;

Acquisition numbers;

List of signals to acquire;

List of formulas to evaluate;

Editing information (number of columns, superimposition, zoom, etc.)

<179″>4.10.1. OPEN A TEMPLATE

You can load a previously saved template acquisition by selecting the button or the Open Template… item in the File menu. The software displays the form to select the file to open. The scroll list allows navigating in the file tree-structure.

Figure 44: Open template window

To load a template acquisition, click on the button or from the File menu click on Open Template…

In the scroll list, select the template acquisition wanted.

Click on the Open… button.

<180″>4.11. ACQUISITION PARAMETERS

4.11.1.1. NUMBER OF ACQUISITION

The Number of Acquisition field specifies the number of acquisitions to be executed by ScopeView.

If the signals originate from acquisition units, it can be useful to have a number of acquisitions higher than one to see the evolution of the acquisition signals from one acquisition to another or to compute the average of the results obtained.

  1. <181″> Functions

<182″>5.1. TRIGONOMETRIC

<183″>5.1.1. ARC COSINE – [ACOS]

Outputs the arc cosine value of the input.

5.1.1.1. CATEGORY

Trigonometric

5.1.1.2. DESCRIPTION

Outputs the inverse cosine or arc cosine value of the input. The output value is in radians.

5.1.1.3. RESULT VARIABLES AND PARAMETERS

Result: Arc cosine value [radians]

Signal: Cosine value

5.1.1.4. SYNTAX

res = acos(input)

5.1.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.1.6. EXAMPLE

<184″>5.1.2. ARC SINE – [ASIN]

Outputs the arc sine value of the input.

5.1.2.1. CATEGORY

Trigonometric

5.1.2.2. DESCRIPTION

Outputs the inverse sine or arc sine value of the input. The output value is in radians.

5.1.2.3. RESULT VARIABLES AND PARAMETERS

Result: Arc sine value [radians]

Signal: Sine value

5.1.2.4. SYNTAX

res = asin(input)

5.1.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.2.6. EXAMPLE

<185″>5.1.3. ARC TANGENT – [ATAN]

Outputs the arc tangent value of the input.

5.1.3.1. CATEGORY

Trigonometric

5.1.3.2. DESCRIPTION

Outputs the inverse tangent or arc tangent value of the input. The output value is in radians.

5.1.3.3. RESULT VARIABLES AND PARAMETERS

Result: Arc tangent value [radians]

Signal: Tan value

5.1.3.4. SYNTAX

res=atan(input)

5.1.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.3.6. EXAMPLE

<186″>5.1.4. COSINE – [COS]

Outputs the cosinusoidal value of the input.

5.1.4.1. CATEGORY

Trigonometric

5.1.4.2. DESCRIPTION

Outputs the cosinusoidal value of the input. The input value is in radians.

5.1.4.3. RESULT VARIABLES AND PARAMETERS

Result: Cosine value

Signal: The input value [radians]

5.1.4.4. SYNTAX

res=cos(input)

5.1.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.4.6. EXAMPLE

<187″>5.1.5. SINE – [SIN]

Outputs the sinusoidal value of the input.

5.1.5.1. CATEGORY

Trigonometric

5.1.5.2. DESCRIPTION

Outputs the sinusoidal value of the input. The input value is in radians.

5.1.5.3. RESULT VARIABLES AND PARAMETERS

Result: Sine value

Signal: The input value [radians]

5.1.5.4. SYNTAX

Res=sin(input)

5.1.5.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.5.6. EXAMPLE

<188″>5.1.6. TANGENT – [TAN]

Outputs the tangent value of input.

5.1.6.1. CATEGORY

Trigonometric

5.1.6.2. DESCRIPTION

Outputs the tangent value of input. The input value is in radians.

5.1.6.3. RESULT VARIABLES AND PARAMETERS

Result: Tangent value

Signal: The input value [radians]

5.1.6.4. SYNTAX

res=tan(input)

5.1.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.1.6.6. EXAMPLE

<189″>5.2. MATHEMATICAL

<190″>5.2.1. ABS – [ABS]

Outputs the absolute value of selected signal.

5.2.1.1. CATEGORY

Mathematical

5.2.1.2. DESCRIPTION

Outputs the absolute value of selected signal.

5.2.1.3. RESULT VARIABLES AND PARAMETERS

Result: Absolute value

Signal: Input

5.2.1.4. SYNTAX

res=abs(input)

5.2.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.1.6. EXAMPLE

<191″>5.2.2. AVERAGE – [MOY]

Outputs the average value of the input.

5.2.2.1. CATEGORY

Mathematical

5.2.2.2. DESCRIPTION

Outputs the average value of the input over one acquisition.

5.2.2.3. RESULT VARIABLES AND PARAMETERS

Signal: Input

Result: Average value

5.2.2.4. SYNTAX

res=moy(input)

* Moyenne is a French word meaning average.

5.2.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.2.6. EXAMPLE

<192″>5.2.3. CUMULATIVE SUM – [CUMSUM]

Outputs the cumulative sum of input over time.

5.2.3.1. CATEGORY

Mathematical

5.2.3.2. DESCRIPTION

Outputs the cumulative sum of input over time.

5.2.3.3. RESULT VARIABLES AND PARAMETERS

Result: Cumulative sum

Signal: Input

5.2.3.4. SYNTAX

res=cumsum(input)

5.2.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.3.6. EXAMPLE

In the below example, a signal of constant value of 1 is given as input to the function cumsum. The sampling frequency is set at 20000 samples/second. Thus, in a duration of 0.1 second, there will be 2000 sample points. Thus, output of the function is the sum of 1 over each sampling period. At the end of 0.1 second, the output value will be 2000.

<193″>5.2.4. DERIVATIVE – [DERIV]

Outputs the derivative of the input.

5.2.4.1. CATEGORY

Mathematical

5.2.4.2. DESCRIPTION

Outputs the derivative or the slope of the input.

5.2.4.3. RESULT VARIABLES AND PARAMETERS

Result: Derivative of the input

Signal: Input

5.2.4.4. SYNTAX

res=deriv(input)

5.2.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.4.6. EXAMPLE

<194″>5.2.5. DIFFERENCE – [DIFF]

Outputs the difference between two consecutive samples from the input.

5.2.5.1. CATEGORY

Mathematical

5.2.5.2. DESCRIPTION

Outputs the difference between two consecutive samples from the input. Output will always have one sample point less than the input as there will be no output sample corresponding to first input sample.

5.2.5.3. RESULT VARIABLES AND PARAMETERS

Result: Difference of the input

Signal: Input

5.2.5.4. SYNTAX

res=diff(input)

5.2.5.5. CHARACTERISTICS

Data type supportDouble Floating point
Output SizeIf [N] is the size of the input signal, the size of output signal is [N-1].

5.2.5.6. EXAMPLE

<195″>5.2.6. INTEGRAL – [INTEG]

Outputs the integral of the input.

5.2.6.1. CATEGORY

Mathematical

5.2.6.2. DESCRIPTION

Outputs the integral of the input.

5.2.6.3. RESULT VARIABLES AND PARAMETERS

Result: Integral of the input

Signal: Input

5.2.6.4. SYNTAX

res=integ(input)

5.2.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.6.6. EXAMPLE

<196″>5.2.7. LOGARITHM – [LOG]

Outputs the natural logrithm of input.

5.2.7.1. CATEGORY

Mathematical

5.2.7.2. DESCRIPTION

Outputs the natural logrithm of input.

5.2.7.3. RESULT VARIABLES AND PARAMETERS

Result: Logarithm of input

Signal: Input

5.2.7.4. SYNTAX

res=log(input)

5.2.7.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.7.6. EXAMPLE

<197″>5.2.8. LOGARITHM 10 – [LOG10]

Outputs logrithm to the base 10 of input.

5.2.8.1. CATEGORY

Mathematical

5.2.8.2. DESCRIPTION

Outputs logrithm to the base 10 of input.

5.2.8.3. RESULT VARIABLES AND PARAMETERS

Result: Logarithm of input

Signal: Input

5.2.8.4. SYNTAX

res=log10(input)

5.2.8.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.8.6. EXAMPLE

<198″>5.2.9. MAXIMUM – [MAX]

Outputs the maximum value of input.

5.2.9.1. CATEGORY

Mathematical

5.2.9.2. DESCRIPTION

Outputs the maximum value of input.

5.2.9.3. RESULT VARIABLES AND PARAMETERS

Result: Maximum value of input

Signal: Input

5.2.9.4. SYNTAX

res=max(input)

5.2.9.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.9.6. EXAMPLE

<199″>5.2.10. MINIMUM – [MIN]

Outputs the minimum value of input.

5.2.10.1. CATEGORY

Mathematical

5.2.10.2. DESCRIPTION

Outputs the minimum value of input.

5.2.10.3. RESULT VARIABLES AND PARAMETERS

Result: Minimum value of input

Signal: Input

5.2.10.4. SYNTAX

res=min(input)

5.2.10.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.10.6. EXAMPLE

<200″>5.2.11. NEGATIVE – [NEG]

Outputs the negative values.

5.2.11.1. CATEGORY

Mathematical

5.2.11.2. DESCRIPTION

Outputs the negative values. All values greater than zero are clamped to zero.

5.2.11.3. RESULT VARIABLES AND PARAMETERS

Result: Negative value signal

Signal: Input

5.2.11.4. SYNTAX

res=neg(input)

5.2.11.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.11.6. EXAMPLE

<201″>5.2.12. PHASE DIFFERENCE – [PHASEDIFF]

Outputs the absolute difference between two phases.

5.2.12.1. CATEGORY

Mathematical

5.2.12.2. DESCRIPTION

Outputs the absolute diffence between two phases in degrees. Output is always between 0 and 180 degrees.

5.2.12.3. RESULT VARIABLES AND PARAMETERS

Phase_Diff: Phase differences [degrees]

Phase 1: Phase 1 [degrees]

Phase 2: Phase 2 [degrees]

5.2.12.4. SYNTAX

pdiff=phasediff(phase1,phase2)

5.2.12.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.12.6. EXAMPLE

<202″>5.2.13. PHASE SHIFT – [PHASESHIFT]

Outputs the phase difference between two vectors in degrees.

5.2.13.1. CATEGORY

Mathematical

5.2.13.2. DESCRIPTION

Outputs the phase difference between two vectors in degrees. Output is always between -180 and 180 degrees. When modules(magnitudes) are negatives, it has the same effect as rotating the vector by 180 degrees.

5.2.13.3. RESULT VARIABLES AND PARAMETERS

Phase_Shift: Phase difference [degrees]

Module 1 : Module of the first vector

Phase 1: Phase of the first vector [degrees]

Module 2 : Module of the second vector

Phase 2: Phase of the second vector [degrees]

5.2.13.4. SYNTAX

pshift=phaseshift(mag1,ang1,mag2,ang2)

5.2.13.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.13.6. EXAMPLE

<203″>5.2.14. POSITIVE – [POS]

Outputs the positive values of input.

5.2.14.1. CATEGORY

Mathematical

5.2.14.2. DESCRIPTION

Outputs the positive values of input. All values lesser than zero are clamped to zero.

5.2.14.3. RESULT VARIABLES AND PARAMETERS

Result: Positive value signal

Signal: Input

5.2.14.4. SYNTAX

res=pos(input)

5.2.14.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.14.6. EXAMPLE

<204″>5.2.15. PRODUCT – [PROD]

Outputs the product of all signal values

5.2.15.1. CATEGORY

Mathematical

5.2.15.2. DESCRIPTION

Outputs the product of all input signal values, defined as:

were is the i-th signal value

5.2.15.3. RESULT VARIABLES AND PARAMETERS

Result: product of all input signal values

Signal: Input

5.2.15.4. SYNTAX

res=prod(input)

5.2.15.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.15.6. EXAMPLE

<205″>5.2.16. RMS – [RMS]

Outputs the root mean squate of the input signal.

5.2.16.1. CATEGORY

Mathematical

5.2.16.2. DESCRIPTION

Outputs the root mean square of the input signal.

5.2.16.3. RESULT VARIABLES AND PARAMETERS

Result: Root mean square of the input

Signal: Input

5.2.16.4. SYNTAX

res=rms(input)

5.2.16.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.16.6. EXAMPLE

<206″>5.2.17. SIGN – [SIGN]

Outputs the sign of the input.

5.2.17.1. CATEGORY

Mathematical

5.2.17.2. DESCRIPTION

Outputs the sign of the input. Outputs 1 when input is greater than 0, -1 when input is less than 0, and 0 when input is 0.

5.2.17.3. RESULT VARIABLES AND PARAMETERS

Result: Sign of input [-1, 0, 1].

Signal: Input

5.2.17.4. SYNTAX

res=sign(input)

5.2.17.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.17.6. EXAMPLE

<207″>5.2.18. SQUARE ROOT – [SQRT]

Outputs the square root of input

5.2.18.1. CATEGORY

Mathematical

5.2.18.2. DESCRIPTION

Outputs the squate root of input

5.2.18.3. RESULT VARIABLES AND PARAMETERS

Result: Square root of the input

Signal: Input

5.2.18.4. SYNTAX

res=sqrt(input)

5.2.18.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.18.6. EXAMPLE

<208″>5.2.19. STAIR – [STAIR]

Generates discrete stairs at regular intervals .

5.2.19.1. CATEGORY

Mathematical

5.2.19.2. DESCRIPTION

Generates discrete stairs at regular intervals. The parameters x_begin, x_end, period, first_value, last_value and increment define the shape of the output. The following figure presents how to use each parameter.

5.2.19.3. RESULT VARIABLES AND PARAMETERS

Result: Stairs signal

x_begin: X minimum value

x_end: X maximum value

Period: time interval between X samples. The number of samples that output vector will contains is equal to (x_end-x_begin)/period+1.

First_Value: Y minimum value

Last_Value: Y maximum value

Increment: Y increment between stairs

5.2.19.4. SYNTAX

res=stair(x_begin,x_end,period,first_value,last_value,increment)

5.2.19.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.19.6. EXAMPLE

<209″>5.2.20. SUM – [SUM]

Outputs the sum of all samples of input.

5.2.20.1. CATEGORY

Mathematical

5.2.20.2. DESCRIPTION

Outputs the sum of all samples of input.

5.2.20.3. RESULT VARIABLES AND PARAMETERS

Result: Sum of input

Signal: Input

5.2.20.4. SYNTAX

res=sum(input)

5.2.20.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.20.6. EXAMPLE

For an input of value 1 acquired over a duration of 0.1 second at a sampling rate of 10000 Hz, the SUM function outputs the total sum of one thousand ones i.e. 1000.

<210″>5.2.21. WINDOW AVERAGE VALUE – [WAVG]

Outputs the moving average of the input signal

5.2.21.1. CATEGORY

Mathematical

5.2.21.2. DESCRIPTION

Outputs the moving average of the input signal with a sliding window size defined by “Window_Length”.

5.2.21.3. RESULT VARIABLES AND PARAMETERS

Result: Signal moving average

Signal: Input

Window_Length: Size of the sliding window in seconds

5.2.21.4. SYNTAX

res=wavg(Signal,Window_Length)

5.2.21.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.21.6. EXAMPLE

<211″>5.2.22. WINDOW MAXIMUM VALUE – [WMAX]

Outputs the moving maximum of the input signal

5.2.22.1. CATEGORY

Mathematical

5.2.22.2. DESCRIPTION

Outputs the moving maximum of the input signal with a rolling window size defined by “Window_Length”.

5.2.22.3. RESULT VARIABLES AND PARAMETERS

Result: Signal moving maximum

Signal: Input

Window_Length: Size of the rolling window in seconds

5.2.22.4. SYNTAX

res=wmax(input,Window_Length)

5.2.22.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.22.6. EXAMPLE

<212″>5.2.23. WINDOW MINIMUM VALUE – [WMIN]

Outputs the moving minimum of the input signal

5.2.23.1. CATEGORY

Mathematical

5.2.23.2. DESCRIPTION

Outputs the moving minimum of the input signal with a rolling window size defined by “Window_Length”.

5.2.23.3. RESULT VARIABLES AND PARAMETERS

Result: Signal moving minimum

Signal: Input

Window_Length: Size of the rolling window in seconds

5.2.23.4. SYNTAX

res=wmin(input, Window_Length)

5.2.23.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.23.6. EXAMPLE

<213″>5.2.24. WINDOW RMS VALUE – [WRMS]

Outputs the moving RMS of the input signal

5.2.24.1. CATEGORY

Mathematical

5.2.24.2. DESCRIPTION

Outputs the moving RMS of the input signal with a rolling window size defined by “Window_Length”.

5.2.24.3. RESULT VARIABLES AND PARAMETERS

Result: Signal moving RMS

Signal: Input

Window_Length: Size of the rolling window in seconds

5.2.24.4. SYNTAX

res=wrms(input, Window_Length)

5.2.24.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.24.6. EXAMPLE

<214″>5.2.25. WINDOW SUM VALUE – [WSUM]

Outputs the moving sum of the input signal

5.2.25.1. CATEGORY

Mathematical

5.2.25.2. DESCRIPTION

Outputs the moving sum of the input signal with a rolling window size defined by “Window_Length”.

5.2.25.3. RESULT VARIABLES AND PARAMETERS

Result: Signal moving sum

Signal: Input

Window_Length: Size of the rolling window in seconds

5.2.25.4. SYNTAX

res=wsum(input, Window_Length)

5.2.25.5. CHARACTERISTICS

Data type supportDouble Floating point

5.2.25.6. EXAMPLE

<215″>5.3. MISCELLANEOUS

<216″>5.3.1. 3 PHASE POWER – [POWER3PH]

Computes the active and reactive power of a three phase element by using voltages and currents.

5.3.1.1. CATEGORY

Miscellaneous

5.3.1.2. DESCRIPTION

This function allows to compute the active power and reactive power by using phase to ground voltages and currents signals. The inputs are transformed into direct sequence element and then the power is computed:

5.3.1.3. RESULT VARIABLES AND PARAMETERS

Active Power: Active power of the input signals

Reactive Power: Reactive power of the input signals

V_A: Input voltage, phase A

V_B: Input voltage, phase B

V_C: Input voltage, phase C

I_A: Input current, phase A

I_B: Input current, phase B

I_C: Input current, phase C

Fundamental Frequency: Fundamental frequency of the inputs

Nominal Power: Nominal power of the network. This factor will divide the power displayed in ScopeView. Note that the unit of the graphic will not be updated.

5.3.1.4. SYNTAX

[p,q]=power3ph(Bus_Va,Bus_Vb,Bus_Vc,Load_Ia,Load_Ib,Load_Ic,60,1)

5.3.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.1.6. EXAMPLE

<217″>5.3.2. CIRCLE – [CIRCLE]

Outputs a circle

5.3.2.1. CATEGORY

Miscellaneous

5.3.2.2. DESCRIPTION

Output a circle centered on [x0, y0] with radius R

5.3.2.3. RESULT VARIABLES AND PARAMETERS

Result: circle centered on [x0, y0] with radius R

R: circle radius

x0: x coordinate of the circle center

y0: y coordinate of the circle center

5.3.2.4. SYNTAX

res=circle(R,x0,y0)

5.3.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.2.6. EXAMPLE

<218″>5.3.3. CLEARING TIME – [CLEARINGTIME]

Outputs the clearing time by computing difference between a network signal and a state signal related to their respective threshold.

5.3.3.1. CATEGORY

Miscellaneous

5.3.3.2. DESCRIPTION

Outputs the elapsed time between the two following events. The first event is the first positive slope zero crossing of the network signal before the threshold is reached. The threshold is compared to the Windowed RMS computation. The second event is when the state signal exceeds the threshold. Note that this function uses a windowed RMS computation set to a frequency of 60 Hz. The behaviour with a system using a different frequency can be different.

5.3.3.3. RESULT VARIABLES AND PARAMETERS

Result: Clearing time [s]

Signal: Network signal input

Threshold: Network signal value threshold (RMS Value)

State Signal: State signal input

Threshold: State signal threshold

5.3.3.4. SYNTAX

Clearing_Time=clearingtime(Input_Network,Threshold_Network,Input_State,Threshold_State)

5.3.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.3.6. EXAMPLE

<219″>5.3.4. CROSSING TIME – [CROSST]

Output the time at which the signal cross the threshold depending on direction and slope parameter.

5.3.4.1. CATEGORY

Miscellaneous

5.3.4.2. DESCRIPTION

The function outputs time value at which the signal cross the threshold depending on direction and slope parameter. The scope of the search is limited to the window formed by Begin_Time and End_Time. Using HUGE for the End_Time will set the parameter to match the end of acquisition. If there is no match, the graphic will be empty.

Direction : Forward will search the threshold value from Begin_Time toward End_Time. Backward will do the opposite.

Slope : Using Positive Slope will search the threshold when the slope increase in function of time while Negative will search it when the slope decrease in function of time.

5.3.4.3. RESULT VARIABLES AND PARAMETERS

Result: Time at which the signal cross the threshold in function of the parameters

Signal: Input signal

Threshold: Reference value to which the signal is compared

Begin Time: Beginning time of the function

End Time: Ending time of the function

Direction : Direction for the search (1: Forward, 0 : Backward)

Slope : Type of slope (1: Positive, 0 : Negative)

5.3.4.4. SYNTAX

Result = crosst(Input,Threshold,T_Beg,T_End,Direction,Slope)

5.3.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.4.6. EXAMPLE

Threshold = 0, T_Beg = 0, T_End = Huge

<220″>5.3.5. ENERGY – [POWER]

Outputs the energy corresponding to an input voltage and current

5.3.5.1. CATEGORY

Miscellaneous

5.3.5.2. DESCRIPTION

Outputs the energy corresponding to an input voltage Signal_V and current Signal_I. The energy is given by:

5.3.5.3. RESULT VARIABLES AND PARAMETERS

Result: Energy (W.s / J)

Signal_V: Input voltage

Signal_I: Input current

5.3.5.4. SYNTAX

res=energy(Signal_V,Signal_I)

5.3.5.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.5.6. EXAMPLE

<221″>5.3.6. ENVELOPE – [ENV]

Outputs the upper, lower or absolute envelope of a set of three input signals

5.3.6.1. CATEGORY

Miscellaneous

5.3.6.2. DESCRIPTION

Outputs the upper (hi), lower (lo) or absolute (abs) envelope of a set of three input signals given by:

, for the upper envelope

, for the lower envelope

, for the absolute envelope

5.3.6.3. RESULT VARIABLES AND PARAMETERS

Result: Upper lower or absolute envelope

Signal1: input1

Signal2: input1

Signal3: input1

envtype: Type of the envelope, lower (lo), upper (hi), absolute (abs).

5.3.6.4. SYNTAX

res = env(Signal1,Signal2,Signal3,envtype)

5.3.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.6.6. EXAMPLE

<222″>5.3.7. PEAK OF ENVELOP – [ENVPEAK]

Outputs the peak value of the input (peak of envelope). The function displays output only if the next sample of the input is greater than or equal to previous peak identified.

5.3.7.1. CATEGORY

Miscellaneous

5.3.7.2. DESCRIPTION

Outputs the peak value of the input (peak of envelope). The function displays output only if the next sample of the input is greater than or equal to previous peak identified.

5.3.7.3. RESULT VARIABLES AND PARAMETERS

Result: Peak value of the input

Signal: Input

5.3.7.4. SYNTAX

res=envpeak(input)

5.3.7.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.7.6. EXAMPLE

Consider a sinusoidal signal with a periodicity of 16.67 ms (60 Hz) as input. Over a duration of 0.1 second, there will be 6 peaks. The function will have exactly 7 output points corresponding to 6 peaks and one for the first sample. That is because the function will detect only a positive peak and display only if the detected peak is either greater or equal to the previous peak value.

In the below example, though the output seems to be continuous, it is only because an inherent linear interpolation algorithm is used between two successive peaks. For the same reason, there is no output graph visible after the last peak (around 0.095 second).

<223″>5.3.8. ENVELOPE PHASE–PHASE – [ENVPP]

Outputs the envelope of the phase-to-phase differences of a 3-phase signal

5.3.8.1. CATEGORY

Miscellaneous

5.3.8.2. DESCRIPTION

Outputs the upper (hi), lower (lo) or absolute (abs) of the phase-to-phase differences of a 3-phase signal:

,

for the upper envelope

,

for the lower envelope

,

for the absolute envelope

5.3.8.3. RESULT VARIABLES AND PARAMETERS

Result: Upper lower or absolute phase-to-phase envelope

Signal1: Phase1

Signal2: Phase2

Signal3: Phase3

envtype: Type of the envelope, lower (lo), upper (hi), absolute (abs).

5.3.8.4. SYNTAX

res = envpp(Signal1,Signal2,Signal3,envtype)

5.3.8.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.8.6. EXAMPLE

<224″>5.3.9. PRODUCT OF TIME STEP AND SQUARE OF THE INPUT – [I2T]

Outputs the product of the simulation time step and square of the input signal.

5.3.9.1. CATEGORY

Miscellaneous

5.3.9.2. DESCRIPTION

Outputs the product of simulation time step and square of the input signal.

5.3.9.3. RESULT VARIABLES AND PARAMETERS

Result: Product

Signal: Input

5.3.9.4. SYNTAX

res = i2t(input)

5.3.9.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.9.6. EXAMPLE

<225″>5.3.10. INSTANTANEOUS POWER – [POWER]

Outputs the instantaneous power of an input voltage and current

5.3.10.1. CATEGORY

Miscellaneous

5.3.10.2. DESCRIPTION

Outputs the instantaneous power of an input voltage Signal_V and current Signal_I. The instantaneous power is given by:

5.3.10.3. RESULT VARIABLES AND PARAMETERS

Result: Instantaneous_Power (W)

Signal_V: Input voltage

Signal_I: Input current

5.3.10.4. SYNTAX

res=power(Signal_V,Signal_I)

5.3.10.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.10.6. EXAMPLE

<226″>5.3.11. LENGTH – [LENGTH]

Outputs the number of samples of the input signal

5.3.11.1. CATEGORY

Miscellaneous

5.3.11.2. DESCRIPTION

Outputs the number of samples of the input signal

5.3.11.3. RESULT VARIABLES AND PARAMETERS

Result: Number of samples

Signal: Input

5.3.11.4. SYNTAX

res=length(Signal)

5.3.11.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.11.6. EXAMPLE

<227″>5.3.12. LIMIT – [LIM]

Outputs the input signal over a given range

5.3.12.1. CATEGORY

Miscellaneous

5.3.12.2. DESCRIPTION

Outputs the input signal Signal over a range given by Left_Boundary and Right_Boundary

5.3.12.3. RESULT VARIABLES AND PARAMETERS

Result: Signal in the range [Left_Boundary, Right_Boundary]

Signal: Input

Left_Boundary: Left boundary of the output range

Right_Boundary: Right boundary of the output range

5.3.12.4. SYNTAX

res=lim(Signal,Left_Boundary,Right_Boundary)

5.3.12.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.12.6. EXAMPLE

<228″>5.3.13. MAXIMUM FINITE VALUE – [MAXF]

Outputs the maximum finite value of the input signal

5.3.13.1. CATEGORY

Miscellaneous

5.3.13.2. DESCRIPTION

Outputs the maximum finite value of the input signal

5.3.13.3. RESULT VARIABLES AND PARAMETERS

Result: maximum finite value of the input signal

Signal: Input

5.3.13.4. SYNTAX

res=maxf(Signal)

5.3.13.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.13.6. EXAMPLE

<229″>5.3.14. MINIMUM FINITE VALUE – [MINF]

Outputs the minimum finite value of the input signal

5.3.14.1. CATEGORY

Miscellaneous

5.3.14.2. DESCRIPTION

Outputs the minimum finite value of the input signal

5.3.14.3. RESULT VARIABLES AND PARAMETERS

Result: minimum finite value of the input signal

Signal: Input

5.3.14.4. SYNTAX

res=minf(Signal)

5.3.14.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.14.6. EXAMPLE

<230″>5.3.15. MODAL ANALYSIS – [AMOD]

This functions output modal analysis of a single input signal.

5.3.15.1. CATEGORY

Miscellaneous

5.3.15.2. DESCRIPTION

The modal analysis returns the dynamic parameters containing the amplitude, damping, frequency, phase shift and damping ratio of each complex mode identified in the input signal by processing it through an ERA/Prony algorithm method.

To return the modal analysis results, the analyzed input signal is presumed as the impulse-response of a black-box dynamic state-space system. The system identification of this dynamic system is obtained by applying the Eigensystem realization algorithm (ERA) based on Hankel matrices, singular value decomposition and Markov parameters calculation to the input signal. From this system identification, the Prony approach algorithm is then applied to obtain the dynamic parameters based on the system’s equation and residual terms calculation.

5.3.15.3. RESULT VARIABLES AND PARAMETERS

Model Reconstructed Signal: Input signal reconstructed with the dynamic parameters from the k complex mode identified in the analysis

Amplitude: Modal amplitude [ak]

Damping: Modal damping value [σk]

Frequency: Modal frequency [fk]

Phase: Phase shift [ϴk]

Damping Ratio: Modal relative damping ratio [ζk]

Signal: Input signal to be analyzed

Low Frequency: Low frequency limit for oscillatory modes for the input signal. This limit must be set so there is at least a complete period in the window selected for analysis.

It must respect the following :

High Frequency: High frequency limit for oscillatory modes for the input signal. It must be define in a way so undersampling is avoided :

Amplitude Limit: Proportional maximum between the highest and lowest amplitudes of oscillatory mode displayed.

Damping Ratio Limit: Minimum relative damping of oscillatory modes displayed.

Trigger Time: Time at which the analysis begin. It must be determined in a way that at least a period of Low Frequency is observable. The starting time will be floored to the first sample available.

Model Order: Number of elements kept for the minimal realization of ERA.

0: Model order is automatically set with the singular values decomposition evaluation of the Hankel matrix.

Greater than 0: Model order is manually set to this value. However if the chosen order is greater than the maximal order permitted for the computation of Hankel matrix, the order will be set automatically.

Filtering Mode (optional) [On =1 , Off = 0]: Define if bandpass filter is applied or not. Low and High Frequency parameters will define the cutoff frequencies.

5.3.15.4. SYNTAX

[Reconstructed_Signal,Amplitude,Damping,Frequency,Phase,Damping_Ratio]=amod(sig,Low_Freq,High_Freq,Amp_Lim,Damp_R_Lim,Trig,8,0)

Note that 8 is the Order and 0 is the filter. Since these only accept integer value, parameters cannot be set by variable.

5.3.15.5. CHARACTERISTICS

Data type support

Double Floating point

Integer for Model Order and Filtering Mode

5.3.15.6. EXAMPLE

For this example, a simple signal is constructed with ScopeView

<231″>5.3.16. OPERATION TIME – [OPTIME]

Returns up to 6 time values crossing the threshold in function of the direction selection.

5.3.16.1. CATEGORY

Miscellaneous

5.3.16.2. DESCRIPTION

Returns up to 6 time values crossing the threshold in function of the direction selection. Note that “auto” selection in Direction will select “rising” if the signal at t=0 is lower than the threshold and “falling” if the signal is higher than the threshold.

5.3.16.3. RESULT VARIABLES AND PARAMETERS

Result:

op_t1: Output time 1

op_t2: Output time 2

op_t3: Output time 3

op_t4: Output time 4

op_t5: Output time 5

op_t6: Output time 6

Parameters:

Signal: Input signal

Threshold: Threshold used to compare the input signal and return the output time

Direction: [“auto”] : If input(0) >= Threshold, Direction = “falling”. If input(0) < Threshold, Direction = “rising”

[“rising”] : Output time will be the first six rising edge that cross the threshold

[“falling”] : Output time will be the first six falling edge that cross the threshold

[“both”] : Output time will be the first six rising and falling edge that cross the threshold

Reference Time: The output time is represented by the crossing time shifted by the reference time. If the first crossing occurs at t=1.0 and Reference Time = 0.25, op_t1 will be 0.75.

5.3.16.4. SYNTAX

[op_t1,op_t2,op_t3,op_t4,op_t5,op_t6]=optime(Input,Threshold,”both”,Time_Shift)

5.3.16.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.16.6. EXAMPLE

Where Threshold = 0.5 and Time_Shift = 0

<232″>5.3.17. PERIOD – [PERIOD]

Outputs sample period used for data acquisition.

5.3.17.1. CATEGORY

Miscellaneous

5.3.17.2. DESCRIPTION

Outputs sample period used for data acquisition of the selected input in microseconds.

5.3.17.3. RESULT VARIABLES AND PARAMETERS

Result: Sample period [µs]

Signal: Input

5.3.17.4. SYNTAX

res=period(input)

5.3.17.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.17.6. EXAMPLE

A sine wave was acquired with a sampling rate of 10000 Hz. The period corresponding to acquisition is 100 µs.

<233″>5.3.18. RAMP – [RAMP]

Outputs a ramp function

5.3.18.1. CATEGORY

Miscellaneous

5.3.18.2. DESCRIPTION

Outputs a ramp function between between x_begin and x_end with period Period, slope Slope and ordinate at x_begin y0.

5.3.18.3. RESULT VARIABLES AND PARAMETERS

Result: Sampling rate [Hz]

Signal: Input

5.3.18.4. SYNTAX

res=rate(input)

5.3.18.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.18.6. EXAMPLE

<234″>5.3.19. RATE – [RATE]

Outputs the acquisition sampling rate.

5.3.19.1. CATEGORY

Miscellaneous

5.3.19.2. DESCRIPTION

Outputs the acquisition sampling rate of the selected input in Hertz [Hz]. This is same value as the one defined in ScopeView Acquisition Parameters.

5.3.19.3. RESULT VARIABLES AND PARAMETERS

Result: Sampling rate [Hz]

Signal: Input

5.3.19.4. SYNTAX

res=rate(input)

5.3.19.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.19.6. EXAMPLE

A sine wave acquired at a sampling frequency of 10000 Hz is shown below.

<235″>5.3.20. THRESHOLD TIME – [THRESHOLDTIME]

Outputs the time where the input signal value pass a given threshold

5.3.20.1. CATEGORY

Miscellaneous

5.3.20.2. DESCRIPTION

Outputs the time where the input signal value pass a given threshold Threshold, with an optional additional delay Delay

5.3.20.3. RESULT VARIABLES AND PARAMETERS

Result: Threshold time

Signal: Input

Threshold: threshold value

Delay: Optional delay value

5.3.20.4. SYNTAX

res= thresholdtime(Signal,Threshold,Delay)

5.3.20.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.20.6. EXAMPLE

<236″>5.3.21. VERSUS – [VS]

Outputs one signal vs another signal

5.3.21.1. CATEGORY

Miscellaneous

5.3.21.2. DESCRIPTION

Outputs one signal vs another signal

5.3.21.3. RESULT VARIABLES AND PARAMETERS

Signal X: abscissa signal

Signal Y: ordinate signal

5.3.21.4. SYNTAX

res= versus(input1,input2)

res = input1 vs input2

5.3.21.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.21.6. EXAMPLE

<237″>5.3.22. FIRST – [XFIRST]

Outputs the sampling time of the first data in the acquisition buffer.

5.3.22.1. CATEGORY

Miscellaneous

5.3.22.2. DESCRIPTION

Outputs the sampling time of the first data of the input stored in the acquisition buffer in seconds [s].

5.3.22.3. RESULT VARIABLES AND PARAMETERS

Result: Sampling time of the first data [s]

Signal: Input

5.3.22.4. SYNTAX

res = xfirst(input)

5.3.22.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.22.6. EXAMPLE

In the below example, acquisition is started exactly at the same time as the trigger condition (without time offset). Sampling time of the first data is then 0 second.

<238″>5.3.23. LAST – [XLAST]

Outputs the sampling time of the last data in the acquisition buffer.

5.3.23.1. CATEGORY

Miscellaneous

5.3.23.2. DESCRIPTION

Outputs the sampling time of the last data of the input stored in the acquisition buffer in seconds [s].

5.3.23.3. RESULT VARIABLES AND PARAMETERS

Result: Sampling time of the last data [s]

Signal: Input

5.3.23.4. SYNTAX

res = xlast(input)

5.3.23.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.23.6. EXAMPLE

In the below example, acquisition is started exactly at the same time as the trigger condition (without time offset) and the acquisition time length is 0.1 second. Sampling time of the last data is then 0.1 second.

<239″>5.3.24. X SHIFT – [XSHIFT]

Outputs the input signal with a time shift.

5.3.24.1. CATEGORY

Miscellaneous

5.3.24.2. DESCRIPTION

Outputs the input signal (Signal) with a time shift (Time_Shift_Length)

5.3.24.3. RESULT VARIABLES AND PARAMETERS

Signal: input signal

Time_Shift_Lenght: length of the time shift in seconds

5.3.24.4. SYNTAX

res = xshift(input,1/60)

5.3.24.5. CHARACTERISTICS

Data type supportDouble Floating point

5.3.24.6. EXAMPLE

<240″>5.4. STATISTICAL

<241″>5.4.1. CUMULATIVE PROBABILITY – [CUMPROB]

Outputs the cummulative distribution function of a signal

5.4.1.1. CATEGORY

Statistical

5.4.1.2. DESCRIPTION

Outputs the cummulative distribution function of a signal. The cummulative distribution evaluated at represents the probability that a random variable following the signal density function takes on a value less than or equal to and is given by:

5.4.1.3. RESULT VARIABLES AND PARAMETERS

Result: Cumulative distribution function

Signal: Input

Nclasses = number of cumulative probability samples evenly distributed

5.4.1.4. SYNTAX

res=cumprob(input, Nclasses)

5.4.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.1.6. EXAMPLE

<242″>5.4.2. GAUSSIAN DISTRIBUTION – [GAUSS]

Outputs a gaussian distribution

5.4.2.1. CATEGORY

Statistical

5.4.2.2. DESCRIPTION

Outputs a gaussian distribution of mean “Average”, standard deviation “Standard_Deviation” in the range [x1, x2]. “Num_data” samples evenly distributed over the interval [x1, x2] are generated.

5.4.2.3. RESULT VARIABLES AND PARAMETERS

Result: Gaussian distribution

Average: mean of the Gaussian distribution

Standard_deviation: standard deviation of the Gaussian distribution

x1: lower interval boundary

x2: upper interval boundary

Num_Data= number of samples evenly distributed over [x1, x2] to generate

5.4.2.4. SYNTAX

res=gauss(Average,Standard_Deviation,x1,x2,Num_Data)

5.4.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.2.6. EXAMPLE

<243″>5.4.3. MEAN DEVIATION – [MEANDEV]

Outputs the mean deviation of the input.

5.4.3.1. CATEGORY

Statistical

5.4.3.2. DESCRIPTION

Outputs the mean deviation of the input which is given by:

where is the mean value of the signal, N the number of samples and the -th value of the signal

5.4.3.3. RESULT VARIABLES AND PARAMETERS

Result: Mean deviation

Signal: Input

5.4.3.4. SYNTAX

res=meandev(input)

5.4.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.3.6. EXAMPLE

<244″>5.4.4. P VALUE – [PVALUE]

Outputs the p-value of a given signal

5.4.4.1. CATEGORY

Statistical

5.4.4.2. DESCRIPTION

Outputs the p-value of a given signal (Signal) for given probability (percentage) were the p-value is defined by the value that has “percentage” chance of being exeeded given the density function defined by the input signal (computed using the cumulative probability of the density function defined by the input signal).

5.4.4.3. RESULT VARIABLES AND PARAMETERS

Result: p-value

Signal: Input

Nclasses = number of samples evenly distributed used to compute the cumulative probability

percentage: percentage at which the p-value must be computed

5.4.4.4. SYNTAX

res=pvalue(Signal,Nclasses,percentage)

5.4.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.4.6. EXAMPLE

<245″>5.4.5. STANDARD DEVIATION – [STDDEV]

Outputs the standard deviation of input.

5.4.5.1. CATEGORY

Statistical

5.4.5.2. DESCRIPTION

Outputs the standard deviation of input.

5.4.5.3. RESULT VARIABLES AND PARAMETERS

Result: Standard deviation

Signal: Input

5.4.5.4. SYNTAX

res=stddev(input)

5.4.5.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.5.6. EXAMPLE

<246″>5.4.6. STATISTICAL FREQUENCY – [STATFREQ]

Outputs the number of values occurences of a signal

5.4.6.1. CATEGORY

Statistical

5.4.6.2. DESCRIPTION

Outputs the absolute number of values occurences of a signal. It can be seen as the histogram of the values taken by the inputs where the bin size is given by the difference between the maximum and the minimum value of the signal divided by “Nclasses”.

5.4.6.3. RESULT VARIABLES AND PARAMETERS

Result: Statistical frequency

Signal: Input

Nclasses = number of samples evenly distributed used to compute the statistical frequency

5.4.6.4. SYNTAX

res= statfreq(Signal,Nclasses)

5.4.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.4.6.6. EXAMPLE

<247″>5.5. HARMONIC ANALYSIS

<248″>5.5.1. FAST FOURIER TRANSFORM – [FFT]

Outputs the magnitude and the angle for the Fourier series coefficients of selected signal.

5.5.1.1. CATEGORY

Harmonic Analysis

5.5.1.2. DESCRIPTION

Outputs the magnitude and the angle for the Fourier series coefficients of the selected signal.

5.5.1.3. RESULT VARIABLES AND PARAMETERS

Magnitude: Magnitude of the Fourier series coefficients at a given frequency.

Phase angle: Angle of the Fourier series coefficients at a given frequency.

Signal: Input

5.5.1.4. SYNTAX

[m,p]=fft(input)

5.5.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.1.6. EXAMPLE

<249″>5.5.2. FUNDAMENTAL FREQUENCY – [FFREQ]

Outputs the fundamental frequency of selected signal.

5.5.2.1. CATEGORY

Harmonic Analysis

5.5.2.2. DESCRIPTION

Outputs the fundamental frequency of selected signal using least-squares method.

5.5.2.3. RESULT VARIABLES AND PARAMETERS

Result: Fundamental frequency value of the input.

Signal: Input

Approx_Frequency: Search for fundamental frequency using this value as a center point. (optional)

5.5.2.4. SYNTAX

res=ffreq(input)

res=ffreq(input, approx_freq)

5.5.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.2.6. EXAMPLE

<250″>5.5.3. FUNDAMENTAL FREQUENCY SIGNAL – [FFREQS]

Outputs the fundamental frequency of selected signal evaluated at each data points.

5.5.3.1. CATEGORY

Harmonic Analysis

5.5.3.2. DESCRIPTION

Outputs the fundamental frequency of selected signal using an interval around each points.

5.5.3.3. RESULT VARIABLES AND PARAMETERS

Result: Fundamental frequency value at each points of the input signal.

Signal: Input

Num_Cycles: Width factor of the window use to evaluate each fundamentals frequencies. (optional, default=1)

Use_Same_approx_Frequency: Use the same Approx._Frequency for each interval of approximation. If false, use the frequency from the previous interval. (optional, default=true)

Approx_Frequency: Search for fundamental frequency around this value (optional, default=Bloc frequency)

5.5.3.4. SYNTAX

res=ffreqs(input, num_cycles, use_same_approx_freq, approx_freq)

5.5.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.3.6. EXAMPLE

<251″>5.5.4. HARMONIC – HARM

Outputs the module and phase of all selected harmonics over the entire signal.

5.5.4.1. CATEGORY

Harmonic Analysis

5.5.4.2. DESCRIPTION

Outputs the module and phase of all selected harmonics over the entire signal.

5.5.4.3. RESULT VARIABLES AND PARAMETERS

Module: Module of each selected harmonics.

Phase: Phase of each selected harmonics.

Signal: Input

Harmonic_List: List of harmonic to look at.

Fundamental_Frequency: Value used has the fundamental frequency.

Fundamental_Frequency: Exact: use the provided value. Approximate: search for fundamental frequency around this value.

5.5.4.4. SYNTAX

[hm,hp]=harm(input, harmonic_list, fundamental_frequency, fundamental_frequency_approx)

5.5.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.4.6. EXAMPLE

<252″>5.5.5. HARMONIC MODULE – [HMOD]

Outputs the module of the selected harmonic over time.

5.5.5.1. CATEGORY

Harmonic Analysis

5.5.5.2. DESCRIPTION

Outputs the module of the selected harmonic over time.

5.5.5.3. RESULT VARIABLES AND PARAMETERS

Result: Module of the selected harmonics over time.

Signal: Input

Harmonic_number: The harmonic number.

Fundamental_Frequency: Value used has the fundamental frequency.

5.5.5.4. SYNTAX

res=hmod(input, harmonic_number, fundamental_frequency)

5.5.5.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.5.6. EXAMPLE

<253″>5.5.6. HARMONIC PHASE – [HPHA]

Outputs the module of the selected harmonic over time.

5.5.6.1. CATEGORY

Harmonic Analysis

5.5.6.2. DESCRIPTION

Outputs the phase of the selected harmonic over time.

5.5.6.3. RESULT VARIABLES AND PARAMETERS

Result: Phase of the selected harmonics over time.

Signal: Input

Harmonic_number: The harmonic number.

Fundamental_Frequency: Value used has the fundamental frequency.

5.5.6.4. SYNTAX

res=hpha(input, harmonic_number, fundamental_frequency)

5.5.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.6.6. EXAMPLE

<254″>5.5.7. SEQUENCE IMPEDANCE – [ZSEQ]

Compute the sequence impedance matrix in function of the phase impedance matrix. The input and output are represented by phasors.

5.5.7.1. CATEGORY

Harmonic_Analysis

5.5.7.2. DESCRIPTION

Output the sequence impendance matrix in function of an phase impedance matrix. The following equations are used to calculate the impedences:

5.5.7.3. RESULT VARIABLES AND PARAMETERS

Results:

Z00_mag : Magnitude of the Z00

Z01_mag : Magnitude of the Z01

Z02_mag : Magnitude of the Z02

Z10_mag : Magnitude of the Z10

Z11_mag : Magnitude of the Z11

Z12_mag : Magnitude of the Z12

Z20_mag : Magnitude of the Z20

Z21_mag : Magnitude of the Z21

Z22_mag : Magnitude of the Z22

Z00_ang : Angle of the Z00 (in degrees)

Z01_ang : Angle of the Z01 (in degrees)

Z02_ang : Angle of the Z02 (in degrees)

Z10_ang : Angle of the Z10 (in degrees)

Z11_ang : Angle of the Z11 (in degrees)

Z12_ang : Angle of the Z12 (in degrees)

Z20_ang : Angle of the Z20 (in degrees)

Z21_ang : Angle of the Z21 (in degrees)

Z22_ang : Angle of the Z22 (in degrees)

Signals:

Zaa_mag : Magnitude of the Zaa

Zab_mag : Magnitude of the Zab

Zac_mag : Magnitude of the Zac

Zba_mag : Magnitude of the Zba (not required)

Zbb_mag : Magnitude of the Zbb

Zbc_mag : Magnitude of the Zbc

Zca_mag : Magnitude of the Zca (not required)

Zcb_mag : Magnitude of the Zcb (not required)

Zca_mag : Magnitude of the Zcc

Zaa_ang : Angle of the Zaa (in degrees)

Zab_ang : Angle of the Zab (in degrees)

Zac_ang : Angle of the Zac (in degrees)

Zba_ang : Angle of the Zba (in degrees) (not required)

Zbb_ang : Angle of the Zbb (in degrees)

Zbc_ang : Angle of the Zbc (in degrees)

Zca_ang : Angle of the Zca (in degrees)

Zcb_ang : Angle of the Zcb (in degrees) (not required)

Zcc_ang : Angle of the Zcc (in degrees) (not required)

5.5.7.4. SYNTAX

[Z00_mag, Z01_mag, Z02_mag, Z10_mag, Z11_mag, Z12_mag, Z20_mag, Z21_mag, Z22_mag, Z00_ang, Z01_ang, Z02_ang, Z10_ang, Z11_ang, Z12_ang, Z20_ang, Z21_ang, Z22_ang]=zseq( Zaa_mag, Zab_mag, Zac_mag, Zba_mag, Zbb_mag, Zbc_mag, Zca_mag, Zcb_mag, Zcc_mag, Zaa_ang, Zab_ang, Zac_ang, Zba_ang, Zbb_ang, Zbc_ang, Zca_ang, Zcb_ang, Zcc_ang)

5.5.7.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.7.6. EXAMPLE

For this example, a phase impedance matrix is created and the sequence impedance will be computed by zseq function.

This matrix is imported through ScopeView:

Using the zseq function and putting the result in a table:

Which correspond to this matrix:

<255″>5.5.8. SYMMETRICAL COMPONENT MODULE – [SYHMOD]

Extract the magnitude of the phasor component from the three input signal.

5.5.8.1. CATEGORY

Harmonic Analysis

5.5.8.2. DESCRIPTION

Extract the magnitude of the phasor component from the three input signal.

5.5.8.3. RESULT VARIABLES AND PARAMETERS

Result: Module of the phasor component.

Harmonic_number: The harmonic number.

Fundamental_Frequency: Value used has the fundamental frequency.

Signal_A: Input_1

Signal_B: Input_2

Signal_C: Input_3

5.5.8.4. SYNTAX

res=syhmod(harmonic_number, fundamental_frequency, input_1, input_2, input_3)

5.5.8.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.8.6. EXAMPLE

<256″>5.5.9. SYMMETRICAL COMPONENT PHASE – [SYPHA]

Extract the phase of the phasor component from the three input signal.

5.5.9.1. CATEGORY

Harmonic Analysis

5.5.9.2. DESCRIPTION

Extract the phase of the phasor component from the three input signal.

5.5.9.3. RESULT VARIABLES AND PARAMETERS

Result: Phase of the phasor component.

Harmonic_number: The harmonic number.

Fundamental_Frequency: Value used has the fundamental frequency.

Signal_A: Input_1

Signal_B: Input_2

Signal_C: Input_3

5.5.9.4. SYNTAX

res=syhpha(harmonic_number, fundamental_frequency, input_1, input_2, input_3)

5.5.9.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.9.6. EXAMPLE

<257″>5.5.10. TOTAL HARMONIC DISTORTION – [THD]

Output the total harmonic distortion of the input signal.

5.5.10.1. CATEGORY

Harmonic Analysis

5.5.10.2. DESCRIPTION

Output the total harmonic distortion of the input signal:

5.5.10.3. RESULT VARIABLES AND PARAMETERS

Thd%: Total harmonic distortion value in percent.

Thd_db: Total harmonic distortion value in db.

Signal: Input

Num_Harmonics: Number of harmonic use to calculate the THD.

Freq: Value used has the fundamental frequency.

5.5.10.4. SYNTAX

[thd_perc,thd_db] = thd(input,num_harmonics,freq)

5.5.10.5. CHARACTERISTICS

Data type supportDouble Floating point

5.5.10.6. EXAMPLE

<258″>5.6. APPROXIMATION

<259″>5.6.1. LINEAR INTERPOLATION – [INTERPL]

Outputs the input signal’s linear interpolation

5.6.1.1. CATEGORY

Miscellaneous

5.6.1.2. DESCRIPTION

Outputs the input signal linear interpolation with a given sampling time (Time_Period)

5.6.1.3. RESULT VARIABLES AND PARAMETERS

Signal: input signal

Time_Period: output sampling time

5.6.1.4. SYNTAX

res= interpl(input,0.0001)

5.6.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.6.1.6. EXAMPLE

<260″>5.7. SPECTRAL ANALYSIS

<261″>5.7.1. TYPE OF WINDOWS FOR THE FOLLOWING FUNCTIONS:

5.7.1.1. RECTANGULAR

A rectangular window will have the signals value inside the window and zero outside the window.

5.7.1.2. HANNING

The Hann window is defined by :

5.7.1.3. HAMMING

The Hamming window is defined by :

5.7.1.4. BLACKMAN

The Blackman window is defined by :

<262″>5.7.2. CROSS SPECTRAL DENSITY – [CROSPEC]

Outputs the cross-spectral density of two signals.

5.7.2.1. CATEGORY

Spectral analysis

5.7.2.2. DESCRIPTION

Outputs the cross-spectral density by doing a Fast fourier transform on both signals and returning cross-spectral densigy.

5.7.2.3. RESULT VARIABLES AND PARAMETERS

Magnitude (m): Cross-spectral density magnitude

Phase_Angle (a): Cross-spectral density phase

Signal_X: First signal to use for the cross-spectral density

Signal_Y: Second signal to use for the cross-spectral density

Window: Type of windowing applied to the analyzed samples. Refer to the beginning of Spectral analysis category to have a short description. [0: Rectangular,1: Hanning, 2: Hamming, 3: Blackman]

5.7.2.4. SYNTAX

[m,a]=crospec(x,y,2)

5.7.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.7.2.6. EXAMPLE

Here are the results of the cross-spectral density of:

x=sin(pi*2*15*t)

y=sin(pi*2*15*t+90*360/(pi*2)) + sin( pi*2*28*t+90*360/(pi*2))

<263″>5.7.3. FREQUENCY RESPONSE – [REPFREQ]

Outputs the transfer function by comparing two Fast Fourier Transformation signal.

5.7.3.1. CATEGORY

Spectral analysis

5.7.3.2. DESCRIPTION

Outputs the magnitudes and phases of the transfer function. The analysis is based on the Fast Fourier Transform of inputs signals.

5.7.3.3. RESULT VARIABLES AND PARAMETERS

Magnitude (m): Frequency response magnitude

Phase_Angle (a): Frequency response phase

Signal_X: First signal to use for the frequency response analysis

Signal_Y: Second signal to use for the frequency response analysis

Window: Type of windowing applied to the analyzed samples. Refer to the beginning of Spectral analysis category to have a short description. [0: Rectangular,1: Hanning, 2: Hamming, 3: Blackman]

5.7.3.4. SYNTAX

res= statfreq(Signal,Nclasses)

5.7.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.7.3.6. EXAMPLE

<264″>5.7.4. SPECTRAL DENSITY – [DENSP]

Outputs the spectral density of a signal.

5.7.4.1. CATEGORY

Spectral analysis

5.7.4.2. DESCRIPTION

Output the spectral density plot in function of an input signal. Windowing is used for sampling

5.7.4.3. RESULT VARIABLES AND PARAMETERS

Result: Spectral density result

Signal: Input signal

Window: Type of windowing applied to the analyzed samples. Refer to the beginning of Spectral analysis category to have a short description. [0: Rectangular,1: Hanning, 2: Hamming, 3: Blackman]

5.7.4.4. SYNTAX

res=densp(y,2)

5.7.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.7.4.6. EXAMPLE

Spectral analysis of a 15 Hz and 28 Hz sinusoidal sum.

<265″>5.8. SI5

<266″>5.8.1. OVERSHOOT TIME – [SIDSEUIL ]

Computes the period of time during which a threshold value is reached in a signal.

5.8.1.1. CATEGORY

SI5

5.8.1.2. DESCRIPTION

The function compute the period of time and different results related to the overshoot time during which a threshold value is reached in a signal, either on a rising or a falling edge. The function computes the beginning and ending time and duration of the threshold condition.

To perform the analysis, a new signal is generated with the three signals specified as input parameters and following the type of threshold specified.

Rise (m) : the resulting signal is the maximum of the three signals.

Fall (d): the resulting signal is the minimum of the three signals.

When samples do not belong to the signal part specified, values are replaced 0.0.

The user must specify three input signals. However, if only one signal is to be used, then the same name should be given to all three signals. When only one signal is processed, the maximum and minimum samples will result in one identical signal. Similarly, if two signals are to be processed, the third signal to be used can be identical to one of the first two.

5.8.1.3. RESULT VARIABLES AND PARAMETERS

tsed: From the starting time of the analysis, course of the generated signal to find the time at which the threshold value is reached based on the type of threshold specified. The time is returned in milliseconds [ms] and is relative to time 0.

tsef: From the ending time of the analysis, course of the generated signal towards the beginning to find the time at which the threshold value is reached based on the type of threshold specified. The time is returned in milliseconds [ms] and is relative to time 0.

duse: Difference between tsef and tsed in milliseconds [ms]. This result represents the period of time during which the threshold value is reached.

Signal_1: First signal to analyze.

Signal_2: Second signal to analyze.

Signal_3: Third signal to analyze.

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: Value of threshold to be reached on the specified part of the signal.

Slope: Type of threshold to reach: the threshold value can be reached on a rise (m) or a fall (d).

Rise (m): On the resulting signal, the threshold is considered to be reached when the first sample of the analyzed signal exceeds the specified threshold (tsed). From the ending time of the analysis, the threshold is considered to end when the first sample of the analyzed signal exceeds the specified threshold (tsef).

Fall (d): On the resulting signal, the threshold is considered to be reached when the first sample is smaller than the specified threshold (tsed). From the ending time of the analysis, the threshold is considered to end when the first sample of the analyzed signal is smaller than the specified threshold (tsef).

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The multiplying factor applies only to the tsed and tsefresults.It does not apply to the duse result.

5.8.1.4. SYNTAX

[tsed, tsef, duse] = sidseuil(sig1, sig2, sig3, “sig”, threshold, “m”, 0, HUGE, factor)

5.8.1.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.1.6. EXAMPLE

Sidseuil function on a rise:

Sidseuil function on a fall:

The next figure shows the different limit cases of the Sidseuil function.

<267″>5.8.2. FUNDAMENTAL FREQUENCY – [SIFREQ]

Compute the exact fundamental frequency of a signal.

5.8.2.1. CATEGORY

SI5

5.8.2.2. DESCRIPTION

Compute the fundamental frequency of the input signal in Hertz [Hz] using an approximate fundamental frequency and using the Brent method

5.8.2.3. RESULT VARIABLES AND PARAMETERS

Result: Fundamental frequency [Hz]. If the function returns zero as a result, this means that the fundamental frequency was not found, probably because the deviation from the approximate fundamental frequency provided is too large.

Signal: Input signal to perform calculation

Freq_Approx: Approximate and initial fundamental frequency in Hz.

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.2.4. SYNTAX

res = sifreq(input, 60, 0, HUGE, 1)

5.8.2.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.2.6. EXAMPLE

<268″>5.8.3. ABSOLUTE MAXIMUM – [SIMAX1]

Computes the absolute or algebraic maximum on a specific part of a signal.

5.8.3.1. CATEGORY

SI5

5.8.3.2. DESCRIPTION

This function allows to compute the absolute or algebraic maximum on a specific part of a signal. The zone on which the analysis is performed can be specify using time, or using or a threshold condition.

5.8.3.3. RESULT VARIABLES AND PARAMETERS

Algebraic Maximum: Maximum of the input signal multiplied by the factor.

An algebraic or absolute result on an absolute or positive part of a signal does not affect the result. Similarly, the algebraic result on the negative part of a signal is negative, unless the time interval found for the analysis is null.

Absolute Maximum: Absolute maximum of the input signal multiplied by the factor.

Signal: Input signal to perform calculation

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: The threshold, delay, and duration parameters restrict the limits of an analysis. The threshold is the value to reach to start the analysis from the begin_time. If the threshold is positive, the threshold will be reached when the value of the sample is greater than that of the threshold. If the threshold is negative, the threshold will be reached when the value of the sample is smaller than that of the threshold. A null threshold sets the threshold equal to the starting time.

The threshold value must be compatible with the signal part specified. If the positive part of a signal is specified with a negative threshold, this threshold will never be reached.

Delay: When the threshold time is determined, a delay is added to it. The new starting time of the analysis is thus equal to the time taken to reach the threshold plus the delay. The delay is specified in milliseconds [ms].

Duration: The duration parameter serves to determine the ending time of the analysis. This ending time will be equal to the new starting time with the delay plus the specified duration. It is possible to specify HUGE as duration indicating that the ending time will be the end of the analyzed signal. This duration is specified in milliseconds [ms].

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.3.4. SYNTAX

[alg, abs] = simax1(input, “sig”, 0, 0, HUGE, 0, HUGE,1)

5.8.3.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.3.6. EXAMPLE

The following figure shows absolute and algebraic maximum for a sine wave signal.

The following diagram shows the different results computed by this function.

<269″>5.8.4. ABSOLUTE MAXIMUM – [SIMAX2]

Computes the absolute or algebraic maximum of a signal resulting from a mathematical operation between two signals.

5.8.4.1. CATEGORY

SI5

5.8.4.2. DESCRIPTION

This function allows to compute the absolute or algebraic maximum of a signal, or of a part of it, resulting from a mathematical operation between two signals. The zone on which the analysis is performed can be specify using time, or using or a threshold condition.

5.8.4.3. RESULT VARIABLES AND PARAMETERS

Algebraic Maximum: Maximum of the resulting signal multiplied by the factor.

An algebraic or absolute result on an absolute or positive part of a signal does not affect the result. Similarly, the algebraic result on the negative part of a signal is negative, unless the time interval found for the analysis is null.

Absolute Maximum: Absolute maximum of the resulting signal multiplied by the factor.

Signal 1: First input signal to perform the mathematical operation

Signal 2: Second input signal to perform the mathematical operation

Operation: Operation to execute between the two signals to analyze (+, – , *, /)

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: The threshold, delay, and duration parameters restrict the limits of an analysis. The threshold is the value to reach to start the analysis from the begin_time. If the threshold is positive, the threshold will be reached when the value of the sample is greater than that of the threshold. If the threshold is negative, the threshold will be reached when the value of the sample is smaller than that of the threshold. A null threshold sets the threshold equal to the starting time.

The threshold value must be compatible with the signal part specified. If the positive part of a signal is specified with a negative threshold, this threshold will never be reached.

Delay: When the threshold time is determined, a delay is added to it. The new starting time of the analysis is thus equal to the time taken to reach the threshold plus the delay. The delay is specified in milliseconds [ms].

Duration: The duration parameter serves to determine the ending time of the analysis. This ending time will be equal to the new starting time with the delay plus the specified duration. It is possible to specify HUGE as duration indicating that the ending time will be the end of the analyzed signal. This duration is specified in milliseconds [ms].

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.4.4. SYNTAX

[alg_max, abs_max] = simax2(input1, input2, “+”, “sig”, 0.5, 0, HUGE, 0, HUGE, 1)

5.8.4.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.4.6. EXAMPLE

The following figure shows absolute and algebraic maximum for the sum of sine wave signal and a constant value.

The following diagram shows the different results computed by this function.

<270″>5.8.5. PHASE MAXIMUM – [SIMAX3]

Computes the absolute and algebraic maximum on a specific part of a signal of a phase to phase or a phase to neutral voltage or a current.

5.8.5.1. CATEGORY

SI5

5.8.5.2. DESCRIPTION

The function allows to compute the absolute and algebraic maximum on a specific part of a signal of a phase to phase or a phase to neutral voltage or a current.

5.8.5.3. RESULT VARIABLES AND PARAMETERS

Algebraic Maximum: Maximum of the resulting signal multiplied by the factor.

An algebraic or absolute result on an absolute or positive part of a signal does not affect the result. Similarly, the algebraic result on the negative part of a signal is negative, unless the time interval found for the analysis is null.

Absolute Maximum: Absolute maximum of the resulting signal multiplied by the factor.

Signal_1: input signal (phase a).

Signal_2: input signal (phase b).

Signal_3: input signal (phase c).

For simax3, the three signals are kept to the end. It is as if simax1 were applied to the three analyzed signals and the result returned were the maximum of the three maximums identified.

Operation: Operation to execute between the three signals: phase to phase voltage (pp) or phase to neutral (pt). In the case of phase to neutral, the three original signals are considered. For the phase to phase voltages, the difference signals (1 – 2), (2 – 3) and (3 – 1) are considered.

When phase to phase operation is used, three new signals R1, R2 and R3 are internally generated to perform calculation. R1 = Signal_1Signal_2, R2 = Signal_2Signal_3, R3 = Signal_3Signal_1.

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: The threshold, delay, and duration parameters restrict the limits of an analysis. The threshold is the value to reach to start the analysis from the begin_time. If the threshold is positive, the threshold will be reached when the value of the sample is greater than that of the threshold. If the threshold is negative, the threshold will be reached when the value of the sample is smaller than that of the threshold. A null threshold sets the threshold equal to the starting time.

The threshold value must be compatible with the signal part specified. If the positive part of a signal is specified with a negative threshold, this threshold will never be reached.

Delay: When the threshold time is determined, a delay is added to it. The new starting time of the analysis is thus equal to the time taken to reach the threshold plus the delay. The delay is specified in milliseconds [ms].

Duration: The duration parameter serves to determine the ending time of the analysis. This ending time will be equal to the new starting time with the delay plus the specified duration. It is possible to specify HUGE as duration indicating that the ending time will be the end of the analyzed signal. This duration is specified in milliseconds [ms].

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.5.4. SYNTAX

[alg_max, abs_max] = simax3(Va, Vb, Vc, “pp”, “sig”, 0, 0, 0, 0, HUGE, 1)

5.8.5.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.5.6. EXAMPLE

The following figure shows absolute and algebraic maximum for three phase voltages.

The following diagram shows the different results computed by this function.

<271″>5.8.6. HARMONICS – [SIHARMO]

Computes the harmonics of a signal.

5.8.6.1. CATEGORY

SI5

5.8.6.2. DESCRIPTION

The function allows to compute the harmonics of a signal using the exact fundamental frequency. This function computes module (amplitude), angle (phase) and the real and imaginary parts of the harmonics.

5.8.6.3. RESULT VARIABLES AND PARAMETERS

Module (m): Module (or amplitude) for the symmetric components of a harmonic.

Phase (a): Angle a (or phase) of the symmetric component sequence, between -180 and 180 degrees [°].

Phase (a0): Angle of the symmetric component sequence, found between 0 and 360 degrees [°].

Real (r): Real part r of the required symmetric component sequence (m * cos(a)).

Imaginary (i): Imaginary part i of the required symmetric component sequence (m * sin(a)).

Signal: Input signal to perform analysis

Freq: Fundamental frequency of the signal in Hertz [Hz], normally computed with the sifreq function.

Harmonic number: Number of harmonic to compute.

  • 0: DC;
  • 1: Fundamental;
  • 2: 2nd harmonic;
  • n: nth harmonic (max. 30).

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Note : The begin time and end time specified for the calculation of the harmonics must be identical to those used in the sifreq sequences which served to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The module is multiplied by the absolute value of thefactor. Hence, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.

5.8.6.4. SYNTAX

[m, a, a0, r, i] = siharmo(input, freq,n,begin,end,factor)

5.8.6.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.6.6. EXAMPLE

In the following example, the harmonics function compute the third harmonic components of a signal. Module and angle are shown.

<272″>5.8.7. HARMONIC MAXIMUM – [SIMXHART]

Computes the maximum of the amplitudes of a given harmonic.

5.8.7.1. CATEGORY

SI5

5.8.7.2. DESCRIPTION

The function allows to compute the maximum of the amplitudes of a given harmonic in a moving window over a signal. This window is equal to the length of a cycle with respect to the fundamental frequency. This function computes module (amplitude) and angle (phase) for the symmetric components and its real and imaginary components.

If the number of samples to establish the length of a cycle is greater than the number of samples found between the starting and ending times of the sequence, then the length of the window used is equal to the number of samples between the starting and ending times (in other words ending time starting-time).

5.8.7.3. RESULT VARIABLES AND PARAMETERS

Module (m): Maximum of module (or amplitude) for the symmetric components of a harmonic. It is computed for each window moving over the signal, multiplied by the absolute value of the factor.

Phase (a): Angle a (or phase) of the symmetric component sequence associated with the maximum module found. Value is between -180 and 180 degrees [°].

Since the module is multiplied by the absolute value of the factor, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.

Phase (a0): Angle a0 (or phase) of the symmetric component sequence associated with the maximum module found. Value is between 0 and 360 degrees [°].

Real (r): Real part r of the required symmetric component sequence (m * cos(a)).

Imaginary (i): Imaginary part i of the required symmetric component sequence (m * sin(a)).

Signal: Input signal to perform analysis

Freq: Fundamental frequency of the signal in Hertz [Hz], normally compute with the sifreq function. This fundamental frequency in hertz serves to establish the length of time the window moves over the analyzed signal. In fact, this window is equal to one cycle (in number of samples). lfen = rate/ freq [samples].

Harmonic number: Number of harmonic to compute.

  • 0: DC;
  • 1: Fundamental;
  • 2: 2nd harmonic;
  • n: nth harmonic (max. 30).

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Note : The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences used to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.7.4. SYNTAX

[m, a, a0, r, i] = simxhart( input, 60, 1, 0, HUGE, 1)

5.8.7.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.7.6. EXAMPLE

In the following example, the function compute amplitude maximum of the third harmonic components of a signal.

The following diagram shows a window moving over a signal. The method used to compute the length of the window is also described.

<273″>5.8.8. INTEGRAL MAXIMUM – [SIMXSOM1]

Computes the absolute maximum of an integral, a mean or a RMS value on a specific part of a signal and in a window moving.

5.8.8.1. CATEGORY

SI5

5.8.8.2. DESCRIPTION

The function allows to compute the absolute maximum of an integral, a mean or a RMS value on a specific part of a signal and in a window moving over the input signal.

5.8.8.3. RESULT VARIABLES AND PARAMETERS

Algebraic Maximum: Maximum of the input signal, multiplied by the factor.

Absolute Maximum: Absolute maximum of the input signal, multiplied by the factor.

Signal: Input signal to perform analysis

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: Threshold to reach in order to start analyzing the signals. This threshold value must be positive since the absolute value of the sample is compared to it. The samples which do not exceed this threshold are considered as null. If this threshold is null, all the samples are automatically considered.

Operation: Operation to execute on the signal in a window moving over it (int, moy, rms). The maximum of the integrals, means or RMS values are kept.

  • int: integral,
  • moy: mean,
  • rms: rms value.

Window_Length: Time in seconds [s] during which the window moves over the analyzed signal. This time in seconds is reduced to the time of the analysis (end_timebegin_time), if the window time specified is longer than the duration considered for the signal. This window time cannot be null.

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.8.4. SYNTAX

[alg_max, abs_max] = simxsom1( input, “sig”, 0, “int”, 1/60, 0, HUGE, 1 )

5.8.8.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.8.6. EXAMPLE

In the following example, the function compute the absolute maximum of the integral of the sine wave over a moving window.

The following diagram shows the window moving over a signal based on the time specified for the window.

<274″>5.8.9. INTEGRAL MAXIMUM – [SIMXSOM2]

Computes the absolute maximum of an integral, a mean or a RMS value in a window moving over a signal resulting from a mathematical operation.

5.8.9.1. CATEGORY

SI5

5.8.9.2. DESCRIPTION

The function allows to computes the absolute maximum of an integral, a mean or a RMS value in a window moving over a signal resulting from a mathematical operation between specific parts of two initial signals. A reject threshold can be applied to the first signal before the mathematical operation, in other words the reject of the signal samples not reaching this threshold.

5.8.9.3. RESULT VARIABLES AND PARAMETERS

Algebraic Maximum: Maximum of the input signal, multiplied by the factor.

Absolute Maximum: Absolute maximum of the input signal, multiplied by the factor.

Signal 1: First input signal to perform analysis

Signal 2: Second input signal to perform analysis

Threshold: Threshold to reach on the first signal to keep the sample. This threshold value must be positive since the absolute value of the sample is compared to it. The samples which do not exceed this threshold are considered as null. If this threshold is null, all the samples are automatically considered.

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Operation_1: Mathematical operation to execute between the two input signals (+,-,*,/).

Operation_2: Operation to execute on the signal resulting from the mathematical operation in a window moving over it (int, moy, rms). The maximums of the integrals, means or rms values are kept.

  • int: integral
  • moy: mean
  • rms: rms value

Window_Length: Time in seconds [s] during which the window moves over the analyzed signal. This time is reduced to the time of the analysis (ending time – starting time) if the window time specified is longer than the duration considered for the signal. This window time cannot be null.

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.9.4. SYNTAX

[alg_max, abs_max] = simxsom1( input, “sig”, 0, “int”, 1/60, 0, HUGE, 1 )

5.8.9.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.9.6. EXAMPLE

In the following example, the function compute the absolute maximum of the integral of the sum of two sine waves.

The following diagram shows the window moving over a signal based on the time specified for the window.

<275″>5.8.10. DYNAMIC RESPONSE – [SIDYN2]

Computes the dynamic response of a control signal following a disturbance.

5.8.10.1. CATEGORY

SI5

5.8.10.2. DESCRIPTION

The function computes the dynamic response of a control system after a disturbance. This function allows to compute mean, minimum and maximum values and stabilization times.

Note : The order of operations of this function is not as important as for other functions, but it is useful to know.

1- Course of the signal from reference Ref_Time1 to reference Ref_Time2 to find the minimum and maximum of the disturbance.

2- Calculation of the mean on the Interval (moyd) first milliseconds, of the mean on the interval (moyf) last milliseconds and of the mean on the Interval (moyp) milliseconds preceding reference Ref_Time2. These values are returned as the moyd, moyf and moyp results.

3- Calculation of time taken to reach the different threshold values for the stabilization times.

5.8.10.3. RESULT VARIABLES AND PARAMETERS

maxp: Maximum value of the input signal between first and second reference times (Ref_Time1, Ref_Time2).

minp: Minimum value of the input signal between first and second reference times (Ref_Time1, Ref_Time2).

moyd: Mean value before the disturbance. The mean value is computed on the first milliseconds of the analysis, i.e. before the average time start (Avg_Time_Start).

moyf: Mean value after the disturbance. The mean value is computed on the last milliseconds of the analysis, i.e. after the average time end (Avg_Time_End).

moyp: Mean value during the disturbance. The mean value is computed between the average perturbation time (Avg_Time_Pert) and the reference time 2 (Ref_Time2).

tst0: Zeroth stabilization time. Time in milliseconds [ms] relative to the second reference time (Ref_Time2) when the 0 threshold value (Threshold0) is reached after reference time 2 (Ref_Time2).

tst1: First stabilization time. Time in milliseconds [ms] relative to the second reference time (Ref_Time2) when the first threshold value (Threshold1) is reached, minus reference time 2 (Ref_Time2).

tst2: Second stabilization time. Time in milliseconds [ms] relative to the second reference time (Ref_Time2) when the second threshold value (Threshold2) is reached, minus reference time 2 (Ref_Time2).

tst3: Third stabilization time. Time in milliseconds [ms] relative to the second reference time (Ref_Time2) when the third threshold value (Threshold3) is reached, minus reference time 2 (Ref_Time2).

Signal: input signal to analyze.

Threshold0: Threshold used to compute the zero stabilization time. This percentage [%] of the mean before disturbance is added to or subtracted from the mean to latter determine the threshold to reach in order to evaluate the response time. The percentage is subtracted if the mean before disturbance is higher than the mean during the disturbance. When the opposite is true, the mean is added.

Threshold1: Threshold used to compute the first stabilization time. This percentage [%] of the mean before disturbance is added to and then subtracted from the mean before disturbance to yield two threshold values, one on each side of the mean before disturbance. The stabilization time is computed using these two threshold values.

Threshold2: Threshold used to compute the second stabilization time. This percentage [%] of the mean before disturbance is added to and then subtracted from the mean before disturbance to yield 2 threshold values, one on each side of the mean before disturbance. The stabilization time is computed using these two threshold values.

Threshold3: Threshold used to compute the third stabilization time. This percentage [%] of the mean before disturbance is added to and then subtracted from the mean before disturbance to yield 2 threshold values, one on each side of the mean before disturbance. The stabilization time is computed using these two threshold values

Ref_Time1: Time in milliseconds [ms] serving as reference for the beginning of the disturbance. This time is relative to time 0 of the acquisition buffer.

Ref_Time2: Time in milliseconds [ms] serving as reference for the end of the disturbance. This time is relative to time 0 of the acquisition buffer.

Avg_Time_Start: Time interval in milliseconds [ms], at the beginning of the analysis limits, on which is computed the mean value before the disturbance (moyd).

Avg_Time_End: Time interval in milliseconds [ms], at the end of the analysis limits, on which is computed the mean value after the disturbance (moyf)

Avg_Time_Pert: Time interval in milliseconds [ms] ending at reference time (Ref_time2), on which is computed the mean value during the disturbance (moyp).

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The multiplying factor only applies to the following results: tst0, tst1, tst2 and tst3. The other results are not modified.

5.8.10.4. SYNTAX

[maxp, minp, moyd, moyf_1, moyp, tst0, tst1, tst2, tst3] = sidyn2(input, threshold0, threshold1, threshold2, threshold3, time1, time2, time_start, time_end, time_pert, 0, HUGE, 1)

5.8.10.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.10.6. EXAMPLE

The following figure shows the results for a signal whose disturbance voltage is lower than initial voltage.

The following figure shows the results for a signal whose disturbance voltage exceeds the initial voltage.

<276″>5.8.11. ABSOLUTE HARMONIC MAXIMUM – [SIMXSYMT]

Compute the absolute maximum amplitudes of the harmonic components in a window moving over time.

5.8.11.1. CATEGORY

SI5

5.8.11.2. DESCRIPTION

This function allows to compute the absolute maximum amplitudes (modules) for the symmetric components of a harmonic in a window moving over time.

5.8.11.3. RESULT VARIABLES AND PARAMETERS

Module (m): Absolute maximum of module (or amplitude) for the symmetric components of a harmonic. It is computed for each window moving over the signal. The maximum computed is then multiplied by the absolute value of the factor.

Phase (a): Angle a (or phase) of the symmetric component sequence associated with the maximum module found. Value is between -180 and 180 degrees [°].

Since the module is multiplied by the absolute value of the factor, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.

Phase 0-360 (a0): Angle a0 (or phase) of the symmetric component sequence associated with the maximum module found. Value is between 0 and 360 degrees [°].

Real (r): Real part r of the maximum module of the required symmetric component sequence (m * cos(a)).

Imaginary (i): Imaginary part i of the maximum module of the required symmetric component sequence (m * sin(a)).

Signal_A: Symbolic name of first signal to analyze (phase A).

Signal_B: Symbolic name of second signal to analyze (phase B).

Signal_C: Symbolic name of third signal to analyze (phase C).

Freq: Fundamental frequency of the signals in Hertz [Hz], normally computed with the sifreq function. This fundamental frequency in hertz serves to establish the length of time the window moves over the analyzed signal. In fact, this window is equal to one cycle (in number of samples). lfen = rate/ freq [samples].

If the number of samples to establish the length of a cycle is greater than the number of samples found between the begin_time and end_time of the sequence, then the length of the window used is equal to the number of samples between the begin_time and end_time (in other words end_timebegin_time).

Harmonic number: Number of harmonic to compute.

  • 0: DC;
  • 1: Fundamental;
  • 2: 2nd harmonic;
  • n: nth harmonic (max. 30).

Sequence: Sequence of symmetric components to compute.

  • 0: zero sequence
  • 1: positive sequence
  • 2: negative sequence

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the size of the acquisition buffer. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.11.4. SYNTAX

[m, a, a0, r, i] = simxsymt(a, b, c, 60, 1, 1, 0, HUGE,1)

5.8.11.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.11.6. EXAMPLE

In the following example, the function compute the absolute maximum of the positive sequence of the first harmonic.

The following diagram shows the window moving over a signal based on the time specified for the window.

The following figure shows the formulas used to calculate the symmetric components.

<277″>5.8.12. POWER AND IMPEDANCE – [SIPZ]

Compute the power, impedance, addition or subtraction of two signals for a given harmonic.

5.8.12.1. CATEGORY

SI5

5.8.12.2. DESCRIPTION

This function allows to compute the power, impedance, addition or subtraction of two signals for a given harmonic.

5.8.12.3. RESULT VARIABLES AND PARAMETERS

Module (m): Module (or amplitude) resulting from the operation specified for the harmonic multiplied by the absolute value of the factor.

Phase (a): Angle a (or phase) resulting from the operation specified for the harmonic. Value is between -180 and 180 degrees [°].

Since the module is multiplied by the absolute value of the factor, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.

Phase 0-360 (a0): Angle a0 (or phase) resulting from the operation specified for the harmonic. Value is between 0 and 360 degrees [°].

Real (r): Real part r of the module and angle computed (m * cos(a)).

Imaginary (i): Imaginary part i of the module and angle computed (m * cos(a)).

(m * sin(a)).

Signal_1: First signal to analyze (voltage signal).

Factor_1: Multiplying factor to use for all samples of signal 1.

Signal_2: Second signal to analyze (current signal).

Factor_2: Multiplying factor to use for all samples of signal 2.

Freq: Fundamental frequency of the signals in Hertz [Hz], normally computed with the sifreq function.

Harmonic number: Number of harmonic to compute.

  • 0: DC;
  • 1: Fundamental;
  • 2: 2nd harmonic;
  • n: nth harmonic (max. 30).

Operation: Operation to execute on the modules (or amplitudes) and angles of the required harmonic for each input signal. The modules and angles are first computed on the two input signals and then the specified operation is applied to these modules and angles. The defined operators are :

  • p : power;
  • / : impedance;
  • * : multiplication;
  • + : addition;
  • – : subtraction;

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.12.4. SYNTAX

[m, a, a0, r, i] = sipz(a, 1, b, 1, 60, 1, “p”, 0, HUGE, 1)

5.8.12.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.12.6. EXAMPLE

The first diagram shows how to compute the different powers (p): apparent, active and reactive.

The following diagram shows how to compute the different impedances (/): complex, resistance and reactance.

Finally, the next diagram shows the different formulas used with the operations allowed: power (p), impedance (/), addition (+), subtraction (-) and multiplication (*).

<278″>5.8.13. OVERSHOOT STATISTICS – [SISEUIL]

Compute overshoot statistics of a signal using a threshold condition.

5.8.13.1. CATEGORY

SI5

5.8.13.2. DESCRIPTION

This function is used to compute overshoot statistics using a threshold condition. It also generates a logical signal with these overshoot times on the signal studied.

5.8.13.3. RESULT VARIABLES AND PARAMETERS

Moyd: Sample mean computed on the first Time interval (Average Time Length) in milliseconds of the analyzed signal from the start of the signal. Afterwards, the signal overshoots are analyzed from the Starting time.

ttot: Sum of the overshoot times on the threshold value for the signal analyzed. This result is specified in milliseconds [ms].

tmax: Longest overshoot time specified in milliseconds [ms].

ncnt: Number of times when the threshold overshoot duration is longer than the specified Delay ON.

logi: The logical signal has a value of 1 from the start of an overshoot plus the Delay ON value. It remains at 1 until the end of the overshoot plus the specified Delay OFF value. For all other cases, the value of the logical signal is 0. The overshoot times which do not exceed the Delay ON value are not shown in the logical signal.

Threshold (+/-): Difference with the mean of the starting samples to set the threshold value to reach. The threshold value used for overshoot calculations is the threshold difference added to the mean result (the mean of the time interval samples from the start of the study). This difference is expressed in the units of the signals.

Example: Let, the mean moyd = 40.0. If the threshold difference is = 15.0, then the threshold value used is 55.0. If the threshold difference is = -15.0, then the threshold value used is 25.0.

The threshold direction is set by the sign of the threshold. If the difference is negative, then the threshold value is smaller than moyd. Hence, overshoots going towards the bottom part of the graph are looked for, since the start of the study is not considered as an overshoot. This case is shown in first example below. If the difference is positive, then the threshold value is greater than moyd. Hence, overshoots going towards the top part of the graph are looked for, since the start of the study is not considered as an overshoot. This case is shown in the second example.

To be considered as an overshoot, the signal must reach the threshold and return under this threshold within the set limits of the analysis. Thus, if a signal is above a threshold throughout the analysis, then the ncnt, ttot and tmax results will be null.

Average Time Length: Time interval in milliseconds [ms] from time 0 on which the initial mean will be computed and serving to set the threshold. A null value is not valid.

Delay ON: Minimal time during which the overshoot must last in order to be considered as a count. This time is specified in milliseconds [ms].

Delay OFF: Minimal time during which the logical signal generated must stay at 1 following the end of an overshoot. This time is specified in milliseconds [ms].

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The factor applies to the moyd, tmax and ttot results.

5.8.13.4. SYNTAX

[moyd, ttot, tmax, ncnt, logi] = siseuil( input, 0.5, 1.0, 0.5, 0.25, 0, HUGE, 1)

5.8.13.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.13.6. EXAMPLE

The first figure shows a case where the threshold difference is negative.

The second figure shows a case where the threshold difference is positive.

<279″>5.8.14. SYMMETRIC COMPONENTS – [SISYM3]

Compute the symmetric components of three signals for a given harmonic.

5.8.14.1. CATEGORY

SI5

5.8.14.2. DESCRIPTION

This function is used to compute the symmetric components of three signals for a given harmonic. This function computes the module, the phase, and the real and imaginary parts for the symmetric components of a harmonics.

5.8.14.3. RESULT VARIABLES AND PARAMETERS

Module (m): Module (or amplitude) for the symmetric components of a harmonic, multiplied by the absolute value of the factor.

Phase (a): Angle a (or phase) of the symmetric component sequence, between -180 and 180 degrees [°]. Since the module is multiplied by the absolute value of the factor, the phase is modified if the multiplying factor is negative. In this case, 180 degrees are added to the phase.

Phase (a0): Angle of the symmetric component sequence, found between 0 and 360 degrees [°].

Real (r): Real part r of the required symmetric component sequence (m * cos(a)).

Imaginary (i): Imaginary part i of the required symmetric component sequence (m * sin(a)).

Signal_A: First signal to analyze.

Signal_B: Second signal to analyze.

Signal_C: Third signal to analyze.

Freq: Fundamental frequency of the signal in Hertz [Hz], normally computed with the sifreq function.

Harmonic number: Number of harmonic to compute.

  • 0: DC;
  • 1: Fundamental;
  • 2: 2nd harmonic;
  • n: nth harmonic (max. 30).

Sequence: Sequence of symmetric components to compute.

  • 0: zero sequence
  • 1: positive sequence
  • 2: negative sequence

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The factor applies to the moyd, tmax and ttot results.

5.8.14.4. SYNTAX

[m, a, a0, r, i] = sisym3( a, b, c, 60, 1, 1, 0, HUGE, 1 )

5.8.14.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.14.6. EXAMPLE

The following diagram shows the mathematical functions used to compute the symmetric components related to three signals.

<280″>5.8.15. ENVELOPE OVERSHOOT– [SITENV]

Compute the time in milliseconds during which the envelope of a signal overshoots a specific threshold value.

5.8.15.1. CATEGORY

SI5

5.8.15.2. DESCRIPTION

This function allows to compute the time in milliseconds [ms] during which the envelope of a signal overshoots a specific threshold value. This function computes the sum, the longest overshoot time and the signal representing the peak envelope.

The peak envelope is a signal consisting of lines connecting the different peaks of a signal. A peak is a sample such that the signals preceding and following it are smaller than the current sample.

5.8.15.3. RESULT VARIABLES AND PARAMETERS

ttot: Sum of the overshoot times for the signal analyzed. This result is specified in milliseconds [ms].

tmax: Longest overshoot time specified in milliseconds [ms].

envc: Signal representing the peak envelope of the absolute maximum envelope for the three initial signals.

Signal_A: First signal to analyze.

Signal_B: Second signal to analyze.

Signal_C: Third signal to analyze.

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: Value of threshold to reach in order to compute the overshoot times. If the threshold is greater than the value of the first sample of the signal analyzed, then the overshoot occurs towards the top part of the signal, and vice versa.

To be considered as an overshoot, the signal must reach the threshold and return under this threshold within the set limits of the analysis. Thus, if a signal is above a threshold throughout the analysis, then the ttot and tmax results will be null.

Window_Length: Time in seconds [s] during which the window moves over the analyzed signal. This time in seconds is reduced to the time of the analysis (end_time – begin_time), if the window time specified is longer than the duration considered for the signal. This window time cannot be null.

Filtering time: Period of mean setting in milliseconds used to filter the envelope signal from the peaks, if required.

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

The begin_time and end_time specified for the calculation of the harmonics must be the same as those used in the sifreq sequences to compute the fundamental frequency.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results. The factor can only be applied to the ttot and tmax results.

5.8.15.4. SYNTAX

[ttot, tmax, envc] = sitenv( a, b, c, “sig”, 0.5, 0, 0, HUGE, 1)

5.8.15.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.15.6. EXAMPLE

The following figure, shows the different function calculations for a peak envelope signal.

<281″>5.8.16. OPERATING TIME – [SITOP]

Compute the operating time of a relay.

5.8.16.1. CATEGORY

SI5

5.8.16.2. DESCRIPTION

This function allows to compute the operating time of a relay.

5.8.16.3. RESULT VARIABLES AND PARAMETERS

Res: time in milliseconds [ms] for which the threshold value is reached on the signal analyzed, as of the specified begin_time. The returned time is the time relative to the starting time and not relative to time 0.

If the returned result is HUGE, this means that the relay did not operate within the set limits. More specifically, no change of state relative to the threshold value was detected within the limits of the analysis, as compared with the state at the beginning of the analysis.

Signal: Signal to analyze.

Threshold: Threshold to reach on the signal analyzed showing that the relay operated. .

The threshold value is reached when there is a change of state with respect to this value. If the sample was above the threshold at the start of the analysis, then the change of state occurs when the sample read is found to be below the threshold value.

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.16.4. SYNTAX

res = sitop( input, threshold, 0, HUGE, 1)

5.8.16.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.16.6. EXAMPLE

The following figure shows the different cases which can arise when executing the sitop function. These examples can be serve as reference for the cases studied.

<282″>5.8.17. RELATIVE OPERATING TIME – [SITOPREF]

Compute the operating time of a relay relative to the rise or fall of a reference signal.

5.8.17.1. CATEGORY

SI5

5.8.17.2. DESCRIPTION

The function allows to compute the operating time of a relay relative to the rise or fall of a reference signal.

5.8.17.3. RESULT VARIABLES AND PARAMETERS

res: time in milliseconds for which the threshold value is reached on the signal analyzed, as specified by the reference pulse.

  • On a rise (m, c, C), the returned time is relative to the rising time of the reference pulse.
  • On a fall (d, f, F), the returned time is relative to the falling time of the reference pulse.

Signal: Signal to analyze.

Reference signal: Reference signal.

Types (m, d, c, C, f, F): Type of search for the relay operating time, in other words the time when a threshold value is reached. On a rise (m, c, C), the relay must operate between the rise of the reference pulse and its end. On a fall (d, f, F), the relay must operate only after the fall of the reference pulse.

  • For type m, a change of state is searched for relative to the threshold and the initial state starting time between the start and the end of the reference pulse. If the state is the same at the beginning of the pulse, only a change of state is searched for. If however, the state is different at the beginning of the pulse, the initial state and then a change of state are searched for, both between the start and the end of the reference pulse.
  • For type c, a value smaller than the threshold value is searched for, between the start and the end of the reference pulse. If at the beginning of the pulse, the sample is already below the threshold, the search is for a value above the threshold and then for a value below it, before the end of the reference pulse.
  • For type C, a value greater than the threshold value is searched for, between the start and the end of the reference pulse. If at the beginning of the pulse, the threshold is already overshot, the search is for a value below the threshold and then for a value above it, before the end of the reference pulse.
  • For type f, a value smaller than the threshold value is searched for, between the end of the reference pulse and the ending time. If at the end of the pulse, the sample is already below the threshold, the search is for a value above the threshold and then for a value below it, before the end of the analysis limits.
  • For type F, a value greater than the threshold value is searched for, between the end of the reference pulse and the ending time. If, at the end of the pulse, the threshold is already overshot, the search is for a value below the threshold and then for a value above it, before the end of the analysis limits.

Threshold: Threshold to reach on the signal analyzed showing that the relay operated. The method used to establish that the value was reached is determined by the type of search (m, d, c, C, f, F)

Threshold_ref: Threshold value to reach on the reference signal specifying the start and the end of the reference pulse

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.17.4. SYNTAX

res = sitopref( a, ref, “m”, threshold, threshold_ref, 0, HUGE, 1)

5.8.17.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.17.6. EXAMPLE

The following figure shows the different cases for this function, including the limit cases where the values returned are HUGE, -HUGE or simply 0.

<283″>5.8.18. THRESHOLD TIME – [SITSEUIL]

Compute the time at which a threshold value is reached.

5.8.18.1. CATEGORY

SI5

5.8.18.2. DESCRIPTION

Compute the time at which a threshold value is reached (either on positive or negative slope) on a specified part of a signal.

5.8.18.3. RESULT VARIABLES AND PARAMETERS

Result: Time in milliseconds [ms] at which the threshold value is reached on the specified part of the signal, increased by the delay and multiplied by the factor. If the returned result is HUGE, this means that the threshold value was never reached within the set limits

Note that the returned time is really the time at which the threshold value is reached, increased by the delay, and not the time relative to the starting time of the analysis.

Signal: Signal to analyze.

Signal_Part: Part of the signal on which the analysis is done (neg, pos, sig, abs). Here are the definitions for the four distinct parts of a signal:

Neg : Only the negative values of the input signal are used for the calculations. The other values are considered to be null.

Pos : Only the positive values of the input signal are used for the calculations. The other values are considered to be null.

Sig : The original input signal is used for the calculations.

Abs : The calculations are done on the absolute value of the input signal.

Threshold: Value of threshold to be reached on the specified part of the signal.

Delay: When the threshold time is determined, a delay is added to it. The new starting time of the analysis is thus equal to the time taken to reach the threshold plus the delay. The delay is specified in milliseconds [ms].

Begin_time: Time at which the analysis of a signal must start. This time is expressed in milliseconds [ms]. This value must be greater than 0 and lower than the duration of the test. The default value is 0.

End_time: Time at which the analysis of a signal must end. This time is expressed in milliseconds [ms]. The value of this time must be larger than the specified begin_time and smaller than the duration of the test. Use the “HUGE” value to specify the end of the test. The default value is HUGE.

Factor: Multiplying factor for the results generated by the function. The default value of the multiplying factor is 1.0 and has no effect on the results.

5.8.18.4. SYNTAX

res = sitseuil( input, “sig”, 0.5, 0, 0, HUGE, 1)

5.8.18.5. CHARACTERISTICS

Data type supportDouble Floating point

5.8.18.6. EXAMPLE

The following figure shows the different cases which can arise when executing the sitseuil function.

Begin Time: Instant after which the function computes the time.

Pictorial Representation:

CONTACT

OPAL-RT Corporate Headquarters

1751 Richardson, Suite 2525

Montréal, Québec, Canada

H3K 1G6

Tel.: 514-935-2323

Toll free: 1-877-935-2323

Technical Services

www.opal-rt.com/support

Note:

While every effort has been made to ensure accuracy in this publication, no responsibility can be accepted for errors or omissions. Data may change, as well as legislation, and you are strongly advised to obtain copies of the most recently issued regulations, standards, and guidelines.

This publication is not intended to form the basis of a contract.

28/01/2021

© OPAL-RT TECHNOLOGIES Inc.