|
enum TriclopsError | triclopsSetColorImageBuffer (TriclopsContext context, TriclopsCamera camera, TriclopsColorPixel *buffer) |
| Allows the user to set the buffer to which the processed 32-bit color image is written to. More...
|
|
enum TriclopsError | triclopsSetImage16Buffer (TriclopsContext context, unsigned short *buffer, TriclopsImage16Type imageType, TriclopsCamera camera) |
| Sets the internal image buffer where 16-bit disparity images are written. More...
|
|
enum TriclopsError | triclopsSetImageBuffer (TriclopsContext context, unsigned char *buffer, TriclopsImageType imageType, TriclopsCamera camera) |
| Sets the internal image buffer for the specified camera and image type to be the buffer supplied by the user. More...
|
|
enum TriclopsError | triclopsUnsetColorImageBuffer (TriclopsContext context, TriclopsCamera camera) |
| Releases the user specified internal color image buffer for the specified camera. More...
|
|
enum TriclopsError | triclopsUnsetImage16Buffer (TriclopsContext context, TriclopsImage16Type imageType, TriclopsCamera camera) |
| Releases the 16-bit user internal buffer for the specific camera and image type. More...
|
|
enum TriclopsError | triclopsUnsetImageBuffer (TriclopsContext context, TriclopsImageType imageType, TriclopsCamera camera) |
| Releases the user specified internal buffer for the specific camera and image type. More...
|
|
Triclops provides functions to manage internal image buffers where to store images resulting from processing (i.e. rectified, edge and disparity images). These buffers are an alternative to those managed internally by the context. It will be the user-s responsability to allocate sufficient memory for the buffer, and to de-allocate the buffer after it is no longer needed.
Allows the user to set the buffer to which the processed 32-bit color image is written to.
This function allows the user to set the location to which 32-bit color images are written to once they are processed. Color images are associated to Disparity images are always associated with the reference camera. If the user has already called SetColorImageBuffer() for a particular camera and image type, the stereo kernel will be using that buffer for internal processing. If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call triclopsUnsetColorImageBuffer() to inform the stereo kernel that it is no longer available.
- Parameters
-
context | The context to set the 32-bit color buffer in. |
camera | The sensor for which to set the buffer |
buffer | A pointer to a user allocated buffer of sufficient size. |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The requested camera is invalid or cannot be associated to this buffer type |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- See also
- triclopsGetImage()
-
triclopsUnsetColorImageBuffer()
Sets the internal image buffer where 16-bit disparity images are written.
This function allows the user to set the location to which 16-bit (with subpixel interpolation) depth images are written to once they are processed. Disparity images are always associated with the reference camera. If the user has already called triclopsSetImage16Buffer() for a particular camera and image type, the stereo kernel will be using that buffer for internal processing. If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call triclopsUnsetImage16Buffer() to inform the stereo kernel that it is no longer available.
- Parameters
-
context | The context to set the 16-bit buffer in. |
buffer | A pointer to a user allocated buffer of sufficient size. |
imageType | The type of image to be written to the buffer. |
camera | The camera to write from. |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The requested camera is invalid or is not equal to the reference image. |
TriclopsErrorInvalidImageType | The requested image type is invalid or cannot be associated to the 16-bit buffers. |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- See also
- triclopsGetImage()
-
triclopsUnsetImage16Buffer()
Sets the internal image buffer for the specified camera and image type to be the buffer supplied by the user.
This function allows the user to specify directly what memory he/she wishes the output images to be deposited into. This memory will be used by the stereo kernel as working space. This has the advantage of saving a copy for tasks such as displaying to the screen. The user may simply set the output image buffer to his/her display buffer. However, since this memory will be used by the stereo kernel as working space, the contents of the buffer may change with each call of triclopsRecify() or triclopsStereo(). If the results are to be saved, it is the user's responsibility to do so. In addition, the user is responsible to allocate sufficient memory for the buffer, and to de-allocate the buffer after it is no longer needed. If the user has already called triclopsSetImageBuffer() for a particular camera and image type, the stereo kernel will be using that buffer for internal processing. If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call triclopsUnsetImageBuffer() to inform the stereo kernel that it is no longer available.
- Parameters
-
context | The input context to set the buffer in |
buffer | A pointer to a user allocated buffer of sufficient size. |
imageType | The image type. |
camera | The camera to which associate the raw image originated. |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The requested camera is invalid or cannot be associated to this buffer type |
TriclopsErrorInvalidImageType | The requested image type is invalid or buffers cannot be associated to the requested image type |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- See also
- triclopsGetImage()
-
triclopsUnsetImageBuffer()
Releases the user specified internal color image buffer for the specified camera.
If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call use this function to inform the stereo kernel that it is no longer available. A new buffer will be created for internal use, replacing the specified buffer. The user should call this function before de-allocating the buffer.
- Parameters
-
context | The input context to be informed the specified buffer is no longer available. |
camera | The camera |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The requested camera is invalid or is not equal to the reference image. |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- Returns
- TriclopsErrorBadMemoryAllocation The system returned an allocation error while requesting memory for the corresponding internal buffer
- See also
- triclopsGetImage()
-
triclopsSetColorImageBuffer()
Releases the 16-bit user internal buffer for the specific camera and image type.
If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call use this function to inform the stereo kernel that it is no longer available. A new buffer will be created for internal use, replacing the specified buffer. The user should call this function before de-allocating the buffer.
- Parameters
-
context | The input context to be infomed the specified buffer is no longer available. |
imageType | The image type. |
camera | The camera |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The requested camera is invalid or is not equal to the reference image. |
TriclopsErrorInvalidImageType | The requested image type is invalid or cannot be associated to the 16-bit buffers. |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- See also
- triclopsGetImage()
-
triclopsSetImage16Buffer()
Releases the user specified internal buffer for the specific camera and image type.
If the user no longer wants to have the supplied buffer used by the stereo kernel, he/she can call this function to inform the stereo kernel that it is no longer available. A new buffer will be created for internal use, replacing the specified buffer. The user should call this function before de-allocating the buffer.
- Parameters
-
context | The input context to be informed the specified buffer is no longer available. |
imageType | The image type. |
camera | The camera to which associate the raw image originated. |
- Returns
- An error code representing the outcome of the function
- Return values
-
TriclopsErrorOk | The function completed successfully |
TriclopsErrorInvalidContext | The provided context is invalid |
TriclopsErrorInvalidCamera | The input camera is invalid |
TriclopsErrorInvalidImageType | The requested image type is invalid or buffers cannot be associated to the requested image type |
TriclopsErrorInvalidResolution | The requested output resolution is invalid (i.e. either dimension is smaller than 1) |
- Returns
- TriclopsErrorBadMemoryAllocation The system returned an allocation error while requesting memory for the corresponding internal buffer
- See also
- triclopsGetImage()
-
triclopsSetImageBuffer()