Enum rerun::components::AggregationPolicy

#[repr(u8)]
pub enum AggregationPolicy {
    Off = 1,
    Average = 2,
    Max = 3,
    Min = 4,
    MinMax = 5,
    MinMaxAverage = 6,
}

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.

Variants

Off = 1

No aggregation.

Average = 2

Average all points in the range together.

Max = 3

Keep only the maximum values in the range.

Min = 4

Keep only the minimum values in the range.

MinMax = 5

Keep both the minimum and maximum values in the range.

This will yield two aggregated points instead of one, effectively creating a vertical line.

MinMaxAverage = 6

Find both the minimum and maximum values in the range, then use the average of those.

Trait Implementations

impl Clone for AggregationPolicy

fn clone(&self) -> AggregationPolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AggregationPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for AggregationPolicy

fn default() -> AggregationPolicy

Returns the “default value” for a type.

impl Display for AggregationPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Enum for AggregationPolicy

fn variants() -> &'static [AggregationPolicy]

All variants, in the order they appear in the enum.

fn docstring_md(self) -> &'static str

Markdown docstring for the given enum variant.

impl Hash for AggregationPolicy

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Loggable for AggregationPolicy

type Name = ComponentName

fn name() -> <AggregationPolicy as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, AggregationPolicy>>>> ) -> Result<Box<dyn Array>, SerializationError>

where AggregationPolicy: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<AggregationPolicy>>, DeserializationError>

where AggregationPolicy: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow( data: &(dyn Array + 'static) ) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for AggregationPolicy

fn eq(&self, other: &AggregationPolicy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for AggregationPolicy

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl Copy for AggregationPolicy

impl Eq for AggregationPolicy

impl StructuralPartialEq for AggregationPolicy