cosmos 4.1.1 → 4.2.0

data/lib/cosmos/tools/tlm_grapher/data_objects/data_object.rb

@@ -92,6 +92,12 @@ module Cosmos
       raise "processed_packets must be defined by class #{self.class}"
     end
 
+    # Returns the items used by this data object in the order required
+    # by process_dart and process_values
+    def processed_items
+      raise "processed_items must be defined by class #{self.class}"
+    end
+
     # Processes a packet associated with this data object
     #
     # @param packet [Packet] The packet to process
@@ -101,6 +107,31 @@ module Cosmos
       raise "process_packet must be defined by class #{self.class}"
     end
 
+    # Processes a packet associated with this data object
+    #
+    # @param packet [Packet] The packet to process
+    # @param count [Integer] Count which increments for each packet received by
+    #   the higher level process
+    def process_values(*args)
+      raise "process_values must be defined by class #{self.class}"
+    end
+
+    # Handles calling process_values with the given data from DART
+    def process_dart(dart_results)
+      sample = []
+      min_length = nil
+      dart_results.each do |dr|
+        min_length = dr.length if !min_length or dr.length < min_length
+      end
+      min_length.times do |sample_index|
+        sample = []
+        dart_results.length.times do |drindex|
+          sample << dart_results[drindex][sample_index][0]
+        end
+        process_values(*sample)
+      end
+    end
+
     def handle_process_exception(error, telemetry_point)
       raise error if error.class == NoMemoryError
       reset()
@@ -188,6 +219,14 @@ module Cosmos
       return nil
     end
 
-  end # class DataObject
-
-end # module Cosmos
+    # @return [Boolean] Whether the value is invalid: nil, NaN, or Infinite
+    #   and thus can not be graphed
+    def invalid_value?(value)
+      invalid = false
+      invalid ||= value.nil?
+      invalid ||= (value.respond_to?(:nan?) && value.nan?)
+      invalid ||= (value.respond_to?(:infinite?) && value.infinite?)
+      invalid
+    end
+  end
+end

data/lib/cosmos/tools/tlm_grapher/data_objects/housekeeping_data_object.rb

@@ -12,7 +12,6 @@ require 'cosmos'
 require 'cosmos/tools/tlm_grapher/data_objects/linegraph_data_object'
 
 module Cosmos
-
   # Represents a data object on a line graph for a housekeeping telemetry item
   class HousekeepingDataObject < LinegraphDataObject
 
@@ -20,7 +19,13 @@ module Cosmos
     VALUE_TYPES = [:RAW, :CONVERTED]
 
     # Analysis Types
-    ANALYSIS_TYPES = [:NONE, :DIFFERENCE, :WINDOWED_MEAN, :WINDOWED_MEAN_REMOVED, :STD_DEV, :ALLAN_DEV, :MAXIMUM, :MINIMUM, :PEAK_TO_PEAK]
+    ANALYSIS_TYPES = [:NONE, :DIFFERENCE, :WINDOWED_MEAN, :WINDOWED_MEAN_REMOVED, :STD_DEV, :ALLAN_DEV, :MAXIMUM, :MINIMUM, :PEAK_TO_PEAK, :SAMPLED, :SAMPLED_MEAN]
+
+    # DART Reductions
+    DART_REDUCTIONS = [:NONE, :MINUTE, :HOUR, :DAY]
+
+    # DART Reduced Types
+    DART_REDUCED_TYPES = [:AVG, :MIN, :MAX, :STDDEV]
 
     # The housekeeping telemetry item's target name (string)
     attr_reader :target_name
@@ -43,6 +48,12 @@ module Cosmos
     # Type of data to collect - :RAW or :CONVERTED
     attr_accessor :value_type
 
+    # DART Reduction
+    attr_accessor :dart_reduction
+
+    # DART Reduced Type
+    attr_accessor :dart_reduced_type
+
     # The analysis to perform
     attr_accessor :analysis
 
@@ -65,6 +76,8 @@ module Cosmos
       @time_item_name = nil
       @formatted_time_item_name = nil
       @value_type = :CONVERTED
+      @dart_reduction = :NONE
+      @dart_reduced_type = :AVG
       @analysis = :NONE
       @analysis_samples = 3
       @show_limits_lines = false
@@ -84,6 +97,8 @@ module Cosmos
       string << "      TIME_ITEM #{@time_item_name}\n" if @time_item_name
       string << "      FORMATTED_TIME_ITEM #{@formatted_time_item_name}\n" if @formatted_time_item_name
       string << "      VALUE_TYPE #{@value_type}\n"
+      string << "      DART_REDUCTION #{@dart_reduction}\n"
+      string << "      DART_REDUCED_TYPE #{@dart_reduced_type}\n"
       string << "      ANALYSIS #{@analysis}\n"
       string << "      ANALYSIS_SAMPLES #{@analysis_samples}\n"
       string << "      SHOW_LIMITS_LINES #{@show_limits_lines.to_s.upcase}\n"
@@ -123,6 +138,26 @@ module Cosmos
           raise ArgumentError, "Unknown VALUE_TYPE value: #{value_type}"
         end
 
+      when 'DART_REDUCTION'
+        # Expect 1 parameter
+        parser.verify_num_parameters(1, 1, "DART_REDUCTION <NONE, MINUTE, HOUR, DAY>")
+        dart_reduction = parameters[0].upcase.intern
+        if DART_REDUCTIONS.include?(dart_reduction)
+          @dart_reduction = dart_reduction
+        else
+          raise ArgumentError, "Unknown DART_REDUCTION value: #{dart_reduction}"
+        end
+
+      when 'DART_REDUCED_TYPE'
+        # Expect 1 parameter
+        parser.verify_num_parameters(1, 1, "DART_REDUCED_TYPE <AVG, MIN, MAX, STDDEV>")
+        dart_reduced_type = parameters[0].upcase.intern
+        if DART_REDUCED_TYPES.include?(dart_reduced_type)
+          @dart_reduced_type = dart_reduced_type
+        else
+          raise ArgumentError, "Unknown DART_REDUCED_TYPE value: #{dart_reduced_type}"
+        end
+
       when 'ANALYSIS'
         # Expect 1 parameter
         parser.verify_num_parameters(1, 1, "ANALYSIS <Analysis Type>")
@@ -160,6 +195,19 @@ module Cosmos
       end
     end
 
+    # Returns an array of items used by this data object
+    def processed_items
+      items = []
+      if @target_name and @packet_name
+        if @item_name
+          items << [@target_name, @packet_name, @time_item_name, :CONVERTED, nil, @dart_reduction, :AVG]
+          items << [@target_name, @packet_name, @item_name, @value_type, @item_array_index, @dart_reduction, @dart_reduced_type]
+          items << [@target_name, @packet_name, @formatted_time_item_name, :CONVERTED, nil, @dart_reduction, :AVG] if @formatted_time_item_name and @dart_reduction == :NONE
+        end
+      end
+      items
+    end
+
     # (see DataObject#process_packet)
     def process_packet(packet, count)
       begin
@@ -173,13 +221,23 @@ module Cosmos
         if y_value.is_a?(Array) and @item_array_index and @item_array_index < y_value.size
           y_value = y_value[@item_array_index]
         end
+
+        formatted_x_value = nil
+        formatted_x_value = packet.read(@formatted_time_item_name) if @formatted_time_item_name and @dart_reduction == :NONE
+
+        process_values(x_value, y_value, formatted_x_value)
+      rescue Exception => error
+        handle_process_exception(error, "#{@target_name} #{@packet_name} #{@item_name}")
+      end
+    end # def process_packet
+
+    # Process Analysis Steps
+    def process_values(x_value, y_value, formatted_x_value = nil)
+      begin
+        @formatted_x_values << formatted_x_value if formatted_x_value
+
         # Bail on the values if they are NaN or nil as we can't graph them
-        return if x_value.nil? || y_value.nil? ||
-          (x_value.respond_to?(:nan?) && x_value.nan?) ||
-          (y_value.respond_to?(:nan?) && y_value.nan?) ||
-          (x_value.respond_to?(:infinite?) && x_value.infinite?) ||
-          (y_value.respond_to?(:infinite?) && y_value.infinite?)
-        @formatted_x_values << packet.read(@formatted_time_item_name) if @formatted_time_item_name
+        return if invalid_value?(x_value) || invalid_value?(y_value)
 
         upper_index  = nil
         sample_index = nil
@@ -256,6 +314,19 @@ module Cosmos
             @plot.redraw_needed = true
           end
 
+        when :SAMPLED, :SAMPLED_MEAN
+          if @unprocessed_y_values.length >= @analysis_samples
+            if sample_index % @analysis_samples == 0
+              if @analysis == :SAMPLED
+                @x_values << @unprocessed_x_values[sample_index]
+                @y_values << (@unprocessed_y_values[sample_index] + @y_offset)
+              else # :SAMPLED_MEAN
+                @x_values << @unprocessed_x_values[sample_index]
+                @y_values <<  @unprocessed_y_values[lower_index..upper_index].mean + @y_offset
+              end
+            end
+            @plot.redraw_needed = true
+          end
         end # case @analysis
 
         # Make sure the data object's first x value is the smallest x value encountered during packet processing.
@@ -268,9 +339,9 @@ module Cosmos
         # Prune Data
         prune_to_max_points_saved()
       rescue Exception => error
-        handle_process_exception(error, "#{packet.target_name} #{packet.packet_name} #{@item_name}")
+        handle_process_exception(error, "#{@target_name} #{@packet_name} #{@item_name}")
       end
-    end # def process_packet
+    end
 
     # Returns the name of this data object
     def name
@@ -278,6 +349,7 @@ module Cosmos
       if @target_name and @packet_name and @item_name
         str << "#{@target_name} #{@packet_name} #{@item_name}"
         str << "[#{@item_array_index}]" if @item_array_index
+        str << " <#{@dart_reduction} #{dart_reduced_type}>" if @dart_reduction != :NONE
         str << " (#{@analysis})" if @analysis != :NONE
       end
       str
@@ -301,6 +373,8 @@ module Cosmos
       data_object.time_item_name = @time_item_name.clone if @time_item_name
       data_object.formatted_time_item_name = @formatted_time_item_name.clone if @formatted_time_item_name
       data_object.value_type = @value_type
+      data_object.dart_reduction = @dart_reduction
+      data_object.dart_reduced_type = @dart_reduced_type
       data_object.analysis = @analysis
       data_object.analysis_samples = @analysis_samples
       data_object.show_limits_lines = @show_limits_lines
@@ -331,6 +405,8 @@ module Cosmos
          @item_array_index != edited_data_object.item_array_index or
          @time_item_name != edited_data_object.time_item_name or
          @formatted_time_item_name != edited_data_object.formatted_time_item_name or
+         @dart_reduction != edited_data_object.dart_reduction or
+         @dart_reduced_type != edited_data_object.dart_reduced_type or
          @value_type != edited_data_object.value_type or
          @analysis != edited_data_object.analysis or
          @analysis_samples != edited_data_object.analysis_samples
@@ -416,7 +492,5 @@ module Cosmos
       end
       prune_index
     end
-
-  end # class HousekeepingDataObject
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/tlm_grapher/data_objects/linegraph_data_object.rb

@@ -12,7 +12,6 @@ require 'cosmos'
 require 'cosmos/tools/tlm_grapher/data_objects/data_object'
 
 module Cosmos
-
   # Represents a data object on a line graph
   # Designed for use as a base class for custom data objects
   class LinegraphDataObject < DataObject
@@ -170,7 +169,5 @@ module Cosmos
       end
       prune_index
     end
-
-  end # class LinegraphDataObject
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/tlm_grapher/data_objects/singlexy_data_object.rb

@@ -12,14 +12,10 @@ require 'cosmos'
 require 'cosmos/tools/tlm_grapher/data_objects/xy_data_object'
 
 module Cosmos
-
   # Represents a data object on an SinglxyGraph for two telemetry items
   class SinglexyDataObject < XyDataObject
-
     def initialize
       super()
     end
-
-  end # class SinglexyDataObject
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/tlm_grapher/data_objects/xy_data_object.rb

@@ -12,13 +12,18 @@ require 'cosmos'
 require 'cosmos/tools/tlm_grapher/data_objects/data_object'
 
 module Cosmos
-
   # Represents a data object on an XyGraph for two telemetry items
   class XyDataObject < DataObject
 
     # Value Types
     VALUE_TYPES = [:RAW, :CONVERTED]
 
+    # DART Reductions
+    DART_REDUCTIONS = [:NONE, :MINUTE, :HOUR, :DAY]
+
+    # DART Reduced Types
+    DART_REDUCED_TYPES = [:AVG, :MIN, :MAX, :STDDEV]
+
     # The target name (string)
     attr_accessor :target_name
 
@@ -40,6 +45,12 @@ module Cosmos
     # Type of data to collect for y value - :RAW or :CONVERTED
     attr_accessor :y_value_type
 
+    # DART Reduction
+    attr_accessor :dart_reduction
+
+    # DART Reduced Type
+    attr_accessor :dart_reduced_type
+
     # Array of x_values to graph on the line graph
     attr_accessor :x_values
 
@@ -65,6 +76,8 @@ module Cosmos
       @time_item_name = nil
       @x_value_type = :CONVERTED
       @y_value_type = :CONVERTED
+      @dart_reduction = :NONE
+      @dart_reduced_type = :AVG
 
       @x_values = LowFragmentationArray.new(DEFAULT_ARRAY_SIZE)
       @y_values = LowFragmentationArray.new(DEFAULT_ARRAY_SIZE)
@@ -85,6 +98,8 @@ module Cosmos
       string << "      TIME_ITEM #{@time_item_name}\n" if @time_item_name
       string << "      X_VALUE_TYPE #{@x_value_type}\n"
       string << "      Y_VALUE_TYPE #{@y_value_type}\n"
+      string << "      DART_REDUCTION #{@dart_reduction}\n"
+      string << "      DART_REDUCED_TYPE #{@dart_reduced_type}\n"      
       string
     end # def configuration_string
 
@@ -160,6 +175,26 @@ module Cosmos
           raise ArgumentError, "Unknown Y_VALUE_TYPE value: #{value_type}"
         end
 
+        when 'DART_REDUCTION'
+          # Expect 1 parameter
+          parser.verify_num_parameters(1, 1, "DART_REDUCTION <NONE, MINUTE, HOUR, DAY>")
+          dart_reduction = parameters[0].upcase.intern
+          if DART_REDUCTIONS.include?(dart_reduction)
+            @dart_reduction = dart_reduction
+          else
+            raise ArgumentError, "Unknown DART_REDUCTION value: #{dart_reduction}"
+          end
+  
+        when 'DART_REDUCED_TYPE'
+          # Expect 1 parameter
+          parser.verify_num_parameters(1, 1, "DART_REDUCED_TYPE <AVG, MIN, MAX, STDDEV>")
+          dart_reduced_type = parameters[0].upcase.intern
+          if DART_REDUCED_TYPES.include?(dart_reduced_type)
+            @dart_reduced_type = dart_reduced_type
+          else
+            raise ArgumentError, "Unknown DART_REDUCED_TYPE value: #{dart_reduced_type}"
+          end     
+
       else
         # Unknown keywords are passed to parent data object
         super(parser, keyword, parameters)
@@ -177,6 +212,17 @@ module Cosmos
       end
     end
 
+    # Returns an array of items used by this data object
+    def processed_items
+      items = []
+      if @target_name and @packet_name
+        items << [@target_name, @packet_name, @x_item_name, @x_value_type, nil, @dart_reduction, @dart_reduced_type]
+        items << [@target_name, @packet_name, @y_item_name, @y_value_type, nil, @dart_reduction, @dart_reduced_type]
+        items << [@target_name, @packet_name, @time_item_name, :CONVERTED, nil, @dart_reduction, :AVG] if @time_item_name
+      end
+      items
+    end
+
     # (see DataObject#process_packet)
     def process_packet(packet, count)
       begin
@@ -192,32 +238,40 @@ module Cosmos
           y_value = packet.read(@y_item_name)
         end
 
-        # Bail on the values if they are NaN or nil as we can't graph them
-        return if x_value.nil? || y_value.nil? ||
-          (x_value.respond_to?(:nan?) && x_value.nan?) ||
-          (y_value.respond_to?(:nan?) && y_value.nan?) ||
-          (x_value.respond_to?(:infinite?) && x_value.infinite?) ||
-          (y_value.respond_to?(:infinite?) && y_value.infinite?)
-
+        time_value = nil
         time_value = packet.read(@time_item_name) if @time_item_name
 
+        process_values(x_value, y_value, time_value)
+      rescue Exception => error
+        handle_process_exception(error, "#{@target_name} #@packet_name} #{@x_item_name} or #{@y_item_name}")
+      end
+    end # def process_packet
+
+    # Add a set of values to the data object
+    def process_values(x_value, y_value, time_value = nil)
+      begin
+        # Bail on the values if they are NaN or nil as we can't graph them
+        return if invalid_value?(x_value) || invalid_value?(y_value)
+
         @x_values << x_value
         @y_values << y_value
-        @time_values << time_value if @time_item_name
+        @time_values << time_value if time_value
 
         @plot.redraw_needed = true
 
         # Prune Data
         prune_to_max_points_saved()
       rescue Exception => error
-        handle_process_exception(error, "#{packet.target_name} #{packet.packet_name} #{@x_item_name} or #{@y_item_name}")
-      end
-    end # def process_packet
+        handle_process_exception(error, "#{@target_name} #{@packet_name} #{@x_item_name} or #{@y_item_name}")
+      end      
+    end
 
     # Returns the name of this data object
     def name
       if @target_name and @packet_name and @y_item_name and @x_item_name
-        "#{@target_name} #{@packet_name} #{@y_item_name} VS #{@x_item_name}"
+        str = "#{@target_name} #{@packet_name} #{@y_item_name} VS #{@x_item_name}"
+        str << " <#{@dart_reduction} #{dart_reduced_type}>" if @dart_reduction != :NONE
+        str
       else
         ""
       end
@@ -250,6 +304,8 @@ module Cosmos
       data_object.time_item_name = @time_item_name.clone if @time_item_name
       data_object.x_value_type = @x_value_type
       data_object.y_value_type = @y_value_type
+      data_object.dart_reduction = @dart_reduction
+      data_object.dart_reduced_type = @dart_reduced_type      
       data_object
     end
 
@@ -263,7 +319,9 @@ module Cosmos
          @y_item_name != edited_data_object.y_item_name or
          @time_item_name != edited_data_object.time_item_name or
          @x_value_type != edited_data_object.x_value_type or
-         @y_value_type != edited_data_object.y_value_type
+         @y_value_type != edited_data_object.y_value_type or
+         @dart_reduction != edited_data_object.dart_reduction or
+         @dart_reduced_type != edited_data_object.dart_reduced_type
         false
       else
         super(edited_data_object)
@@ -319,7 +377,5 @@ module Cosmos
       end
       prune_index
     end
-
-  end # class XyDataObject
-
-end # module Cosmos
+  end
+end