|
| | BasicCamera (const std::string szCameraPath, const int nPropResolutionX, const int nPropResolutionY, const int nPropFramesPerSecond, const PIXEL_FORMATS ePropPixelFormat, const double dPropHorizontalFOV, const double dPropVerticalFOV, const bool bEnableRecordingFlag, const int nNumFrameRetrievalThreads) |
| | Construct a new Basic Camera object.
|
| |
| | BasicCamera (const int nCameraIndex, const int nPropResolutionX, const int nPropResolutionY, const int nPropFramesPerSecond, const PIXEL_FORMATS ePropPixelFormat, const double dPropHorizontalFOV, const double dPropVerticalFOV, const bool bEnableRecordingFlag, const int nNumFrameRetrievalThreads) |
| | Construct a new Basic Camera object. Overloaded for dev/video indexes.
|
| |
| virtual | ~BasicCamera () |
| | Destroy the Basic Camera object.
|
| |
| virtual void | ThreadedContinuousCode () |
| | The code inside this private method runs in a separate thread, but still has access to this*. This method continuously get new frames from the OpenCV VideoCapture object and stores it in a member variable. Then a thread pool is started and joined once per iteration to mass copy the frames and/or measure to any other thread waiting in the queues.
|
| |
| virtual void | PooledLinearCode () |
| | This method holds the code that is ran in the thread pool started by the ThreadedLinearCode() method. It copies the data from the different data objects to references of the same type stored in a vector queued up by the Grab methods.
|
| |
| std::future< bool > | RequestFrameCopy (cv::Mat &cvFrame) override=0 |
| | Puts a frame pointer into a queue so a copy of a frame from the camera can be written to it. Remember, this code will be ran in whatever, class/thread calls it.
|
| |
| virtual std::string | GetCameraLocation () const |
| | Accessor for the cameras path or video index.
|
| |
| | Camera (const int nPropResolutionX, const int nPropResolutionY, const int nPropFramesPerSecond, const PIXEL_FORMATS ePropPixelFormat, const double dPropHorizontalFOV, const double dPropVerticalFOV, const bool bEnableRecordingFlag, const int nNumFrameRetrievalThreads=5) |
| | Construct a new Camera object.
|
| |
| virtual | ~Camera () |
| | Destroy the Camera object.
|
| |
| cv::Size | GetPropResolution () const |
| | Accessor for the Prop Resolution private member.
|
| |
| int | GetPropFramesPerSecond () const |
| | Accessor for the Prop Frames Per Second private member.
|
| |
| PIXEL_FORMATS | GetPropPixelFormat () const |
| | Accessor for the Prop Pixel Format private member.
|
| |
| double | GetPropHorizontalFOV () const |
| | Accessor for the Prop Horizontal F O V private member.
|
| |
| double | GetPropVerticalFOV () const |
| | Accessor for the Prop Vertical F O V private member.
|
| |
| bool | GetEnableRecordingFlag () const |
| | Accessor for the Enable Recording Flag private member.
|
| |
| void | SetEnableRecordingFlag (const bool bEnableRecordingFlag) |
| | Mutator for the Enable Recording Flag private member.
|
| |
| virtual bool | GetCameraIsOpen ()=0 |
| | Accessor for the Camera Is Open private member.
|
| |
| | AutonomyThread () |
| | Construct a new Autonomy Thread object.
|
| |
| virtual | ~AutonomyThread () |
| | Destroy the Autonomy Thread object. If the parent object or main thread is destroyed or exited while this thread is still running, a race condition will occur. Stopping and joining the thread here insures that the main program can't exit if the user forgot to stop and join the thread.
|
| |
| void | Start () |
| | When this method is called, it starts a new thread that runs the code within the ThreadedContinuousCode method. This is the users main code that will run the important and continuous code for the class.
|
| |
| void | RequestStop () |
| | Signals threads to stop executing user code, terminate. DOES NOT JOIN. This method will not force the thread to exit, if the user code is not written properly and contains WHILE statement or any other long-executing or blocking code, then the thread will not exit until the next iteration.
|
| |
| void | Join () |
| | Waits for thread to finish executing and then closes thread. This method will block the calling code until thread is finished.
|
| |
| bool | Joinable () const |
| | Check if the code within the thread and all pools created by it are finished executing and the thread is ready to be closed.
|
| |
| AutonomyThreadState | GetThreadState () const |
| | Accessor for the Threads State private member.
|
| |
| IPS & | GetIPS () |
| | Accessor for the Frame I P S private member.
|
| |
|
| enum | AutonomyThreadState |
| |
| void | RunPool (const unsigned int nNumTasksToQueue, const unsigned int nNumThreads=2, const bool bForceStopCurrentThreads=false) |
| | When this method is called, it starts/adds tasks to a thread pool that runs nNumTasksToQueue copies of the code within the PooledLinearCode() method using nNumThreads number of threads. This is meant to be used as an internal utility of the child class to further improve parallelization. Default value for nNumThreads is 2.
|
| |
| void | RunDetachedPool (const unsigned int nNumTasksToQueue, const unsigned int nNumThreads=2, const bool bForceStopCurrentThreads=false) |
| | When this method is called, it starts a thread pool full of threads that don't return std::futures (like a placeholder for the thread return type). This means the thread will not have a return type and there is no way to determine if the thread has finished other than calling the Join() method. Only use this if you want to 'set and forget'. It will be faster as it doesn't return futures. Runs PooledLinearCode() method code. This is meant to be used as an internal utility of the child class to further improve parallelization.
|
| |
| void | ParallelizeLoop (const int nNumThreads, const N tTotalIterations, F &&tLoopFunction) |
| | Given a ref-qualified looping function and an arbitrary number of iterations, this method will divide up the loop and run each section in a thread pool. This function must not return anything. This method will block until the loop has completed.
|
| |
| void | ClearPoolQueue () |
| | Clears any tasks waiting to be ran in the queue, tasks currently running will remain running.
|
| |
| void | JoinPool () |
| | Waits for pool to finish executing tasks. This method will block the calling code until thread is finished.
|
| |
| bool | PoolJoinable () const |
| | Check if the internal pool threads are done executing code and the queue is empty.
|
| |
| void | SetMainThreadIPSLimit (int nMaxIterationsPerSecond=0) |
| | Mutator for the Main Thread Max I P S private member.
|
| |
| int | GetPoolNumOfThreads () |
| | Accessor for the Pool Num Of Threads private member.
|
| |
| int | GetPoolQueueLength () |
| | Accessor for the Pool Queue Size private member.
|
| |
| std::vector< void > | GetPoolResults () |
| | Accessor for the Pool Results private member. The action of getting results will destroy and remove them from this object. This method blocks if the thread is not finished, so no need to call JoinPool() before getting results.
|
| |
| int | GetMainThreadMaxIPS () const |
| | Accessor for the Main Thread Max I P S private member.
|
| |
This class serves as a middle inheritor between the Camera interface and the BasicCam class. BasicCam and SIMBasicCam will inherit from this.
- Author
- clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)
- Date
- 2024-12-22
Public Member Functions inherited from Camera< cv::Mat >
1.9.8