Examples

Some examples require external input files. Before you start, please follow the link in the Example Scripts section to download the zip file with model and result files.

Example 01 - Capturing Images

Screenshots can be created using the CaptureImageTool class. First, an object of this class needs to be created. All the required properties of the screenshot (e.g. resolution, type, etc.) are defined as attributes of this object. In this example, the type is set to ‘jpg’ and the resolution to 1200x800. The file path is defined for each screenshot on the fly inside the for loop.

The code loops over the win_list (a list of all windows in the session created using the getWindows() Session method) to create a screenshot per window using the capture() method.

import hw

sess = hw.Session()
win_list = sess.getWindows()

capture = hw.CaptureImageTool()
capture.type = 'jpg'
capture.width = 1200
capture.height = 800

for i, win in enumerate(win_list):
    sess.setActive(hw.Window,window=win)
    capture.file=f"C:/Temp/screenshot_{i+1}"
    capture.capture()

Example 02 - Capturing Videos

Capturing result animations can be done using the CaptureImageTool class. For the example to work correctly, the code needs to be saved in a file and executed from the Python console using the magic command %run.

The example starts by defining the required path variables and setting up the window type to “animation” (i.e. the HyperView client). It proceeds with loading d3plot result files from the demos folder in the installation and displaying a contour plot of displacement magnitude. The orientation/view matrix is defined by calling the HWC view command via the evalHWC() function.

The key step follows - the creation of a CaptureImageTool object. The returned cvt1 object is used in a loop to capture the videos in three different formats (“avi”, “amf”, “gif”). The same approach is applied again afterwards - a second CaptureImageTool is created and used to generate the animation in the form of individual frame pictures in three different formats (“jpeg”, “png”, “bmp”).

Export all possible video formats from HyperView

import hw
import hw.hv as hv
import os

ALTAIR_HOME = os.path.abspath(os.environ["ALTAIR_HOME"])
modelFile = os.path.join(
    ALTAIR_HOME,
    "demos",
    "mv_hv_hg",
    "animation",
    "dyna",
    "bumper",
    "bumper_deck.key",
)
resultFile = os.path.join(
    ALTAIR_HOME, "demos", "mv_hv_hg", "animation", "dyna", "bumper", "d3plot"
)
scriptDir = os.path.normpath(os.path.abspath(os.path.dirname(__file__)))
exportDir = os.path.normpath(os.path.join(scriptDir, "Export"))

if not os.path.exists(exportDir):
    os.makedirs(exportDir)

ses = hw.Session()
ses.new()
page = ses.get(hw.Page)
win = ses.get(hw.Window)

win.type = "animation"

win.addModelAndResult(modelFile, result=resultFile)
res = ses.get(hv.Result)
resScalar = hv.ResultDefinitionScalar(dataType="Displacement", dataComponent="Mag")
res.plot(resScalar)

hw.evalHWC(
"view projection orthographic | \
view matrix -0.021537 0.988942 0.146732 \
                0.000000 0.872753 0.090190 \
                -0.479758 0.000000 -0.487686 \
                0.117728 -0.865045 0.000000 \
                -99.918198 345.190369 584.070618 1.000000 | \
view clippingregion -284.806213 129.713852 528.670959 \
                864.158752 -722.333801 601.748169"
)

model = ses.get(hv.Model)

animTool = hw.AnimationTool()
animTool.currentFrame = 26
win.draw()

cvt1 = hw.CaptureVideoTool()
cvt1.dimension = "pixels"
cvt1.width = 3000
cvt1.height = 2000

typeList1 = ["avi", "amf", "gif"]
for t in typeList1:
    cvt1.type = t
    videoFile = os.path.join(exportDir, "exportVideoTest." + t)
    print('Video file of type "' + t + '" = ' + videoFile)
    cvt1.file = videoFile
    cvt1.capture()

cvt2 = hw.CaptureVideoTool()
cvt2.top = 0.1
cvt2.left = 0.3
cvt2.bottom = 0.9
cvt2.right = 0.7

typeList2 = ["jpeg", "png", "bmp"]
for t in typeList2:
    print("Type = " + t)
    cvt2.type = t
    tmpExportDir = os.path.join(exportDir, t)
    os.mkdir(os.path.join(exportDir, t))
    videoFile = os.path.join(tmpExportDir, "exportVideoTest." + t)
    print('Video file of type "' + t + '" = ' + videoFile)
    cvt2.file = videoFile
    cvt2.capture()

Figure 1. Export all possible video formats from HyperView