aggregation_policy.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/components/aggregation_policy.def.rs".
 
#pragma once
 
#include "../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace arrow {
    /// \private
    template <typename T>
    class NumericBuilder;
 
    class Array;
    class DataType;
    class UInt8Type;
    using UInt8Builder = NumericBuilder<UInt8Type>;
} // namespace arrow
 
namespace rerun::components {
    /// **Component**: Policy for aggregation of multiple scalar plot values.
    ///
    /// This is used for lines in plots when the X axis distance of individual points goes below a single pixel,
    /// i.e. a single pixel covers more than one tick worth of data. It can greatly improve performance
    /// (and readability) in such situations as it prevents overdraw.
    enum class AggregationPolicy : uint8_t {
 
        /// No aggregation.
        Off = 1,
 
        /// Average all points in the range together.
        ///
        /// This can wash out outliers (spikes).
        Average = 2,
 
        /// Keep only the maximum values in the range.
        Max = 3,
 
        /// Keep only the minimum values in the range.
        Min = 4,
 
        /// Keep both the minimum and maximum values in the range.
        ///
        /// This will yield two aggregated points instead of one, effectively creating a vertical line.
        /// In practice this often leads to a rather ugly zig-zag look.
        MinMax = 5,
 
        /// Find both the minimum and maximum values in the range, then use the average of those.
        ///
        /// This yields a single point per range, so it does not draw a vertical line per pixel,
        /// while still letting a lone outlier move the plotted value, which averaging all the
        /// points in the range would wash out.
        MinMaxAverage = 6,
    };
} // namespace rerun::components
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<components::AggregationPolicy> {
        static constexpr std::string_view ComponentType = "rerun.components.AggregationPolicy";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type();
 
        /// Serializes an array of `rerun::components::AggregationPolicy` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::AggregationPolicy* instances, size_t num_instances
        );
 
        /// Fills an arrow array builder with an array of this type.
        static rerun::Error fill_arrow_array_builder(
            arrow::UInt8Builder* builder, const components::AggregationPolicy* elements,
            size_t num_elements
        );
    };
} // namespace rerun