optical_layout.beam_launch

Contents

Syntax

SYNTAX #A

beam_launch = davinci( 'optical_layout.beam_launch', 'Position',  [x y], ...
                                                     'Direction', [x y], ...
                                                     'BeamWidth', beamwidth )
beam_launch = davinci( ___, 'DistanceToFocus', distance )
beam_launch = davinci( ___, 'Name', name )
beam_launch = davinci( ___, <StyleParameterName>, styleparametervalue )

SYNTAX #B

beam_launch = davinci( 'optical_layout.beam_launch', 'Position',  [x y], ...
                                                     'Direction', [x y], ...
                                                     'ConeAngle', coneangle )
beam_launch = davinci( ___, 'Name', name )
beam_launch = davinci( ___, <StyleParameterName>, styleparametervalue )

Description

Assemble parameters to specify a beam launch, but do not draw anything. Return the assembled parameters as an object of class @davinci_optical_layout.

SYNTAX #A

The launch configuration parameters used with Syntax #A are illustrated in the following figure. On the left, the four parameters shown can be used to specify the launch of a converging, diverging, or collimated beam. A positive, finite value for DistanceToFocus generates a converging beam, while a negative, finite value generates a diverging beam. Set DistanceToFocus to Inf (Matlab's notation for infinity) to generate a collimated beam. Inf is the default value used when the user does not specify DistanceToFocus, as shown on the right. In all cases the Position point, shown as a red dot, is located on the straight line that connects the start points of the two rays, even when the beam is converging or diverging.

SYNTAX #B

The launch configuration parameters used with Syntax #B are illustrated in the following figure. The beam emanates from a point. The cone angle is specified in degrees.

BOTH SYNTAX #A AND #B

Style Parameters

The table below lists the parameters available to stylize the "edge rays" (the rays that represent the beam).

Parameter Default Comments
BeamColor 'k' The Color property of the line objects.
BeamLineStyle '-' The LineStyle property of the line objects.
BeamLineWidth 0.5 The LineWidth property of the line objects.

AttachDataForRetrievalByOutsideCode

When the AttachDataForRetrievalByOutsideCode parameter for the optical_layout shape is set to true, the beam launch data that is attached includes that listed in the table below.

Parameter Name Description
nameThe name, if any, assigned to the beam launch. Stored as a char vector. Equal to '' (an empty char array) if no name is specified.
typeThe char vector 'launch'.
positionThe position, in davinci()'s global x-y coordinate system, of the source. This corresponds to the "Position" in the figures above. A 1x2 vector of type double.
axis_cThe unit vector in davinci()'s global x-y coordinate system that points in the direction of the beam launch. Corresponds to the "Direction" vector in the figures above. A 1x2 vector of type double.

Examples

Examples are given in the documentation for the optical_layout component.

Copyright 2016-2017, Leonard R. Wayne, Washington, District of Columbia, United States of America. ALL RIGHTS RESERVED.