MSImagingGeometry.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
 
#include <unordered_map>
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MSImagingGeometry final
  {
  public:
    struct Pixel
    {
      UInt x = 0;              
      UInt y = 0;              
      Size spectrum_index = 0; 
    };
 
    void setDimensions(UInt width, UInt height);
 
    UInt getWidth() const;
 
    UInt getHeight() const;
 
    void setPixelSize(double x, double y, const std::string& unit = "micrometer");
 
    double getPixelSizeX() const;
 
    double getPixelSizeY() const;
 
    const std::string& getPixelSizeUnit() const;
 
    void addPixel(UInt x, UInt y, Size spectrum_index);
 
    bool hasPixel(UInt x, UInt y) const;
 
    Size getSpectrumIndex(UInt x, UInt y) const;
 
    const std::vector<Pixel>& getPixels() const;
 
    Size getNumberOfPixels() const;
 
    void clear();
 
  private:
    UInt width_ = 0;
    UInt height_ = 0;
    double pixel_size_x_ = 1.0;
    double pixel_size_y_ = 1.0;
    std::string pixel_size_unit_ = "micrometer";
    std::vector<Pixel> pixels_;
    std::unordered_map<UInt64, Size> lookup_;
 
    static UInt64 packKey_(UInt x, UInt y);
  };
 
} // namespace OpenMS