Changes between Initial Version and Version 1 of compress_UA


Ignore:
Timestamp:
03/25/12 19:06:14 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • compress_UA

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: compress_UA = 
     4'''Contributed by: ''' 
     5 
     6== Function == 
     7The compress_UA and [wiki:decompress_UA decompress_UA] modules implement the gencompress algorithm which is used with permission from Boulder Real Time Technologies, Inc., copyright 1997. 
     8 
     9== Details == 
     10The compress_UA and [wiki:decompress_UA decompress_UA] modules implement the gencompress algorithm which is used with permission from Boulder Real Time Technologies, Inc., copyright 1997. 
     11 
     12Compress_UA inputs selected trace data messages (TYPE_TRACEBUF), compresses the samples via the BRTT algorithm, leaves the header intact, and outputs the resulting message as TYPE_TRACE_COMP_UA. Trace messages are selected via SCN names listed in the .d file. Wildcards are allowed. The compressed data output can be tagged with compress_UA's installation_id and module_id (normal Earthworm behavior), or with the installation_id and module_id of the original uncompressed message. 
     13 
     14[wiki:decompress_UA decompress_UA] is the matching decompressor. Its output is identical to the input to the compressor. As with compress_UA, [wiki:decompress_UA decompress_UA]'s output can be tagged with its own installation_id and module_id, or with those of the original message. This option allows the logo of the original data source to be preserved thru the compress/decompress operation. 
     15 
     16In order to run compress_UA and [wiki:decompress_UA decompress_UA], you must add TYPE_TRACE_COMP_UA message to 'earthworm.d'. 
     17 
     18== Example Configuration File === 
     19{{{ 
     20#     compress_UA's Configuration File 
     21# 
     22MyModId       MOD_COMPRESS_UA   # This instance of compress_UA 
     23InRing              WAVE_RING   # Transport ring to find waveform data on, 
     24OutRing             COMP_RING   # Transport ring to write output to, 
     25HeartBeatInterval   15          # Heartbeat interval, in seconds, 
     26LogFile             1           # 0=write log to stderr/stdout, not to disk 
     27                                # 1=write a log file to disk 
     28                                # 2=write a module log but not to stderr/stdout 
     29 
     30UseOriginalLogo     0   # 0=use compress_UA's logo on outgoing TYPE_TRACE_COMP_UA msgs 
     31                        # non-zero=use instid & modid of original TYPE_TRACEBUF msg 
     32                        #          on outgoing TYPE_TRACE_COMP_UA msg 
     33 
     34# instead of getting specific LOGOS, we are only interested in 
     35# messages of TYPE_TRACEBUF, but we may want to specify messages 
     36# with particular SCN codes of interest 
     37# 
     38# Wildcard character '*' is allowed in the SCN_Code fields 
     39# 
     40 
     41#GetEventsFrom  *   *   *       INST_WILDCARD      MOD_WILDCARD 
     42 GetEventsFrom  *   *   NC      INST_WILDCARD      MOD_WILDCARD 
     43 GetEventsFrom  KSP *   *       INST_WILDCARD      MOD_WILDCARD 
     44#GetEventsFrom  KSP *   NC      INST_WILDCARD      MOD_WILDCARD 
     45#GetEventsFrom  KSP VHZ *       INST_WILDCARD      MOD_WILDCARD 
     46#GetEventsFrom  HGS VHZ NC      INST_WILDCARD      MOD_WILDCARD 
     47}}} 
     48 
     49== Helpful Hints ==