# IMAGE

Image is used to capture image of specified quantity.

## Syntax

IMAGE(“name”) { parameters}

User-given name

## Parameters

name (string)
User-given name of the command. The instance of a given command is referenced using this parameter.
cut_planes (string)
Cut planes to include in the image
parts (string)
Parts to include in the image
iso_surfaces (string)
Iso surfaces to include in the image
streamlines (string)
Streamlines to include in the image
image_type (enum)
Type of images to be generated
Options: static, cut_plane_sweep, animation
views (string)
Views to capture the image from
sweep_planes (string)
Planes to use in sweep
sweep_range_type (enum)
Sweep range parameters
Options: direct, sweep_increment, number_of_sweep_locations
number_of_sweep_locations (integer)
Number of sweep locations to generate images from. Looks at model size to determine range then automatically sets the plane locations (computes interval by diving length by number of sweep locations).
sweep_increment (real)
Increment at which to generate images
sweep_range (sequence)
If type = direct comma separated values and sequences 1:10:3
clip_parts (boolean)
Clips part at location of sweep plane
Is based on view requested
reverse_clip_direction (boolean)
Reverses direction of clip part
vector_offset (real)
When using vector plane and slice plane, moves vector plane slightly
focal_parts (string)
Name of a part to zoom in on. The focal parts can be any of the names of the PART commands that exist in the .img file. There will be one for each view that is defined in the IMAGE command.
When no specific focal part is defined, the code fits the view and centers it to create the image. If a focal part is specified, the code zooms and centers on the focal part before generating the image.
zoom_factors (real)
Fit to focal part, then apply zoom factor.
If 1, then don’t zoom in. If less than 1, move the camera out, scaling the image.
active_flag (boolean)
Read and process the command or ignore it
annotate_time (boolean)
Print a note in the top right corner of the animation that shows the current solution time of each frame.
annotate_step (boolean)
Print a note in the top left corner of the animation that shows the current solution step of each frame.
start_frame (integer)
The solution step that marks the beginning of the animation.
end_frame (integer)
The solution step that marks the end of the animation.
frame_increment (integer)
The stride to take while sweeping through the solution steps.
frame_rate (integer)
The frame rate to control playback of the animation. Used only when creating mp4 files.

## Examples

IMAGE("Solid blades with mesh, transparent walls"){
"Tube - solid - transparent", "Outlet - solid - transparent",
"Tube - outline"}
"Downstream iso","Downstream iso"}
focal_parts                = {"_none"         , "Blades - solid","_none"   ,"Inlet - solid"}
zoom_factors               = {1.0, 1.0, 1.0, 1.0, 1.0, 1.25}
image_type                 = static
}
IMAGE("Cut plane animation"){
cut_planes                 = {"z-plane","User CP 1", "User CP 2", "User CP 3"}
parts                      = {"all - outline"}
views                      = {"iso view","+z"}
zoom_factors               = {1,0.9}
image_type		   = animation
annotate_time	       = on
annotate_step	       = on
start_frame		  = 1
end_frame		    = 10
frame_increment	     = 4
frame_rate                 = 5
}

An animation is created for each view that is listed in the views parameter. The frame_rate option is only valid when the -animation_format commanbd line option is set to mp4 (this is the default).

Animations are automatically embedded into the ppt files. If you request a PDF report, the animations are replaced by a still image.