ComponentPositionTolerance

R2026b

Tolerance for component position

Since R2026b

expand all in page

    Description

    Add-On Required: This feature requires the Optical Design and Simulation Library for Image Processing Toolbox add-on.

    A ComponentPositionTolerance object defines a tolerance for the translational position of one or more components of an optical system for use in sensitivity and Monte Carlo tolerance analysis.

    Creation

    Syntax

    tol = optics.tolerance.ComponentPositionTolerance(propertyName,value)
    tol = optics.tolerance.ComponentPositionTolerance(propertyName,value,TargetIndex=targetIdx)

    Description

    tol = optics.tolerance.ComponentPositionTolerance(propertyName,value) creates a tolerance with the specified value for the specified component position property . The tolerance applies to all top-level components in an optical system.

    tol = optics.tolerance.ComponentPositionTolerance(propertyName,value,TargetIndex=targetIdx) applies the tolerance to only the components specified by targetIdx.

    example

    Input Arguments

    expand all

    Component position property to which to apply the tolerance, specified as "PositionX", "PositionY", or "PositionZ".

    Data Types: char | string

    Tolerance value, specified as a numeric scalar or a 1-by-2 numeric vector of the form [min max].

    • Scalar — Specifies a percentage tolerance relative to the nominal value. Percentage tolerances have no effect when the nominal value is zero.

    • 1-by-2 vector — Specifies an offset tolerance range [min max] relative to the nominal value.

    Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

    Component indices to target, specified as a vector of positive integers. By default, the tolerance applies to all top-level components. Tolerancing for nested components is not supported.

    Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

    Properties

    expand all

    This property is read-only.

    Property to which the tolerance applies, represented as "PositionX", "PositionY", or "PositionZ".

    Target component indices, represented as a vector of positive integers. An empty value means the tolerance applies to all top-level components.

    Tolerance range, represented as a 1-by-2 numeric vector of the form [min max]. When you specify value as a scalar, this is of the form [-value +value].

    This property is read-only.

    Tolerance interpretation type, represented as "Percentage" when you specify value as a scalar, or "Absolute" when you specify value as a 1-by-2 vector.

    Object Functions

    applyApply tolerance perturbation to optical system

    Examples

    collapse all

    This example uses:

    Open Live Script

    Import an optical system into the workspace.

    opsys = zmximport("PhotographicLens.zmx");

    Define a component position tolerance ranging from -0.5 to 0.5 for the X-position of the 3rd top-level component.

    tol = optics.tolerance.ComponentPositionTolerance(PositionX=0.5,TargetIndex=3)
    tol = 
  ComponentPositionTolerance with properties:

    TargetProperty: "PositionX"
       TargetIndex: 3
    ToleranceRange: [-0.5000 0.5000]
     ToleranceType: "Percentage"

    Apply the tolerance to the optical system.

    newopsys = apply(tol,opsys);

    Version History

    Introduced in R2026b

    See Also

    | | |