msiImageScale ( msParam_t *  sourceParam,
msParam_t *  sourceProp,
msParam_t *  xScaleFactor,
msParam_t *  yScaleFactor,
msParam_t *  destParam,
msParam_t *  destProp,
ruleExecInfo_t *  rei 
)
Description:
Read a source image file, scale it up or down in size, and write it out as a new image file in a chosen format.
Module:
image
Since:
pre-2.1
Author:
David R. Nadeau / University of California, San Diego
Date:
2007
Note:
The source and destination image files may be specified as:
  • A string file path
  • An integer file descriptor for an open file
  • A data object
The destination file will be created if needed.
The source and destination files have optional property lists. The source property list may select the file format to use and which image in a file to read (if the file contains multiple images). The destination property list may select the file format to write and compression flags to use. EXIF tags in the destination property list will be added to the image if they don't conflict with the output format and if the output format supports them.
The source image is scaled by the given X and Y scale factors.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] sourceParam - the source file
[in] sourceProp - the source properties
[in] xScaleFactor - the X scale factor
[in] yScaleFactor - the Y scale factor
[in] destParam - the destination file
[in] destProp - the destination properties
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
none
Session Variables Modified:
none
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
none

Definition at line 358 of file imageMS.c.

Generated on Tue May 14 16:56:43 2013 for iRODS Documentation by  doxygen 1.6.3