- •User’s Manual
- •COPYRIGHT
- •TRADEMARKS
- •LICENSE AGREEMENT
- •WARRANTY
- •DOCUMENT CONVENTIONS
- •What is TracePro?
- •Why Solid Modeling?
- •How Does TracePro Implement Solid Modeling?
- •Why Monte Carlo Ray Tracing?
- •The TracePro Graphical User Interface
- •Model Window
- •Multiple Models in Multiple Views
- •System Tree Window
- •System Tree Selection
- •Context Sensitive Menus
- •Model Window Popup Menus
- •System Tree Popup Menus
- •User Defaults
- •Objects and Surfaces
- •Changing the Names
- •Selecting Objects, Surfaces and Edges
- •Moving Objects and Other Manipulations
- •Interactive Viewing and Editing
- •Normal and Up Vectors
- •Modeling Properties
- •Applying Properties
- •Modeless Dialog Boxes
- •Expression Evaluator
- •Context Sensitive OnLine Help
- •Command Line Arguments
- •Increasing Access to RAM on 32-bit Operating Systems
- •Chinese Translations for TracePro Dialogs
- •Introduction to Solid Modeling
- •Model Units
- •Position and Rotation
- •Defining Primitive Solid Objects
- •Block
- •Cylinder/Cone
- •Torus
- •Sphere
- •Thin Sheet
- •Rubberband Primitives
- •Defining TracePro Solids
- •Lens Element
- •Lens tab
- •Aperture tab
- •Obstruction tab
- •Position tab
- •Aspheric tab
- •Fresnel Lens
- •Reflector
- •Conic
- •3D Compound
- •Parabolic Concentrators
- •Trough (Cylinder)
- •Compound Trough
- •Rectangular Concentrator
- •Facetted Rim Ray
- •Tube
- •Baffle Vane
- •Boolean Operations
- •Intersect
- •Subtract
- •Unite
- •Moving, Rotating, and Scaling Objects
- •Translate
- •Move
- •Rotate
- •Scale
- •Orientation
- •Sweeping and Revolving Surfaces
- •Sweep
- •Revolve
- •Notes Editor
- •Importing and Exporting Files
- •Exchanging Files with Other ACIS-based Software
- •Importing an ACIS File
- •Exporting an ACIS File
- •Stereo Lithography (*.STL) Files
- •Additional CAD Translators (Option)
- •Plot formats for model files
- •Healing Imported Data
- •How to Autoheal an Object
- •How to Manually Heal an Object
- •Reverse Surfaces (and Surface Normal)
- •Combine
- •Lens Design Files
- •Merging Files
- •Inserting Files
- •Changing the Model View
- •Silhouette Accuracy
- •Zooming
- •Panning
- •Rotating the View
- •Named Views
- •Previous View
- •Controlling the Appearance of Objects
- •Display Object
- •Display All
- •Display Object WCS
- •Display RepTile
- •Display Importance
- •Customize and Preferences
- •Preferences
- •Customize
- •Changing Colors
- •Overview
- •What is a property?
- •Define or Apply Properties
- •Property Editors
- •Toolbars and Menus
- •Command Panel
- •Information Panel
- •Grid Panel
- •Material Properties
- •Material Catalogs
- •Material Property Database
- •Create a new material property
- •Editing an existing material property
- •Exporting a material property
- •Importing a Material Property
- •Bulk Absorption
- •Birefringence
- •Bulk Scatter Properties
- •Bulk Scatter Property Editor
- •Import/Export
- •Scatter DLL
- •Fluorescence Properties
- •Defining Fluorescence Properties
- •Fluorescence Calculations
- •Fluorescence Ray Trace
- •Raytrace Options
- •Surface Source Properties
- •Surface Source Property Editor
- •Create a New Surface Source Property
- •Edit an Existing Surface Source Property
- •Export a Surface Source Property
- •Import a Surface Source Property
- •Gradient Index Properties
- •Gradient Index Property Editor
- •Create a New Gradient Index Property
- •Edit an Existing Gradient Index Property
- •Export a Gradient Index Property
- •Import a Gradient Index Property
- •Surface Properties
- •Using the Surface Property Database
- •Using the Surface Property Editor
- •Using Solve for
- •Direction-Sensitive Properties
- •Creating a new surface property
- •Editing an Existing Surface Property
- •Exporting a Surface Property
- •Importing a Surface Property
- •Surface Property Plot Tab
- •Incident Medium
- •Substrate Medium
- •by angle (deg)
- •by wavelength (um)
- •Display Values
- •Table BSDF
- •Creating a Table BSDF Property
- •Creating an Asymmetric Table BSDF Property
- •Using an Asymmetric Table BSDF property
- •Wire Grid Polarizers
- •Upgrading an older property database
- •Applying Wire-Grid Surface Properties
- •Thin Film Stacks
- •Using the Stack Editor
- •Thin Film Stack Editing Note
- •Entering a Single Layer Stack
- •RepTile Surfaces
- •Overview
- •Specifying a RepTile surface
- •RepTile Shapes
- •RepTile Geometries
- •RepTile Parameterization
- •Variables
- •Parameterized Input Fields
- •Decentering RepTile Geometry
- •Property Database Tools
- •Import
- •Export
- •Using Properties
- •Limitations in Pre-Defined Property Data
- •Applying Property Data
- •Material Properties
- •Material Catalogs
- •Applying Material Properties
- •Applying Birefringent Material Properties
- •Bulk Scattering
- •Fluorescence Properties
- •Applying Fluorescence Properties
- •Gradient Index Properties
- •Surface Properties
- •Using the Surface Property Database
- •Surface Source Properties
- •Blackbody Surface Sources
- •Blackbody and Graybody Calculations
- •Source Spreadsheet
- •Scaling the Total Rays for Several Sources
- •Prescription
- •Color
- •Importance Sampling
- •Defining Importance Sampling Targets (Manually)
- •Adding Targets
- •Number of Importance Rays
- •Shape, Dimensions, and Location of Importance Targets
- •Cells
- •Apply the Importance Sampling Property
- •Automatic Setup of Importance Sampling
- •Define the Prescription
- •Select the Target Shape
- •Apply, Cancel, or Save Targets
- •Editing/Deleting Importance Sampling Targets
- •Exit Surface
- •Predefined irradiance map orientation
- •Diffraction
- •Defining Diffraction in TracePro
- •Do I need to Model Diffraction in TracePro?
- •How do I Set Up Diffraction?
- •Using the Raytrace Flag
- •Mueller Matrix
- •Temperature
- •Class and User Data
- •RepTile Surfaces
- •Overview
- •Specifying a RepTile surface
- •Boundary Shapes
- •Export
- •Visualization and Surface Properties
- •Specifying a RepTile Texture File Surface
- •Bump Designation for Textured RepTile
- •Base Plane Designation for Textured RepTile
- •Temperature Distribution
- •Introduction to Ray Tracing
- •Combining Sources
- •Managing Sources with the System Tree
- •Managing Sources with the Source/Wavelength Selector
- •Defining Sources
- •Grid Sources
- •Setting Up the Grid
- •Grid Density: Points/Rings
- •Beam Setup
- •Wavelengths
- •Polarization
- •Surface Sources
- •Importance Sampling from Surface Sources
- •File Sources
- •Creating a File Source from Radiant Imaging Data
- •Creating a File Source from an Incident Ray Table
- •Creating a File Source from Theoretical or Measured Data
- •Insert Source
- •Capability to “trace every nth ray”
- •Capability to scale flux
- •Modify the File Source
- •Orienting and Selecting Sources
- •Multi-Selecting Sources
- •Move and Rotate Dialogs
- •Tracing Rays
- •Standard (Forward) Raytrace
- •Reverse Ray Tracing
- •Specifying reverse rays
- •Theory of reverse ray tracing
- •Luminance/Radiance Ray Tracing
- •Raytrace Options
- •Options
- •Analysis Units
- •Ray Splitting
- •Specular Rays Only
- •Importance Sampling
- •Aperture Diffraction and Aperture Diffraction Distance
- •Random Rays
- •Fluorescence
- •Polarization
- •Detect Ray Starting in Bodies
- •Random Seed
- •Wavelengths
- •Thresholds
- •Simulation and Output
- •Collect Exit Surface Data
- •Collect Candela Data
- •Index file name
- •Save Data to Disk during Raytrace
- •Save Ray History to disk
- •Sort Ray Paths
- •Save Bulk Scatter data to disk
- •Simulation Options for TracePro LC
- •Collect Exit Surface Data
- •Collect Candela Data
- •Advanced Options
- •Voxelization Type
- •Voxel Parameters
- •Raytrace Type
- •Gradient Index Substep Tolerance
- •Maximum Nested Objects
- •Progress Dialog
- •Ray Tracing modes
- •Analysis Mode
- •Saving and Restoring a Ray-Trace
- •Simulation Mode
- •Simulation Dialog
- •Simulation Options
- •Simulation Data for LC
- •Examining Raytrace Results
- •Analysis Menu
- •Display Rays
- •Ray Drawing Options
- •Ray Colors
- •Flux-based ray colors
- •Wavelength-based ray colors
- •Source-based ray colors
- •All rays one color
- •Irradiance Maps
- •Irradiance Map Options
- •Map Data
- •Display Options
- •Contour Levels
- •Access to Irradiance Data
- •Ensquared Flux
- •Luminance/Radiance Maps
- •3D Irradiance Plot
- •Candela Plots
- •Candela Options
- •Orientation and Rays
- •Polar Iso-Candela
- •Rectangular Iso-Candela
- •Candela Distributions
- •IESNA and Eulumdat formats
- •Access to Candela/Intensity Data
- •Enclosed Flux
- •Polarization Maps
- •Polarization Options
- •Save Polarization Data
- •OPL/Time-of-flight plot
- •OPL/Time-of-flight plot options
- •Incident Ray Table
- •Copying and Pasting the Incident Ray Table Data
- •Saving the Incident Ray Table in a File
- •Saving the Incident Ray Table as a Source File
- •Display Selected Rays
- •Source Files - Binary file format
- •Ray Histories
- •Copying and Pasting the Ray History Table Data
- •Saving the Ray History Table in a File
- •Ray Sorting
- •Ray Sorting Examples
- •Reports Menu
- •Flux Report
- •Property Data Report
- •Raytrace Report
- •Saving and Restoring a Raytrace
- •Tools Menu
- •Audit
- •Delete Raydata Memory
- •Collect Volume Flux
- •Overview
- •View Volume Flux
- •Overview
- •Flux Type
- •Normal Axis/Orientation
- •Slices
- •Color Map
- •Gradient
- •Logarithmic
- •Simulation File Manager
- •Irradiance/Illuminance Viewer
- •Overview
- •Viewing a saved Irradiance/Illuminance Map
- •Irradiance/Illuminance Viewer Options
- •Adding and Subtracting Irradiance/Illuminance Maps
- •Measurement Dialog
- •Introduction
- •The Use of Ray Splitting in Monte Carlo Simulation
- •Importance Sampling
- •Importance Sampling and Random Rays
- •When Do I Need Importance Sampling?
- •How to Choose Importance Sampling Targets
- •Importance Sampling Example
- •Material Properties
- •Material Property Database
- •Material Property Interpolation
- •Gradient Index Profile Polynomials
- •Complex Index of Refraction
- •Surface Properties
- •Coincident Surfaces
- •BSDF
- •Harvey-Shack BSDF
- •ABg BSDF Model
- •BRDF, BTDF, and TS
- •Elliptical BSDF
- •What is an elliptical BSDF?
- •Elliptical ABg BSDF model
- •Elliptical Gaussian BSDF
- •Calculation of Fresnel coefficients during raytrace
- •Anisotropic Surface Properties
- •Anisotropic surface types
- •Getting anisotropic data
- •User Defined Surface Properties
- •Overview
- •Creating a Surface Property DLL
- •Create the Surface Property
- •Apply Surface Property
- •API Specification for Enhanced Coating DLL
- •Document Layout
- •Calling Frequencies
- •Return Codes, Signals, and Constants -- TraceProDLL.h
- •Description of Return Codes
- •Function: fnInitDll
- •Function: fnEvaluateCoating
- •Function: fnAnnounceOMLPath
- •Function: fnAnnounceDataDirectory
- •Function: fnAnnounceSurfaceInfo
- •Function: fnAnnounceLocalBoundingBox
- •Function: fnAnnounceRaytraceStart
- •Function: fnAnnounceWavelengthStart
- •Function: fnAnnounceWavelengthFinish
- •Function: fnAnnounceRaytraceFinish
- •Example of Enhanced Coating DLL
- •Surface Source Properties
- •Spectral types
- •Rectangular
- •Gaussian
- •Solar
- •Table
- •Angular Types
- •Lambertian
- •Uniform
- •Gaussian
- •Solar
- •Table
- •Mueller Matrices and Stokes Vectors
- •Bulk Scattering
- •Henyey-Greenstein Phase Function
- •Gegenbauer Phase Function
- •Scattering Coefficient
- •Using Bulk Scattering in TracePro
- •User Defined Bulk Scatter
- •Using Scatter DLLs
- •Required DLL Functions called from TracePro
- •Common Arguments passed from TracePro
- •DLL Export Definitions
- •Non-Uniform Temperature Distributions
- •Overview
- •Distribution Types
- •Rectangular Coordinates
- •Circular Coordinates
- •Cylindrical Coordinates
- •Defining Temperature Distributions
- •Format for Temperature Distribution Storage Files
- •Type 0: Rectangular with Interpolated Points
- •Type 1: Rectangular with Polynomial Distribution
- •Type 2: Circular with Interpolated Points
- •Type 3: Circular with Polynomial Distribution
- •Type 4: Cylinder with Interpolated Points
- •Type 5: Cylinder with Polynomial Distribution
- •Polynomial Approximations of Temperature Distributions
- •Interpretation of Polar Iso-Candela Plots
- •Property Import/Export Formats
- •Material Property Format
- •Surface Property Format
- •Surface Data Columns
- •Grating Data Columns
- •Stack Property Format
- •Gradient Index Property Format
- •Gradient Index Data Columns (non-GRADIUM types)
- •Gradient Index Data Columns (GRADIUM (Buchdahl) type)
- •Gradient Index Data Columns (GRADIUM (Sellmeier) type)
- •Bulk Scatter Property Format
- •Fluorescence Property Format
- •Surface Source Property Format
- •RepTile Property Format
- •Texture File Format
- •The Scheme Language
- •Scheme Editor
- •Overview
- •Text Color
- •Macro Recorder
- •Recording States
- •Macro Format and Example
- •Macro Command Examples
- •Running a Macro Command from the Command Line
- •Running a Scheme Program Stored in a File
- •Scheme Commands
- •Creating Solids
- •Create a solid block:
- •Create a solid block named blk1:
- •Create a solid cylinder:
- •Create a solid elliptical cylinder:
- •Create a solid cone:
- •Create a solid elliptical cone:
- •Create a solid torus:
- •Boolean Operations
- •Boolean subtract
- •Boolean unite
- •Boolean intersect
- •Chamfers and blends
- •Macro Programs
- •Accessing TracePro Menu Selections using Scheme
- •For more information on Scheme
- •TracePro DDE Interface
- •Introduction
- •The Service Name
- •The Topic
- •The Item
- •Clipboard Formats
- •TracePro DDE Server
- •Establishing a Conversation
- •Excel 97/2000 Example
- •RepTile Examples
- •Fresnel lens
- •Conical hole geometry with variable geometry, rectangular tiles and rectangular boundary
- •Parameterized spherical bump geometry with staggered ring tiles
- •Aperture Diffraction Example
- •Applying Importance Sampling to a Diffracting Surface
- •Volume Flux Calculations Example
- •Sweep Surface Example
- •Revolve Surface Example
- •Using Copy with Move/Rotate
- •Example of Orienting and Selecting Sources
- •Creating the TracePro Source Example OML
- •Moving and Rotating the Sources from the Example
- •Anisotropic Surface Property
- •Creating an anisotropic surface property in TracePro
- •Applying an anisotropic surface property to a surface
- •Elliptical BSDF
- •Creating an Elliptical BSDF property
- •Applying an elliptical BSDF surface property to a surface
- •Using TracePro Diffraction Gratings
- •Using Diffraction Gratings in TracePro
- •Ray-tracing a Grating Surface Property
- •Example Using Reverse Ray Tracing
- •Specifying reverse rays
- •Setting importance-sampling targets
- •Tracing Reverse Rays
- •Viewing Analysis Results
- •Example using multiple exit surfaces
- •Example Using Luminance/Radiance Maps
- •Index
Surface Properties
Description:
This function announces the start of the raytrace.
Parameters:
nUniqueSurfaceID:
unique surface ID established during the audit phase of the simulation Data flow direction: TracePro > DLL
szMessage:
message sent to TracePro's message window if the return code is non-zero Data flow direction: DLL > TracePro
Function: fnAnnounceWavelengthStart
Calling Frequency:
Per Wavelength
Function Prototype:
int fnAnnounceWavelengthStart( double wavelength,
long nUniqueSurfaceID, LPTSTR szMessage
);
Description:
This function announces the start of the raytrace for a particular wavelength
Parameters:
wavelength:
the wavelength, in microns, that will be raytraced next Data flow direction: TracePro > DLL
nUniqueSurfaceID:
unique surface ID established during the audit phase of the simulation Data flow direction: TracePro > DLL
szMessage:
message sent to TracePro's message window if the return code is non-zero Data flow direction: DLL > TracePro
TracePro 5.0 User’s Manual |
7.39 |
Technical Reference
Function: fnAnnounceWavelengthFinish
Calling Frequency:
Per Wavelength
Function Prototype:
int fnAnnounceWavelengthFinish( double wavelength,
long nUniqueSurfaceID, LPTSTR szMessage
);
Description:
This function announces the completion of the raytrace for a particular wavelength.
Parameters:
wavelength:
the wavelength, in microns, that was just raytraced Data flow direction: TracePro > DLL
nUniqueSurfaceID:
unique surface ID established during the audit phase of the simulation Data flow direction: TracePro > DLL
szMessage:
message sent to TracePro's message window if the return code is non-zero Data flow direction: DLL > TracePro
Function: fnAnnounceRaytraceFinish
Calling Frequency:
Per Simulation
Function Prototype:
int fnAnnounceRaytraceFinish( int nStatus,
long nUniqueSurfaceID, LPTSTR szMessage
);
Description:
This function announces the completion of the raytrace.
7.40 |
TracePro 5.0 User’s Manual |
Surface Properties
Parameters:
nStatus:
the raytrace finishing status
one of the following const values will be sent by TracePro:
const int COATING_DLL_RAYTRACE_FINISH_OK = 0;
const int COATING_DLL_RAYTRACE_FINISH_USER_CANCEL = 1; const int COATING_DLL_RAYTRACE_FINISH_CATCH_EXCEPTION = 2;
const int COATING_DLL_RAYTRACE_FINISH_CRITICAL_ERROR_FROM_DLL =3;
Data flow direction: TracePro > DLL
nUniqueSurfaceID:
unique surface ID established during the audit phase of the simulation Data flow direction: TracePro > DLL
szMessage:
message sent to TracePro's message window if the return code is non-zero Data flow direction: DLL > TracePro
Example of Enhanced Coating DLL
Provided here is an example of an enhanced coating DLL. It is a variable transmission (and reflection) filter as a function of radial position. The equations that governs the transmission (T) and reflection (R) are
T = 1 – r ⁄ rmax and |
(7.37) |
R = 1 – T = r ⁄ rmax , |
(7.38) |
where r is the local radius of the ray on the applied surface and rmax is maximum radius of the surface, which is hard-coded to a value of 5 as shown below.
The programming of interest in the DLL is:
////////////////////////////////////
// End of example
////////////////////////////////////
SURF_API double fnEvaluateCoating( double*input,
int input_size, double*user,
int user_size, double*results,
int results_size
)
TracePro 5.0 User’s Manual |
7.41 |
Technical Reference
{
double result_val = 0;
// zero-out the results array memset(results,0,sizeof(double)*results_size); results[SIGNAL_TO_TRACEPRO] = COATING_DLL_SIGNAL_NONE;
double x = input[RAY_POS_X]; double y = input[RAY_POS_Y]; double r = sqrt( x*x + y*y ); double rMax = 5.0;
double tran = 1.0 - r/rMax;
if( tran < 0.0 ) tran = 0.0;
results[TRAN_S] = results[TRAN_P] = tran; results[REFL_S] = results[REFL_P] = 1.0 - tran;
return result_val;
}
////////////////////////////////////
// End of example
////////////////////////////////////
This example can be found after installation of TracePro. The default location is:
C:\Program Files\Lambda Research Corporation\TracePro\examples\demos\Variable
DLL
To use this OML example you must import the Surface Property within the above folder. Note that you must set up a Surface Property using the Define|Edit Property Data|Surface Properties… Editor if you create new DLLs. The process is the same except select for Type Coating DLL. Additionally, when you apply this property to a surface you must set its Property Orientation, including Origin (set to (0, 0, 0) in this case), Normal Direction (set to (0, 0, 1) in this case) and Up Direction (set to 0, 1, 0) in this case). See Figure 7.9 for a screen capture of the system and Figure 7.10 for the Apply Properties dialog for Filter|Variable. Figure 7.11 shows the reflection results, while Figure 7.12 shows the transmission results when a circular grid of over 30,000 rays is traced.
7.42 |
TracePro 5.0 User’s Manual |
Surface Properties
FIGURE 7.9 - Layout of the example for Enhanced Coating DLL.
FIGURE 7.10 - Apply Properties dialog for the Filter|Variable surface.
TracePro 5.0 User’s Manual |
7.43 |