hfl_frame.h

Go to the documentation of this file.

// Copyright 2020 Continental AG
// All rights reserved.
//
// Software License Agreement (BSD 2-Clause Simplified License)
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above
//    copyright notice, this list of conditions and the following
//    disclaimer in the documentation and/or other materials provided
//    with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.



#ifndef HFL_FRAME_H_
#define HFL_FRAME_H_
#include <hfl_pixel.h>

#include <string>
#include <vector>

namespace hfl
{
using Row = uint16_t;

using Col = uint16_t;

class Frame
{
public:
  std::string id_;

  uint16_t intensity_bits_;

  uint16_t range_bits_;

  uint16_t range_precision_bits_;

  uint16_t intensity_publish_bits_;

  Frame(uint16_t height, uint16_t width, uint16_t returns_size, uint16_t slices_size);

  Pixel& atPixel(Col x, Row y);

  size_t getHeight() const
  {
    return height_;
  }

  size_t getWidth() const
  {
    return width_;
  }

  size_t getSize() const
  {
    return height_ * width_;
  }

  size_t getSlicesSize() const
  {
    return slices_size_;
  }

private:
  size_t height_;

  size_t width_;

  size_t returns_size_;

  size_t slices_size_;

  std::vector<std::vector<Pixel>> pixels;
};

}  // namespace hfl
#endif  // HFL_FRAME_H_