Triclops SDK
4.0.3.0
triclopsrectify.h
Go to the documentation of this file.
1 //=============================================================================
2 // Copyright © 2016 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
3 //
4 // This software is the confidential and proprietary information of FLIR
5 // Integrated Imaging Solutions, Inc. ("Confidential Information"). You
6 // shall not disclose such Confidential Information and shall use it only in
7 // accordance with the terms of the license agreement you entered into
8 // with FLIR Integrated Imaging Solutions, Inc. (FLIR).
9 //
10 // FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
11 // SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
12 // IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
13 // PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
14 // SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
15 // THIS SOFTWARE OR ITS DERIVATIVES.
16 //=============================================================================
17 
18 //=============================================================================
19 // $Id: triclopsrectify.h 309688 2016-12-21 18:28:11Z silvanoa $
20 //=============================================================================
21 
22 //=============================================================================
25 //=============================================================================
26 
27 #ifndef TRICLOPSRECTIFY_H
28 #define TRICLOPSRECTIFY_H
29 
30 //=============================================================================
31 // Project Includes
32 //=============================================================================
33 #include <triclops.h>
34 
35 #ifdef __cplusplus
36 extern "C"
37 {
38 #endif
39 
40 //=============================================================================
41 // Rectification and Camera Geometry
42 //=============================================================================
43 // Group = Rectification Configuration
44  // start of group RectificationConfiguration
56 
82 enum TriclopsError
84  int nSrcRows,
85  int nSrcCols);
86 
105 enum TriclopsError
107  TriclopsROI roi);
108 
124 enum TriclopsError
126  TriclopsBool roiOn);
127 
143 enum TriclopsError
145  int nrows,
146  int ncols);
147 
192 enum TriclopsError
194  int nrows,
195  int ncols,
196  int nInputRows,
197  int nInputCols);
198 
212 enum TriclopsError
214  int *nSrcRows,
215  int *nSrcCols);
216 
233 enum TriclopsError
235  int *nrows,
236  int *ncols);
237 
253 enum TriclopsError
255  TriclopsROI *roi);
256 
268 enum TriclopsError
270  TriclopsBool *roiOn);
271 
272  // End of RectificationConfiguration
274 
275 //=============================================================================
276 // Rectification
277 //=============================================================================
278 //
279 // Group = Rectification
280 
297 enum TriclopsError
299  TriclopsBool on);
300 
312 enum TriclopsError
313 triclopsGetRectify(const TriclopsContext context,
314  TriclopsBool *on);
315 
351 enum TriclopsError
353  TriclopsCamera camera,
355  TriclopsColorImage *output);
356 
357 
389 enum TriclopsError
391  TriclopsCamera camera,
392  float rowIn,
393  float colIn,
394  float *rowOut,
395  float *colOut);
396 
431 enum TriclopsError
433  TriclopsCamera camera,
434  float rowIn,
435  float colIn,
436  float *rowOut,
437  float *colOut);
438  // End of Rectification
440 
441 //=============================================================================
442 // Configuration
443 //=============================================================================
444 //
445 // Group = CameraConfiguration
446 
468 enum TriclopsError
470  float *baseline);
471 
489 enum TriclopsError
491  float *focallength);
492  // End of CameraConfiguration
494 
525 enum TriclopsError
527  float *aspectRatio);
528 
546 enum TriclopsError
548  int ncols,
549  int *nrows);
550 
568 enum TriclopsError
570  int nrows,
571  int *ncols);
572  // End of AspectRatio
574 #ifdef __cplusplus
575 }
576 #endif
577 
578 #endif // #ifndef TRICLOPSRECTIFY_H
Color image pair for stereo computation.
Definition: triclopstype.h:133
enum TriclopsError triclopsRectifyColorImage(TriclopsContext context, TriclopsCamera camera, TriclopsColorStereoPair *input, TriclopsColorImage *output)
Rectifies a raw color image.
Definition: triclopsrectify.cpp:71
32-bit RGBU color image structure
Definition: triclopstype.h:113
enum TriclopsError triclopsGetCalAspectRatio(const TriclopsContext context, float *aspectRatio)
Retrieves the aspect ratio of the calibrated camera.
Definition: triclopsrectify.cpp:345
Region of Interest (ROI) structure.
Definition: triclopstype.h:144
TriclopsCamera
Sensor definition enumerator.
Definition: triclopsenum.h:136
enum TriclopsError triclopsGetOptimalNumRows(const TriclopsContext context, int ncols, int *nrows)
Determines the optimal number of rows.
Definition: triclopsrectify.cpp:359
enum TriclopsError triclopsGetResolution(const TriclopsContext context, int *nrows, int *ncols)
Retrieves the output resolution.
Definition: triclopsrectify.cpp:214
TriclopsError
Error enumerator.
Definition: triclopserror.h:46
void * TriclopsContext
Wrapper for the internal C++ Triclops context.
Definition: triclopstype.h:54
enum TriclopsError triclopsSetSourceResolution(TriclopsContext context, int nSrcRows, int nSrcCols)
Sets the resolution of the raw images that the library will be processing later.
Definition: triclopsrectify.cpp:93
enum TriclopsError triclopsGetRectify(const TriclopsContext context, TriclopsBool *on)
Retrieves the state of the rectification feature.
Definition: triclopsrectify.cpp:249
enum TriclopsError triclopsUnrectifyPixel(const TriclopsContext context, TriclopsCamera camera, float rowIn, float colIn, float *rowOut, float *colOut)
Converts a pixel location from the rectified image to that of the unrectified image.
Definition: triclopsrectify.cpp:324
enum TriclopsError triclopsRectifyPixel(const TriclopsContext context, TriclopsCamera camera, float rowIn, float colIn, float *rowOut, float *colOut)
Converts a pixel location from the unrectified image to that of the rectified image.
Definition: triclopsrectify.cpp:296
enum TriclopsError triclopsSetResolution(TriclopsContext context, int nrows, int ncols)
Sets the resolution of the resultant images. This includes rectified, disparity and edge images...
Definition: triclopsrectify.cpp:108
enum TriclopsError triclopsGetBaseline(const TriclopsContext context, float *baseline)
Retrieves the baseline of the cameras.
Definition: triclopsrectify.cpp:263
enum TriclopsError triclopsSetRectify(TriclopsContext context, TriclopsBool on)
Turns rectification on or off.
Definition: triclopsrectify.cpp:235
enum TriclopsError triclopsPrepareRectificationData(TriclopsContext context, int nrows, int ncols, int nInputRows, int nInputCols)
Sets the resolution of the resultant images and prepare data for rectrification.
Definition: triclopsrectify.cpp:122
enum TriclopsError triclopsGetRoi(TriclopsContext context, TriclopsROI *roi)
Retrieves the region of interest.
Definition: triclopsrectify.cpp:154
enum TriclopsError triclopsGetOptimalNumColumns(const TriclopsContext context, int nrows, int *ncols)
Determines the optimal number of columns.
Definition: triclopsrectify.cpp:374
Triclops operations API.
enum TriclopsError triclopsGetRoiOn(TriclopsContext context, TriclopsBool *roiOn)
Retrieves the state of the rectification in a region of interest.
Definition: triclopsrectify.cpp:184
enum TriclopsError triclopsSetRoiOn(TriclopsContext context, TriclopsBool roiOn)
Enables rectification in a region of interest.
Definition: triclopsrectify.cpp:169
enum TriclopsError triclopsSetRoi(TriclopsContext context, TriclopsROI roi)
Sets the region of interest.
Definition: triclopsrectify.cpp:140
enum TriclopsError triclopsGetSourceResolution(const TriclopsContext context, int *nSrcRows, int *nSrcCols)
Retrieves the current resolution for raw images.
Definition: triclopsrectify.cpp:199
int TriclopsBool
Boolean type definition kept for legacy purposes.
Definition: triclopstype.h:47
enum TriclopsError triclopsGetFocalLength(const TriclopsContext context, float *focallength)
Retrieves the focal length of the cameras.
Definition: triclopsrectify.cpp:277
Contact Support Triclops SDK Programmer's Guide and API Reference