CameraImageMetadata.h

Go to the documentation of this file.

 
// PROJECT:       Micro-Manager
// SUBSYSTEM:     MMDevice
//-----------------------------------------------------------------------------
// COPYRIGHT:     2026, Board of Regents of the University of Wisconsin System
//
// LICENSE:       This file is distributed under the BSD license.
//                License text is included with the source distribution.
//
//                This file is distributed in the hope that it will be useful,
//                but WITHOUT ANY WARRANTY; without even the implied warranty
//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
 
#pragma once
 
#include <cassert>
#include <map>
#include <sstream>
#include <string>
 
namespace MM {
 
class CameraImageMetadata {
public:
   // The memory warning in the AddTag() docs below doesn't apply to the
   // current std::map implementation but will apply to an intended future
   // implementation that serializes on the fly.
 
   template <typename V>
   void AddTag(const char* key, V value) {
      assert(key != nullptr);
      std::ostringstream strm;
      strm << value;
      tags_[key] = strm.str();
   }
 
   void AddTag(const char* key, const char* value) {
      assert(key != nullptr);
      assert(value != nullptr);
      tags_[key] = value;
   }
 
   template <typename V>
   void AddTag(const std::string& key, V value) {
      // Once we drop C++14 support, we could replace the char* and std::string&
      // overloads with std::string_view.
      AddTag(key.c_str(), value);
   }
 
   void Clear() { tags_.clear(); }
 
   const char* Serialize() const {
      // The serialization format used here is part of the versioned Device
      // Interface.
      //
      // Header: <tag_count>\n
      // (Spaces are tolerated before and after the tag count.)
      // For each tag: s\n<name>\n_\n1\n<value>\n
      // (The 's' indicates "single (not array) tag"; arrays are never used.)
      // (The '_' device-label field is always "_".)
      // (The '1' indicates "read-only"; no actual meaning.)
      //
      // Tags must have unique keys up to DIV 74. In DIV 75+, the last
      // occurrence of duplicate tags wins.
 
      serialized_.clear();
      serialized_ = std::to_string(tags_.size());
      serialized_ += '\n';
      for (const auto& tag : tags_) {
         serialized_ += "s\n";
         serialized_ += tag.first;
         serialized_ += "\n_\n1\n";
         serialized_ += tag.second;
         serialized_ += '\n';
      }
      return serialized_.c_str();
   }
 
private:
   std::map<std::string, std::string> tags_;
 
   mutable std::string serialized_; // Valid after Serialize()
};
 
} // namespace MM