Triclops SDK
4.0.3.0
triclopsimageio.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: triclopsimageio.h 309688 2016-12-21 18:28:11Z silvanoa $
20 //=============================================================================
21 
22 //=============================================================================
25 //=============================================================================
26 
27 #ifndef TRICLOPSIMAGEIO_H
28 #define TRICLOPSIMAGEIO_H
29 
30 //=============================================================================
31 // Project Includes
32 //=============================================================================
33 #include "triclops.h"
34 
35 #ifdef __cplusplus
36 extern "C"
37 {
38 #endif
39 
40 //=============================================================================
41 // Image I/O Operations
42 //=============================================================================
43 // Group = Image I/O Operations
44 
89 enum TriclopsError
90 triclopsGetImage(const TriclopsContext context,
91  TriclopsImageType imageType,
92  TriclopsCamera camera,
93  TriclopsImage *image);
115 enum TriclopsError
117  TriclopsImage *right,
118  TriclopsImage *left,
119  TriclopsMonoStereoPair *triclopsInput);
120 
139 enum TriclopsError
141  const char *filename,
142  TriclopsMonoStereoPair *triclopsInput);
163 enum TriclopsError
165  TriclopsColorImage *right,
166  TriclopsColorImage *left,
167  TriclopsColorStereoPair *triclopsInput);
168 
191 enum TriclopsError
193  const char *filename,
194  TriclopsColorPixelFormat pixelFormat,
195  TriclopsColorStereoPair *triclopsInput);
196 
213 enum TriclopsError
215  bool isSingleBuffer);
216 
230 enum TriclopsError
232  bool isSingleBuffer);
233 
254 enum TriclopsError
255 triclopsGetImage16(const TriclopsContext context,
256  TriclopsImage16Type imageType,
257  TriclopsCamera camera,
258  TriclopsImage16 *image);
259 
280 enum TriclopsError
282  TriclopsColorImageType imageType,
283  TriclopsCamera camera,
284  TriclopsColorImage *image);
285 
302 enum TriclopsError
304  const char *filename);
305 
322 enum TriclopsError
324  const char *filename);
325 
346 enum TriclopsError
348  const char *filename,
349  TriclopsColorPixelFormat pixelFormat);
350 
372 enum TriclopsError
373 triclopsLoadImageFromFile(const char *filename, TriclopsImage *image);
374 
396 enum TriclopsError
397 triclopsLoadImageFromBuffer(unsigned char *buffer,
398  unsigned int nrows,
399  unsigned int ncols,
400  unsigned int rowinc,
401  TriclopsImage *image);
402 
423 enum TriclopsError
424 triclopsLoadImage16FromFile(const char *filename, TriclopsImage16 *image);
425 
447 enum TriclopsError
448 triclopsLoadImage16FromBuffer(unsigned short *buffer,
449  unsigned int nrows,
450  unsigned int ncols,
451  unsigned int rowinc,
452  TriclopsImage16 *image);
453 
476 enum TriclopsError
477 triclopsLoadColorImageFromFile(const char *filename,
478  TriclopsColorPixelFormat pixelFormat,
479  TriclopsColorImage *image);
480 
502 enum TriclopsError
504  unsigned int nrows,
505  unsigned int ncols,
506  unsigned int rowinc,
507  TriclopsColorImage *image);
508  // End of group TriclopsImage
510 
511 #ifdef __cplusplus
512 }
513 #endif
514 
515 #endif // #ifndef TRICLOPSIMAGEIO_H
Color image pair for stereo computation.
Definition: triclopstype.h:133
enum TriclopsError triclopsBuildColorStereoPairFromFile(const TriclopsContext context, const char *filename, TriclopsColorPixelFormat pixelFormat, TriclopsColorStereoPair *triclopsInput)
Loads a color picture from file in a side-by-side structure.
Definition: triclopsimageio.cpp:128
Greyscale image pair for stereo computation.
Definition: triclopstype.h:124
TriclopsImageType
8-bit per pixel image type enumerator
Definition: triclopsenum.h:52
32-bit RGBU color image structure
Definition: triclopstype.h:113
enum TriclopsError triclopsSaveColorImage(TriclopsColorImage *image, const char *filename, TriclopsColorPixelFormat pixelFormat)
Saves a color image to memory.
Definition: triclopsimageio.cpp:203
TriclopsCamera
Sensor definition enumerator.
Definition: triclopsenum.h:136
16-bit greyscale image structure
Definition: triclopstype.h:79
TriclopsColorImageType
32-bit per pixel image type enumerator
Definition: triclopsenum.h:99
TriclopsImage16Type
16-bit per pixel image type enumerator
Definition: triclopsenum.h:79
enum TriclopsError triclopsGetImage(const TriclopsContext context, TriclopsImageType imageType, TriclopsCamera camera, TriclopsImage *image)
Retrieves an 8-bit greyscale image form a context.
Definition: triclopsimageio.cpp:35
enum TriclopsError triclopsSaveImage(TriclopsImage *image, const char *filename)
Saves a greyscale image to memory.
Definition: triclopsimageio.cpp:151
TriclopsError
Error enumerator.
Definition: triclopserror.h:46
enum TriclopsError triclopsLoadImageFromFile(const char *filename, TriclopsImage *image)
Load a 8bit image from a file.
Definition: triclopsimageio.cpp:284
enum TriclopsError triclopsLoadImage16FromBuffer(unsigned short *buffer, unsigned int nrows, unsigned int ncols, unsigned int rowinc, TriclopsImage16 *image)
Load a 16-bit image from a buffer.
Definition: triclopsimageio.cpp:351
enum TriclopsError triclopsGetColorImage(const TriclopsContext context, TriclopsColorImageType imageType, TriclopsCamera camera, TriclopsColorImage *image)
Retrieves a 32-bit color image form a context.
Definition: triclopsimageio.cpp:184
enum TriclopsError triclopsFreeMonoStereoPair(TriclopsMonoStereoPair *stereoPair, bool isSingleBuffer)
Releases a greyscale side-by-side image structure.
Definition: triclopsimageio.cpp:242
enum TriclopsError triclopsBuildColorStereoPairFromBuffers(const TriclopsContext context, TriclopsColorImage *right, TriclopsColorImage *left, TriclopsColorStereoPair *triclopsInput)
Joins two color images in a single side-by-side structure.
Definition: triclopsimageio.cpp:81
void * TriclopsContext
Wrapper for the internal C++ Triclops context.
Definition: triclopstype.h:54
enum TriclopsError triclopsBuildMonoStereoPairFromFile(const TriclopsContext context, const char *filename, TriclopsMonoStereoPair *triclopsInput)
Loads a greyscale picture from file in a side-by-side structure.
Definition: triclopsimageio.cpp:107
enum TriclopsError triclopsLoadImageFromBuffer(unsigned char *buffer, unsigned int nrows, unsigned int ncols, unsigned int rowinc, TriclopsImage *image)
Load a 8-bit image from a buffer.
Definition: triclopsimageio.cpp:303
enum TriclopsError triclopsBuildMonoStereoPairFromBuffers(const TriclopsContext context, TriclopsImage *right, TriclopsImage *left, TriclopsMonoStereoPair *triclopsInput)
Joins two greyscale images in a single side-by-side structure.
Definition: triclopsimageio.cpp:55
enum TriclopsError triclopsLoadImage16FromFile(const char *filename, TriclopsImage16 *image)
Load a 16-bit image from a file.
Definition: triclopsimageio.cpp:332
TriclopsColorPixelFormat
Color pixel structure enumerator.
Definition: triclopsenum.h:121
Triclops operations API.
enum TriclopsError triclopsLoadColorImageFromFile(const char *filename, TriclopsColorPixelFormat pixelFormat, TriclopsColorImage *image)
Load a color image from a file.
Definition: triclopsimageio.cpp:380
8-bit greyscale image structure
Definition: triclopstype.h:62
enum TriclopsError triclopsFreeColorStereoPair(TriclopsColorStereoPair *stereoPair, bool isSingleBuffer)
Releases a color side-by-side image structure.
Definition: triclopsimageio.cpp:263
enum TriclopsError triclopsGetImage16(const TriclopsContext context, TriclopsImage16Type imageType, TriclopsCamera camera, TriclopsImage16 *image)
Retrieves a 16-bit greyscale image form a context.
Definition: triclopsimageio.cpp:222
Single colored pixel helper structure.
Definition: triclopstype.h:97
enum TriclopsError triclopsSaveImage16(TriclopsImage16 *image, const char *filename)
Saves a 16-bit image to memory.
Definition: triclopsimageio.cpp:167
enum TriclopsError triclopsLoadColorImageFromBuffer(TriclopsColorPixel *buffer, unsigned int nrows, unsigned int ncols, unsigned int rowinc, TriclopsColorImage *image)
Load a color image from a buffer.
Definition: triclopsimageio.cpp:401
Contact Support Triclops SDK Programmer's Guide and API Reference