MAN-SWA-0011 - Scream! AVD User Guide · Scream AVD Introduction 2 Introduction Scream! AVD is an...

Scream AVD

User GuideDocument Number: MAN-SWA-0011

Issue B: August, 2019

Designed and manufactured byGüralp Systems Limited3 Midas House, Calleva ParkAldermaston RG7 8EAEngland

Scream AVD Contents

Table of Contents

1 Preliminaries...................................................................................................................4

1.1 Proprietary Notice......................................................................................................41.2 Cautions and Notes...................................................................................................41.3 Manuals and Software...............................................................................................41.4 Conventions...............................................................................................................4

2 Introduction.....................................................................................................................5

3 Installation.......................................................................................................................6

4 The main form.................................................................................................................7

4.1 Status bar..................................................................................................................7

5 Getting started.................................................................................................................8

5.1 Specifying ports and GCF data servers....................................................................85.1.1 “Pull” servers......................................................................................................85.1.2 “Push” servers....................................................................................................95.1.3 Scream! Port......................................................................................................9

5.2 Calibration values (calvals.txt) file location...............................................................95.3 Instrument selection................................................................................................105.4 Output streams........................................................................................................10

6 Other settings................................................................................................................13

6.1 Integration high-pass corner frequency...................................................................136.2 Run when Windows starts.......................................................................................136.3 Minimise to system tray...........................................................................................146.4 Default naming........................................................................................................14

MAN-SWA-0011 Issue B - August, 2019

Scream AVD Preliminaries

7 Integration with Scream...............................................................................................15

7.1 Scream! AVD as a co-processor.............................................................................157.2 Scream! AVD as a front-end processor..................................................................177.3 Processing recorded data.......................................................................................19

8 Appendices....................................................................................................................20

8.1 Appendix А - Filter strings.......................................................................................208.2 Appendix B - Calibration values for calculated streams.........................................218.3 Appendix C - Revision history.................................................................................23

MAN-SWA-0011 3 Issue B - August, 2019

Scream AVD Preliminaries

1 Preliminaries

1.1 Proprietary NoticeThe information in this document is proprietary to Güralp Systems Limited and may be copied or distributed for educational and academic purposes but may not be used commercially without permission.

Whilst every effort is made to ensure the accuracy, completeness and usefulness of the information in the document, neither Güralp Systems Limited nor any employee assumes responsibility or is liable for any incidental or consequential damages resulting from the use of this document.

1.2 Cautions and NotesCautions and notes are displayed and defined as follows:

Caution: A yellow triangle indicates a chance of damage to or failure of the equipment if the caution is not heeded.

Note: A blue circle indicates indicates a procedural or advisory note.

1.3 Manuals and SoftwareAll manuals and software referred to in this document are available from the Güralp Systems website: www.guralp.com unless otherwise stated.

1.4 ConventionsThroughout this manual, examples are given of command-line interactions. In these examples, a fixed-width typeface will be used:

Example of the fixed-width typeface used.

Commands that you are required to type will be shown in bold:Example of the fixed-width, bold typeface.

Where data that you type may vary depending on your individual configuration, suchas parameters to commands, these data are additionally shown in italics:

Example of the fixed-width, bold, italic typeface.

Putting these together into a single example:System prompt: user input with variable parameters


http://www.guralp.com/

Scream AVD Introduction

2 IntroductionScream! AVD is an application used alongside Scream! to convert GCF data streams between Acceleration, Velocity and Displacement.

Scream! AVD can process GCF data:

• pushed over the Internet or a private network from any GCF/UDP source, using a configurable port number;

• pulled over the Internet or a private network from a configurable list of UDP sources; and/or

• pulled from a copy of Scream! running on the same PC.

This flexibility allows Scream! AVD to process any GCF data that could be collected by Scream!.

Scream! AVD calculates

• velocity and acceleration from displacement streams

• displacement and acceleration from velocity streams

• displacement and velocity from acceleration streams

and passes the resulting data back to Scream! as GCF streams. These can then be displayed and saved in the usual way or used by any application that accepts GCF data streams.

Scream! AVD features:

• Calculation of acceleration, velocity and displacement from GCF data streams

• Works alongside Scream!

• Outputs GCF data streams

• Simple set-up

• Runs on Windows (9x/NT/2000/XP, Vista, 7 and 8)

Scream! AVD uses UDP/IP for all data communication. If TCP sources are in use, such as networked CMG-6TDs, these data can be collected by Scream! and then processed by Scream! AVD before being passed back to Scream!

Scream! AVD pushes its output data to a configurable port on the same PC. This would normally go to a copy of Scream! but any software which accepts GCF data over UDP could be used.

For more details about integration with Scream!, please see Chapter 7 on page 15.


Scream AVD Installation

3 InstallationInstallation of the Scream! AVD application is simply a matter of copying the application's .exe file to a suitable folder on the PC. If Scream! is installed, the Scream folder would be a good choice for this.

Application settings are stored in .ini files on the PC. These are created automatically by the application when it is first run.

It may be convenient to create a short-cut on the desktop to the Scream! AVD application file by right clicking on the .exe file and selecting Create shortcut from the pop up menu.

When the application is first run, it may generate a Windows Security Alert, as shown below:

This is because the application requires access to network ports. It is necessary to click in order to use the program.


Scream AVD The main form

4 The main formThe main form of the Scream! AVD application allows the user to select and configure the GCF streams to be processed The form is shown below:

The form contains a filter bar and two lists of instruments. The list on the left holds the names of instruments that match the entered filter specification and for which GCF data have been received. These instruments are possible candidates for processing (but data from them will not be processed until they are selected by moving them to the right-hand list). The list on the right holds the names of instruments that have been selected for processing. Data from these instruments will be processed as soon as they are received.

4.1 Status barThe bottom of the form contains a status bar which displays

• a system activity indicator ( ); and

• data from the last received block of GCF data.

The system activity indicator ( ) shows that the application is operating. It should advance at a regular rate. If an out-of-sequence block is received, the indicator will momentarily display in a red colour.


Scream AVD Getting started

5 Getting startedTo start using the Scream! AVD extension, it is necessary to:

◦ Specify the GCF data servers from which to receive data, the network port-number used to receive that data and the network port-number to use to transmit the calculated data streams;

◦ Specify the location of the Scream! calibration values file (calvals.txt);

◦ Select the streams to be processed;

◦ Change the output stream names (if necessary).

This chapter describes these operations.

5.1 Specifying ports and GCF data serversThe network ports and GCF data servers are specified on the Network Settings form. To open this form, select Settings then Network settings on the main menu or type

+ , then . The form is shown below:

The port numbers and the location of Scream's calibration file all need to be configured before data can be received, processed and transmitted properly.

5.1.1 “Pull” servers

If you wish Scream! AVD to pull data from GCF sources, the IP addresses or DNS names of the servers should be entered here. For each, enter the IP address or DNS



name, followed by a colon (':') and then the appropriate UDP port number. Each server should be entered on a separate line. Once the settings are applied, Scream! AVD will immediately start attempting to pull data from these sources.

Note: If Scream! AVD is to acquire data from a copy of Scream! running on the same PC, it is recommended to pull data from Scream! by entering 127.0.0.1:1567 in the list of GCF data servers. For more information about Scream! integration, please see Chapter 7 on page 15.

5.1.2 “Push” servers

If you wish to have GCF data sources pushing data to Scream! AVD, specify the UDP port number that you wish to use for this purpose in the Rx port field. If you do not intend to use “push” servers, this field can be left at its default value.

5.1.3 Scream! Port

Scream! AVD pushes its output data to Scream! (or another client) on the same PC viathe UDP port specified in the Scream! port field. This number must match the value specified as Port used for all network communications at the bottom of Scream!'s Network Control window.

Note: The Receive UDP Data check-box on the My Client tab of Scream!'s Network Control window must be ticked for Scream! to receive this data. For more information about Scream! integration, please see Chapter 7 on page 15.

5.2 Calibration values (calvals.txt) file locationThe calibration-values file (calvals.txt) location should be entered in the Network Settings form as shown in section 5.1 on page 8.

The full path to the file and the file name need to be entered. Click the button to navigate to the file or type in the full path and file name.

This setting (along with a correctly-populated calvals.txt file) is required for Scream! AVD to work properly.



5.3 Instrument selectionOnce the network details have been entered, the Scream! AVD application can automatically populate the left-hand list of the main window based on the data from the configured servers. To enable this, tick the Add check-box as shown in the following image.

Instruments will automatically be added to the left-hand list of the main form as GCFdata blocks are received by the application.

As instruments are added to the list, the calibration file (calvals.txt) is used to determine what type of instrument it is: whether acceleration, velocity or displacement. If the instrument type cannot be determined, either because the calvals.txt file is not found or there is not a correctly formed “response” line for the instrument, the corresponding line in the list will be highlighted in yellow.

The instruments that are added to the list can be filtered using a filter string, an example of which ([abc]*) is shown in the image above. Only instruments with names matching this filter will be added to the list. If the filter string is incorrect in any way, the edit box will be highlighted in yellow and the Add check-box will remain un-ticked. Please see section 8.1 on page 20 for more information about the use of the filter string.

The button will remove all entries from the left-hand list.

As instruments are added to the left-hand list, they can be moved across to the right-hand list – i.e. marked for inclusion in the processing - using the top two buttons in the centre of the main form.

The top button will move all the instruments to the right-hand list. The button will move only the selected instruments.

Note: Any instruments in the list which are highlighted in yellow (because of missing or invalid calibration values) are inadequately specified and can not be enabled (moved to the right-hand list).

The bottom two buttons behave in a similar manner. The button moves theinstruments selected in the right-hand list to the left and the button movesall the instruments back to the left.

5.4 Output streamsGCF streams are identified by unique Stream Names which are formed by the concatenation of the SysID (the system identifier, which identifies a single digitiser,



which may have one or more connected instruments), a hyphen ('-') and the Stream ID. For more information about Stream Names, please see www.guralp.com/howtos/stream-ids-explained.shtml.

Scream! AVD generates new Stream Names for every stream that it outputs, althoughthe automatically-generated names can be edited if desired.

When instruments have been enabled (moved to the right-hand list), Scream! AVD creates new default SysIDs for the pass-through stream and for each of the calculated streams. The types – whether acceleration, velocity or displacement - of the calculated streams are dependent on each instrument's type:

• For an accelerometer, new velocity and displacement streams will be generated;

• For a velocimeter, new acceleration and displacement streams will be generated;

• For a displacement meter, new velocity and acceleration streams will be generated.

In each case, the original input streams are also passed through. optionally with a new SysID, although the time-series data are unchanged.

Default Stream Names are created by modifying the SysID by appending or prepending either P for pass-through; A for acceleration, V for velocity or D for displacement. (Only three of these four will be shown for any given input.) The operator can choose between appending and prepending via the Default naming… screen (see section 6.4 on page 14). Existing SysIDs are truncated as necessary to make room for the new character.

In the example below, input data come from an accelerometer with a SysID of AAA. The input data are passed through unchanged with a new SysID of AAAP (P=pass-through) and two new streams are generated: a calculated velocity stream with a SysID of AAAV (V=velocity) and a calculated displacement stream with a SysID of AAAD (D=displacement).

The Stream IDs, which identify the instrument, the component and the decimation tap (sample rate) are unchanged by default, although they can also be edited if desired.


http://www.guralp.com/howtos/stream-ids-explained.shtml


The Stream Names generated as described above can be inspected and edited by selecting the source instrument in the right-hand instrument list. The following information appears in the right-hand pane of the main window:

SysIDs and Stream IDs can be edited in this pane. In order to avoid duplicate stream names, checks are made during editing. If a name is already in use, either with the current instrument or with another, the relevant edit box will be highlighted in yellow and the “update” button will be disabled, as shown:

By default, all three output streams are enabled when an instrument is first added to the right-hand list. Each can be disabled (or re-enabled) by clicking on the appropriate check-box, as seen on the left in the image above.

Note: De-selecting an output stream only stops the data from being sent to Scream! The calculations are still performed whether or not the stream is enabled


Scream AVD Other settings

6 Other settingsThis chapter describes the facilities available from the Settings menu.

The Network settings… window is described in section 5.1 on page 8.

6.1 Integration high-pass corner frequencyMathematical integration is used to convert acceleration to velocity and velocity to displacement. In order to minimise DC offset, a high-pass filter is used. The corner frequency of this filter can be set by selecting the HP Filter corner … menu item from the Settings menu.

The default value is 0.02 Hz (50 seconds). You can enter a value into either the Frequency (Hz) or Period (s) field: the other will update accordingly.

6.2 Run when Windows startsScream! AVD can be set to run automatically each time a user logs on to Windows. To achieve this, an entry is made in the Windows Registry at:

HKCU: \Software\Microsoft\Windows\CurrentVersion\Run


Scream AVD Other settings

To enable or disable this, tick or clear the Run when Windows starts option from the Settings menu.

6.3 Minimise to system trayThe Scream! AVD extension can be set to minimise to the system tray as shown in the following screen shot.

A mouse-click on the icon in the system tray will cause the application's main window to be restored. To enable or disable this, tick or clear the Minimise to systemtray option from the Settings menu.

6.4 Default naming Whenever an instrument is enabled (“moved” to the right hand list), unique Stream IDs are created for the pass-through stream and the two calculated streams. By default, the original stream name is modified by changing the last character of the Sys Id to P, A, V or D for pass-through, acceleration, velocity and displacement, respectively.

This default behaviour can be changed slightly using the Default naming… item fromthe Settings menu. The following form will be shown:

Each of the default characters may be changed (though they must all differ from each other) and the location where the characters are inserted can be selected: eitherat the start of the SysID, or at the end.

Note: SysIDs with five characters will be truncated in order to make room for the additional character specified here.


Scream AVD Integration with Scream

7 Integration with ScreamWhile many different configurations are possible, the recommended set-up is to use Scream! AVD as a coprocessor for Scream!, where selected streams are read from Scream!, processed and then fed back into Scream!. It is also possible to use the software as a front-end processor for Scream!, where all incoming data are processedby Scream! AVD before reaching Scream!. This chapter describes both of these scenarios.

7.1 Scream! AVD as a co-processorIn the recommended mode, Scream! is responsible for collecting all incoming data. The incoming streams are pushed by Scream! to Scream! AVD for processing and the calculated streams are pushed back to Scream!, using the network loop-back adaptor.

Note: Because Scream! AVD can only collect data from UDP sources, co-processor mode must be chosen if any data source uses TCP. For example,wireless-attached CMG-6TDs use BRP over TCP to send GCF data, so co-processor mode must be used when working with these instruments.

To configure Scream! AVD as a co-processor for Scream!, first configure Scream! to collect all of the required data. For more information about this, please refer to the Scream! Manual, MAN-SWA-0001.

Once the data streams have appeared in Scream!, open Scream!'s Network control window and select the My Server tab. Tick one or both of the check-boxes Transmit data from local Com ports and Transmit data from Network so that the required data can be retransmitted to Scream! AVD.

Right-click in the “Clients” area of the My Server tab and select Add… from the context menu. Enter the IP address or DNS name of the computer running Scream! AVD – as it is on the same machine as Scream!, you can use the loop-back address, which is 127.0.0.1 – and the port on which Scream! AVD will be listening, as specified in the Rx port field of Scream! AVD's Network settings tab, separating the two with a colon (':').


http://www.guralp.com/documents/MAN-SWA-0001.pdf


Once data are arriving in Scream! AVD, select them and map the stream-names as desired, as described in section 5.4 on page 10.

Note: Do not enable the pass-through ('P') streams as they will already be appearing in Scream!, direct from the data sources.

Revisit Scream!'s Network control window and select the My Client tab. Ensure that the Receive UDP Data check-box is ticked, as shown below:

Lastly, revisit the Network settings window in Scream! AVD and set the Scream Port to match the Port used for all network communications at the bottom of Scream!'s Network Control window, as shown below:

Double-check that the port numbers highlighted in red correspond as shown.



Note: The two port numbers, Rx port and Scream port must differ from each other but, other than that, any suitable port numbers can be chosen. The ports chosen must not be

For more information about Scream's Network Control window, please refer to the Scream! Manual, MAN-SWA-0001.

Note: The streams generated by Scream! AVD will be re-transmitted back from Scream! to Scream! AVD, so they will appear in the left-hand instrument list in the main window. Do Not select these streams for processing: this will cause a data loop.

In summary:

• “Push” sources all use the port specified in Scream! as Port used for all network communications

• “Pull” sources are individually configured in Scream!'s My Client tab.

• Scream! pushes data to Scream! AVD via a client entry in Scream!'s My Servers tab, using the port specified in Scream! AVD as Rx Port

• Scream! AVD's “GCF data servers” field is left blank

7.2 Scream! AVD as a front-end processor

Note: Because Scream! AVD can only collect data from UDP sources, front-end processor mode can not be used if any data source uses TCP. For example, wireless-attached CMG-6TDs use BRP over TCP to send GCF data, so co-processor mode must be used instead when working with these instruments.

To configure Scream! AVD as a front-end pre-processor for Scream!, first configure Scream! AVD to collect all of the required data. The data can be pulled from the source or pushed by the source.

Where data should be pulled from the source into Scream! AVD, configure each data source in the Network settings window by entering the IP address or DNS name, followed by a colon (':') and the required UDP port number. In the screen-shot below,




Scream! AVD will pull data from the server at address 192.168.84.100 on UDP port 2008 and from the server with the DNS name banff on UDP port 8050.

Where source systems will push data into Scream! AVD, they should be configured with the IP address or DNS name of the PC and the port specified in the Rx port field. Any suitable UDP port can be chosen and specified for this purpose. In the previous screen-shot, port 15671 is specified.

Once data are arriving in Scream! AVD and the stream-names can be mapped as desired, as described in section 5.4 on page 10.

Note: The streams generated by Scream! AVD will be re-transmitted back to Scream! with a new System ID which will not match that of the original data stream or that contained in the InfoBlock. This means that any existing calvals.txt file will need modification before it can be used and the InfoBlock mechanism will not work for automatically populating calvals.txt.

For more information about InfoBlocks, please see:www.guralp.com/howtos/using-infoblocks-with-scream.shtml


http://www.guralp.com/howtos/using-infoblocks-with-scream.shtml


Next, set the Scream Port to match the Port used for all network communications, as shown at the bottom of Scream!'s Network Control window, and ensure that the Receive UDP Data check-box on the My Client tab of Scream!'s Network Control window is ticked, as shown below:

For more information about Scream configuration, please refer to the Scream! Manual, MAN-SWA-0001.

In summary:

• “Push” sources use the port specified as Rx port in Scream! AVD

• “Pull” sources are configured as GCF data servers in Scream! AVD

• Scream! AVD pushes data to Scream! via the port specified as Scream Port

• No data sources are configured in Scream!.

7.3 Processing recorded dataRecorded data replayed through Scream are not normally transmitted over the network. To enable transmission of recorded data, start Scream with the option

-txfiles

on the command line. This can be most easily done by modifying the windows short-cut or linux start-up script used to launch Scram.



Scream AVD Appendices

8 Appendices

8.1 Appendix А - Filter stringsWhen instruments are being added to the left-hand list, a text filter can be applied to the stream name in order to limit the number of instruments listed.

A valid filter string consists of literal characters, character-sets and wild-cards:

• Literal characters will each match a single character in the string. The comparison is not case-sensitive.

• Wild-cards are asterisks (*) or question marks (?). An asterisk matches any number of characters. A question mark matches any single character.

• Character sets match a single character in the input to a selection or range of possible characters. Each character-set begins with an opening bracket ([) and ends with a closing bracket (]). Between the brackets are listed the possible elements of the set. Each element is a literal character or a range. Ranges are specified by an initial value, a dash (-), and a final value. (Do not use spaces or commas to separate the elements of the set.) The input character matches the set if it is the same as one of the literal characters in the set, or if it is in one of the ranges in the set. A character is in a range if it matches the initial value, the final value, or falls between the two values. All comparisons are case-insensitive. If the first character after the opening bracket of a set is an exclamation mark (!), then the set matches any character that is not in the set.

For example, recall that the last two characters of a stream name represent the component and the tap. So:

• To list only vertical streams from tap 4, the filter string would be

*z4

The wild-card * will match any number of leading characters and the z and the 4 are literals which must match the last two characters of the input, constraining them to be Z4 or z4.

• To list the two horizontal components for any tap, a character-set must be used, so the filter string would be:

*[ne]?

Here, the wild-card * will match any number of leading characters. The character-set [ne] matches one of N, n, E or e in the penultimate position and the wildcard ? will match any final character.



8.2 Appendix B - Calibration values for calculated streams In order that Scream can display the calculated streams correctly (with appropriate physical units), new entries are created in the calibration parameters file (calvals.txt). Existing entries from the section for the relevant instruments are duplicated and modified as necessary.

Three entries are required for correct operation of the system: G (gain), VPC and Response. Gain and VPC are unaltered while the response entry is amended by changing "Acceleration" or "Velocity" to "Acceleration", "Velocity" or "Displacement", as appropriate, for each of the calculated streams.

Below are typical entries for a CMG-3V accelerometer. The first section is the original section, which is unchanged; this is followed by the newly-generated sections for the calculated pass-through, velocity and displacement streams.

[AAA-R01] SERIAL-NOS=V3I28/C688 WO=2616 G=754 VPC=3.198 TYPE=CMG-3V RESPONSE=20S ACCELERATION COILCONST=0.02385 CALVPC=3.19 CALRES=51000

[AAAP-R01] Comment1=Derived from AAA-R01 Comment2=by Scream! AVD Extension application Serial-Nos=V3I28/C688 WO=2616 G=754 VPC=3.198 Type=CMG-3V Response=20S Acceleration CoilConst=0.02385 CalVPC=3.19 CalRes=51000

[AAAV-R01] Comment1=Derived from AAA-R01 Comment2=by Scream! AVD Extension application Serial-Nos=V3I28/C688 WO=2616 G=754 VPC=3.198 Type=CMG-3V



Response=20S Velocity CoilConst=0.02385 CalVPC=3.19 CalRes=51000

[AAAD-R01] Comment1=Derived from AAA-R01 Comment2=by Scream! AVD Extension application Serial-Nos=V3I28/C688 WO=2616 G=754 VPC=3.198 Type=CMG-3V Response=20S Displacement CoilConst=0.02385 CalVPC=3.19 CalRes=51000



8.3 Appendix C - Revision history9th June 2014 A New document16th August, 2016 Updated for new branding: no significant content changes.28th August, 2019 B Added -txfiles option for Scream


MAN-SWA-0011 - Scream! AVD User Guide · Scream AVD Introduction 2 Introduction Scream! AVD is an...

Documents

Transcript of MAN-SWA-0011 - Scream! AVD User Guide · Scream AVD Introduction 2 Introduction Scream! AVD is an...