allwpilib/wpilibc/athena/include/vision/VisionPipeline.h

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2016-2017. All Rights Reserved.                        */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project.                                                               */
/*----------------------------------------------------------------------------*/

#pragma once

namespace cv {
class Mat;
}

namespace frc {

/**
 * A vision pipeline is responsible for running a group of
 * OpenCV algorithms to extract data from an image.
 *
 * @see VisionRunner
 */
class VisionPipeline {
 public:
  virtual ~VisionPipeline() = default;

  /**
   * Processes the image input and sets the result objects.
   * Implementations should make these objects accessible.
   */
  virtual void Process(cv::Mat& mat) = 0;
};
}  // namespace frc