Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
Framework
amfIMovie Class
amfIMovie SetSpeedupTracking
Sets the value by which the video resolution will be divided in order to speed up tracking.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
        amfIMovie AddNewMarker
        Creates a new marker for the movie.
        amfIMovie CalculateTrackingData
        Calculates the tracking data, using the OpenCV tracking functionality, for the markers.
        amfIMovie ClearCSPoint1
        Remove the first marker from the tracking system.
        amfIMovie ClearCSPoint2
        Remove the second marker from the tracking system.
        amfIMovie GetCSFinalTime
        Gets the final time of the tracking system.
        amfIMovie GetCSOxFlag
        Gets the value of the flag denoting whether or not the connecting line of marker1 and marker2 is the X axis of the tracking system.
        amfIMovie GetCSPoint1ID
        Gets the first marker ID of the tracking system.
        amfIMovie GetCSPoint1List
        Gets the list of the marker names available as the first point of the tracking system.
        amfIMovie GetCSPoint1Name
        Gets the first marker name of the tracking system.
        amfIMovie GetCSPoint2ID
        Gets the second marker ID of the tracking system.
        amfIMovie GetCSPoint2List
        Gets the list of the marker names available as the second point of the tracking system.
        amfIMovie GetCSPoint2Name
        Gets the second marker name of the tracking system.
        amfIMovie GetCSStartTime
        Gets the start time of the tracking system.
        amfIMovie GetHeight
        Gets the height, in pixels, of the video.
        amfIMovie GetMarkerHandle (deprecated)
        Gets a handle to the specified marker, to be used to access APIs available to markers.
        amfIMovie GetMarkerHandleByID
        Gets a handle to the specified marker, to be used to access APIs available to markers.
        amfIMovie GetMarkerHandleByIndex
        Gets a handle to the specified marker, to be used to access the APIs available to markers.
        amfIMovie GetMasterMeasureLength
        Gets the Length of the master measure in the selected unit.
        amfIMovie GetMasterMeasurePixelLength
        Gets Length of the master measure in screen pixels.
        amfIMovie GetMasterMeasureType
        Gets the unit type used by the master measure.
        amfIMovie GetNumberOfTrackingMarkers
        Returns the number of markers currently stored in the video.
        amfIMovie GetSpeedupTracking
        Gets the value by which the video resolution will be divided in order to speed up tracking.
        amfIMovie GetUnitTypeList
        Returns the list of length units of the master measure.
        amfIMovie GetWidth
        Gets the width, in pixels, of the video.
        amfIMovie HideMasterMeasure
        Sets the display status for the master measure to off.
        amfIMovie IsMasterMeasureDefined
        Returns whether the master measure is defined.
        amfIMovie IsTrackingDefined
        Returns whether the tracking system is defined.
        amfIMovie SetCSOxFlag
        Sets the value of the flag denoting whether or not the connecting line of the marker1 and marker 2 is the X axis.
        amfIMovie SetCSPoint1
        Sets the x, y values of the first points of the tracking system.
        amfIMovie SetCSPoint2
        Sets the x, y values of the second points of the tracking system.
        amfIMovie SetMasterMeasureLength
        Sets the length of the master measure in the selected unit.
        amfIMovie SetMasterMeasurePoints
        Sets the x, y values of the end points of the master measure.
        amfIMovie SetMasterMeasureType
        Sets the unit type of the master measure.
        amfIMovie SetSpeedupTracking
        Sets the value by which the video resolution will be divided in order to speed up tracking.
        amfIMovie ShowMasterMeasure
        Sets the display status for the master measure to on.
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

amfIMovie SetSpeedupTracking

Sets the value by which the video resolution will be divided in order to speed up tracking.

Syntax

movie_handle SetSpeedupTracking divisor

Description

Sets the value by which the video resolution will be divided before calculating the tracking data, in order to speed up marker tracking.

Inputs

divisor: The default value is 1, which will result in no speedup. A value of 2 will yield the greatest speedup benefit with the safest results. A value which is too high will result in inaccurate tracking results, and higher values yield only marginally better speed. This value will be used by the amfIMovie::CalculateTrackingData API, unless otherwise specified.

Example

movie_handle SetSpeedupTracking 2

Error

Standard hwResult error codes:

1 = HW_Error
3 = HW_InvalidHandle
4 = HW_InvalidArgs