---
name: "gpiv_img2gpiv"
section: "1"
platform: "linux"
package: "gpivtools"
version: "0.6.0-3.1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/gpiv_img2gpiv"
---

# gpiv\_img2gpiv(1)

Converts images into raw data (extension .r) format with the belonging ASCII header file (extension .h) or into the hdf format (extension .hdf).

## NAME

gpiv\_img2gpiv - Converts images into raw data (extension .r) format with the  belonging ASCII header file (extension .h) or into the hdf format  (extension .hdf).

## SYNOPSIS

**gpiv\_img2gpiv** \[**-x** \| **--cross**\] \[**-c** \| **--cols** *ncolumns*\]  \[**--combine**\] \[**-h** \| **--help**\]  \[**-hdf**\]  \[**--suf\_a** *EXT*\] \[**--suf\_b** *EXT*\] \[**--suf\_num** *N*\] \[**-i** \| **--inverse**\] \[**-n**\]  \[**-p**\]  \[**-r** \| **--rows** *nrows*\]  \[**-t**\]  \[**-v** \| **--version**\] file\_base\_name

## DESCRIPTION

**gpiv\_img2gpiv converts images from a common image format (gif, tif etc)** **into a raw data image with extension .r**. Additionally, it generates an ASCII header file (extension **.h**). This header contains information concerning image dimensions, color depth, single or double image (for auto or cross-correlation), time and spatial scales, position of pixel# (0, 0) in the experiment and some additional (non-required) parameters.

*gpiv\_img2gpiv* may also convert to hdf formatted images, with extension  **.hdf**, that might be used by gpiv.

This program does not use the parameter resources from libgpiv. The default settings may be overruled by the command line options, as explained below.

## Options

-

  - **-c** \| **--cols** *ncolumns*

  The number of columns of the image (default 1280).

- **--combine**

  If the images have been obtained separately, but will have to be used for cross-correlation, they will be combined to a single image file for interrogating with **gpiv\_rr** (or **gpiv**). See also **--suf\_a/b** and **--suf\_num**.

- **-h** \| **--help**

  On-line help.

- **-hdf**

  **Converts to (or from) hdf formatted data (extension .hdf**).

- **-i** \| **--inverse**

  Inverse conversion; from raw 8-bit data to image format.

- **--suf\_a** *EXT*

  In combination with **--combine**: the file\_base\_name of the first frame to be combined is extended with suffix *EXT* (default: \_a).

- **--suf\_b** *EXT*

  In combination with **--combine**: the file\_base\_name of the second  frame to be combined is extended with suffix *EXT* (default: \_b).

- **--suf\_num** *N*

  In combination with **--combine**: If images are numbered instead of with **--suf\_a** and **--suf\_b**. *N* represents the first of the two numbered frames which will be combined with frame *N* + 1. The combined image will be named to file\_base\_name*N***.r**. So, only odd or even numbered images will result to be loaded in **gpiv\_rr** (or **gpiv**) for cross-correlation.

- **-n**

  No execute, only print processes.

- **-p**

  Prints process to stdout.

- **-r** \| **--rows**

  *nrows* The number of rows in the frame of a SINGLE image (default 1024).  An image frame containing a PIV pair of images (to be used for cross-correlation) should have the double amount of rows; from row #0 to row #*nrows* - 1 contains the first image and from row #*nrows* to row #2x*nrows* - 1 contains the second image.

- **-t**

  Image type or format (default bmp).

- **-v** \| **--version**

  Print version information on standard output, then exit successfully.

- **-x** \| **--cross**

  Double image for cross-correlation (default: single image for auto-correlation).

## SEE ALSO

gpivtools

## NOTES

The program uses **convert**.

## AUTHOR

Gerber Van der Graaf