Image

Load, save and manipulate 2D images. More...

Typedefs
typedef int	reme_image_t
	Handle referencing a 2D image object. More...
reme_error_t	reme_image_create (reme_context_t c, reme_image_t *i)
	Create a new empty image object. More...
reme_error_t	reme_image_destroy (reme_context_t c, reme_image_t *i)
	Destroy a previously created image object. More...
reme_error_t	reme_image_get_info (reme_context_t c, reme_image_t i, int *width=0, int *height=0, int *num_channels=0, int *num_bytes_per_channel=0, int *row_stride=0)
	Get image information such as size, channels and layout. More...
reme_error_t	reme_image_copy (reme_context_t c, reme_image_t src, reme_image_t dst)
	Copy content of one image to another. More...
reme_error_t	reme_image_save_to_file (reme_context_t c, reme_image_t i, const char *filename)
	Save the image in the desired format. More...
reme_error_t	reme_image_load_from_file (reme_context_t c, reme_image_t i, const char *filename)
	Load image from disk. More...
reme_error_t	reme_image_get_bytes (reme_context_t c, reme_image_t i, const void **pixels, int *length)
	Get image pixel data as byte array. More...
reme_error_t	reme_image_get_mutable_bytes (reme_context_t c, reme_image_t i, void **pixels, int *length)
	Get mutable image pixel data as byte array. More...

Detailed Description

Load, save and manipulate 2D images.

This modules provides methods to load, save and manipulate 2d images.

The example below illustrates the functionality.

    // Create a new context that has default options applied
    reme_context_t c;
    reme_context_create(&c);

    // Create a sensor using a saved data stream
    reme_sensor_t s;
    reme_sensor_create(c, "openni;mskinect;file", true,  &s);
    reme_sensor_open(c, s);

    // Create an image to hold the result
    reme_image_t i;
    reme_image_create(c, &i);

    int width, height, nchans;

    // Viewer for displaying up to 12 images in parallel
    reme_viewer_t v;
    reme_viewer_create_image(c, "Images", &v);
    reme_viewer_add_image(c, v, i);

    int counter = 0;
    while (REME_SUCCESS(reme_sensor_grab(c, s))) {
        // Update internal state of images
        reme_sensor_prepare_image(c, s, REME_IMAGE_AUX);

        // Receive the image into our image handle
        reme_sensor_get_image(c, s, REME_IMAGE_AUX, i);

        if (counter % 30 == 0) {

            // Derive the correct image format
            reme_image_get_info(c, i, &width, &height, &nchans);

            // Save image as PNG

            char buffer[50];
            sprintf(buffer, "image_%i.png", counter);

            reme_image_save_to_file(c, i, buffer);

            printf("Saved image (%ix%i - %i channels) to %s \n", width, height, nchans, buffer);
        }

        // Update the viewer
        reme_viewer_update(c, v);

        counter += 1;
    }

    // Print pending errors
    reme_context_print_errors(c);

    // Make sure to release all memory acquired
    reme_context_destroy(&c);

In case you want to acces the pixel data itself, you need to get a pointer to the internal data.

    const void *data;
    int width, height, length;

Next you use reme_image_get_bytes to access the data. In the following snipped OpenCV is used to perform something meaningful with the data.

        // Receive the pointer to the data
        reme_image_get_bytes(c, i, &data, &length);

        // Derive the correct image format
        reme_image_get_info(c, i, &width, &height);

        // In C++ we could now feed this to OpenCV for visualization
        cv::Mat rgb(height, width, CV_8UC3, (char*)data);
        cv::Mat bgr;
        cv::cvtColor(rgb, bgr, CV_RGB2BGR);
        cv::imshow("RGB", bgr);
        cv::waitKey(10);

Typedef Documentation

reme_image_t

typedef int reme_image_t

Handle referencing a 2D image object.

A reme_image_t represents a 2D image object.

Function Documentation

reme_image_create()

reme_error_t reme_image_create	(	reme_context_t	c,
		reme_image_t *	i
	)

Create a new empty image object.

Parameters

c	A valid context object
i	A pointer that will receive the handle of the created image

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_bust.cpp, example_reconstructmesdk_calibration.cpp, example_reconstructmesdk_color_tracking.cpp, example_reconstructmesdk_colorize.cpp, example_reconstructmesdk_image.cpp, example_reconstructmesdk_marker.cpp, example_reconstructmesdk_one_minute.cpp, example_reconstructmesdk_point_and_shoot_with_colors.cpp, example_reconstructmesdk_recorder.cpp, example_reconstructmesdk_remote_reconstruction.cpp, example_reconstructmesdk_scan_tilt.cpp, example_reconstructmesdk_sensor.cpp, example_reconstructmesdk_sensor_external.cpp, example_reconstructmesdk_sensor_multi_independent.cpp, example_reconstructmesdk_sensor_printing.cpp, example_reconstructmesdk_sensor_threaded.cpp, example_reconstructmesdk_surface.cpp, and example_reconstructmesdk_volume.cpp.

reme_image_destroy()

reme_error_t reme_image_destroy	(	reme_context_t	c,
		reme_image_t *	i
	)

Destroy a previously created image object.

Parameters

c	A pointer to a valid context object
i	A mutable pointer to a valid image handle to destroy

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

reme_image_get_info()

reme_error_t reme_image_get_info	(	reme_context_t	c,
		reme_image_t	i,
		int *	width = 0,
		int *	height = 0,
		int *	num_channels = 0,
		int *	num_bytes_per_channel = 0,
		int *	row_stride = 0
	)

Get image information such as size, channels and layout.

You can pass a zero pointer for those fields you are not interested in.

Parameters

c	A valid context object
i	A valid image object
width	Width of image in pixels
height	Height of image in pixels
num_channels	Number of channels per pixel
num_bytes_per_channel	Number of bytes per channel
row_stride	Distance between successive rows in bytes

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_image.cpp.

reme_image_copy()

reme_error_t reme_image_copy	(	reme_context_t	c,
		reme_image_t	src,
		reme_image_t	dst
	)

Copy content of one image to another.

Parameters

c	A valid context object
src	A valid image object
dst	A valid image object

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_remote_reconstruction.cpp.

reme_image_save_to_file()

reme_error_t reme_image_save_to_file	(	reme_context_t	c,
		reme_image_t	i,
		const char *	filename
	)

Save the image in the desired format.

The exporter is chosen based on the file extension. Currently supported are

• .PNG - Portable Network Graphics
• .BMP - Windows Bitmap
• .JPG - Jpeg

Parameters

c	A valid context object
i	A valid image object
filename	path to save image to

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_image.cpp, and example_reconstructmesdk_marker.cpp.

reme_image_load_from_file()

reme_error_t reme_image_load_from_file	(	reme_context_t	c,
		reme_image_t	i,
		const char *	filename
	)

Load image from disk.

The importer is chosen based on the file extension. Currently supported are

• .PNG - Portable Network Graphics
• .BMP - Windows Bitmap
• .JPG - Jpeg

Parameters

c	A valid context object
i	A valid image object
filename	path to save image to

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

reme_image_get_bytes()

reme_error_t reme_image_get_bytes	(	reme_context_t	c,
		reme_image_t	i,
		const void **	pixels,
		int *	length
	)

Get image pixel data as byte array.

Parameters

c	A valid context object
i	A valid image object
pixels	A mutable pointer that will receive the address of pixel array
length	A pointer that will receive the length of the array in bytes (use reme_image_get_info to derive the correct format)

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_image.cpp.

reme_image_get_mutable_bytes()

reme_error_t reme_image_get_mutable_bytes	(	reme_context_t	c,
		reme_image_t	i,
		void **	pixels,
		int *	length
	)

Get mutable image pixel data as byte array.

Parameters

c	A valid context object
i	A valid image object
pixels	A mutable pointer that will receive the address of pixel array
length	A pointer that will receive the length of the array in bytes (use reme_image_get_info to derive the correct format)

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_sensor_external.cpp.