FieldProperties.h

Go to the documentation of this file.

// Copyright (c) 2008-2026 Optris GmbH & Co. KG

 
#pragma once
 
#include <ostream>
#include <string>
 
#include "otcsdk/Api.h"
 
 
namespace optris
{

enum class FieldShape
{
  Rectangle, 
  Ellipse,   
  Polygon,   
  Splines,   
};

enum class FieldStat
{
  Minimum, 
  Maximum, 
  Mean,    
  Median,  
};

struct FieldStats
{
  float min = 0.F;
  float max = 0.F;
  float mean = 0.F;
  float sampleDeviation = 0.F;
  float median = 0.F;
  std::size_t n = 0;
};
 
 
// Utility functions
OTC_SDK_API float getFieldStat(const FieldStats& stats, FieldStat stat) noexcept;

OTC_SDK_API std::string toString(FieldShape shape) noexcept;

 OTC_SDK_API std::string toString(FieldStat stat) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, FieldShape shape) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, FieldStat stat) noexcept;

OTC_SDK_API std::ostream& operator<<(std::ostream& out, const FieldStats& stats) noexcept;
 
} // namespace optris