Digital

NAME

XieConstrain − This routine creates a constrained copy of a source image. 

C Format

dst_photo_id = XieConstrain(src_id, model, levels)

C Argument Information

XiePhoto     dst_photo_id;
XiePhoto     src_id;
int        model;
unsigned long int levels[];

RETURN VALUES

If the source image is an unbound photomap, the routine returns the identifier of the newly created image in the dst_photo_id argument. Otherwise, the routine returns the identifier of the photoflo to which the routine is appended.  You can free the photomap using the XieFreeResource routine. 

PARAMETERS

src_idThe src_id argument specifies the source image.  If the image is an unbound photomap, the operation is performed immediately.  Otherwise, a processing element is appended to the specified photoflo with execution pending a call to the XieExecuteFlo routine.  The photoflo is specified explicitly if the source image is a photoflo, or implicitly if the source image is a photomap or phototap bound to the photoflo. 

modelThe model argument specifies the constraint model the routine uses to convert the source image.  If you specify a value of 0, the routine ignores the levels argument and uses the session default constraint model. See the XieSetOpDefaults routine for more information. 

levelsThe levels argument specifies the address of an array that defines the number of levels to which each component is constrained. This array must be at least XieK_MaxComponents elements in length.  The routine ignores this argument if you specify a value of 0 for the model argument. 

DESCRIPTION

This routine creates a constrained copy of a source image.  The routine constrains the image based on the specified constraint model and number of levels. If the source image is already constrained, the routine first converts the data to be unconstrained before reconstraining it. 

If the operation is performed immediately and you selected computation events using the XieSelectEvents routine, the routine adds an XieK_ComputationEvent to the X11 event queue when the routine is completed. 

XIE Events and Error Messages

Protocol Messages: X_ieConstrain

XIE event returned: XieK_ComputationEvent if immediate execution and computation events are selected

XieLib errors: None

XieServer errors: BadIDChoice -- Invalid identifier

BadAlloc -- Insufficient server resources

BadValue -- Invalid constraint model