file#
- class ansys.api.pyensight.ensight_api.file(session: Session)#
Class wrapper for EnSight file module
This class acts as a proxy for the EnSight Python module ensight.file
Methods
File: animation_color_type
Specify the name of the animation file when recording.
File: animation_format
File: animation_format_options
File: animation_frame_rate
Specify the number of frames to save when recording an animation.
File: animation_gamma
Specify whether to save multiple images when recording an animation (if you are displaying on multiple detached displays).
File: animation_numpasses
This command has not yet been documented.
File: animation_play_keyframe
This command has not yet been documented.
File: animation_raytrace_ext
File: animation_raytrace_it
File: animation_rend_offscreen
Specify whether to reset the flipbook as the animation is saved.
File: animation_reset_keyframe
Specify whether to reset the solution time as the animation is saved.
Specify whether to reset the animated particle traces as the animation is saved.
File: animation_saturation
file.animation_screen_tiling(p0, p1)File: animation_screen_tiling
File: animation_start_number
File: animation_stereo
Specify type (and thus in most cases the size) of the animation window to save when recording.
file.animation_window_xy(p0, p1)Specify resolution of the animation window to save - when using user_defined type.
File: context_restore_rescale
File: image_avi_type
File: image_bit_rate
Specify that the image will be printed in color or black and white
Change black backgrounds to white and change any white objects (geometry, plotters, annotations, etc.) to black.
Turn on/off encapsulation for postscript output
Set the envideo format compression scheme.
file.image_file(p0)Specify the filename to be used for image printing.
Specifies the file format to be used when an image is created.
This command has not yet been documented.
This command has not yet been documented.
file.image_gamma(p0)Set gamma correction value for PCL image files.
File: image_mpeg_type
Specify the number of rendering passes for anti-aliasing.
Sets the image orientation for PCL and Postscript image formats
When printing an image will turn invisible everything except for plotters.
For postscript format move-draw images turns on/off the removal of hidden geometry.
Include a windows preview image in an encapsulated postscript (eps) file.
For postscript format move-draw images turns on/off the subdivision of polygons for better shading.
Set the postscript output to move-draw or bitmap.
Specify the printer command to use when printing an image to a printer
Set the target printer for a PCL image file.
Sets the quality for JPEG images.
File: image_raytrace_external
File: image_raytrace_it
File: image_rend_offscreen
Desaturate color when saving an image to disk or printer.
To scale a postscript image for the page size.
file.image_screen_tiling(p0, p1)Create a multi-tile image suitable for display via EnVideo to a multi-tile (i.e., powerwall) display device.
Set stereo/mono output for the image file.
Specifies if the image should be saved to a disk file.
Specifies if the image should be printed directly to a printer.
File: image_transparent_back
When printing image based images sets the window (and thus image) size.
file.image_window_xy(p0, p1)Sets the image width and height if the user has specified a user_defined image size.
file.raytracer(p0)File: raytracer
File: raytracer_options
Restore a context file.
Restore an EnSight archive (restart) file.
This command has not yet been documented.
File: save_cmd_file
Save a context file.
Can specify the desired case to use, or all cases, when saving a context file.
Create an EnSight archive (restart) file.
File: save_geometric_entities
Save an image to a disk file.
Option to save a single image or multiple images for a flat-wall detached display.
File: save_scenario
Save a scenario file using all parts.
Save a scenario file using selected parts only.
Creates an executable by name of <pathname> containing the CEI application Reveal along with the currently specified scenario file.
Specifies the architecture for the 'file: save_scenario_png_format' command.
Save a scenario project using all parts.
Save a scenario project using selected parts only.
file.save_scenario_view(p0, p1)Save a view as part of an existing scenario file.
Save a view as part of an existing scenario file.
File: save_screen_to_clipboard
File: save_screen_to_file
file.scenario_desc_begin(args)Delimit the description for a scenario project.
Delimit the description for a scenario project.
When a scenario file/project is saved will determine if flipbook animation (if defined) will be included.
Sets the type of scenario format to use.
When a scenario file/project is saved will determine if keyframe animation (if defined) will be included.
file.scenario_simtime_anim(p0, p1, p2, p3)File: scenario_simtime_anim
file.scenario_steptime_anim(p0, p1, p2, p3)File: scenario_steptime_anim
When a scenario file/project is saved will determine if particle trace animation (if defined) will be included.
file.scenario_transient_anim(p0, p1, p2, p3)When a scenario csf file is saved, will determine if transient data (if available) will be included.
file.select_begin(*args, **kwargs)File: select_begin