Description This function performs a color image calculation using rays which exist on a specific surface and writes the result to a FRED Grid Data (FGD) file. The third argument of the command is a T_ANALYSIS structure, which defines a sampling grid (pixels, orientation and location) over which the color image is computed but does not define any ray selection filter operations. Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long. Please see Multi-threaded Raytracing for more information.
Syntax count = ColorImageToFile( n, nCoordSys, ana, fname )
Parameters count (Long or Huge_) Returned number of rays that were included in the calculation.
n As Long Node number of the surface to be used as the ray selection filter. Only rays which exist on this surface at the time of the ColorImage call will be included in the calculation.
nCoordSys As Long Node number of the entity whose coordinate system the ana structure is expressed in. If the ana structure was initialized using the LoadAnalysis command, the value of nCoordSys should be set to -1.
ana As T_ANALYSIS Structure defining a sample area over which the calculation will be performed. This variable may be initialized manually or by calling LoadAnalysis. If LoadAnalysis is used, note that the T_ANALYSIS structure is defined in global coordinates and therefore nCoordSys = -1.
fname As String File name where results of the calculation are to be written. If a full file path is provided (ex. C:\temp\exampleOutput.fgd), the file will be written to the location specified. If only a file name is given (ex. exampleOutput.fgd), the file will be written to the current local working directory if the directory allows write permissions. An error will occur when attempting to create the output file if the directory specified does not have write permissions granted. If fname string is empty, the results are displayed in a chart window.
Example The example below demonstrates how to use the LoadAnalysis command in conjunction with the ColorImageToFile function in order to save the results of a color image analysis to a file.
Sub Main
Dim anaSurf As Long, detSurf As Long anaSurf = FindFullName( "Analysis Surface(s).Detector Analysis" ) detSurf = FindFullName( "Geometry.Detector.Surface" )
DeleteRays() TraceCreate()
'retrieve analysis surface parameters Dim tAna As T_ANALYSIS Dim pxArea As Double LoadAnalysis anaSurf, tAna
'calculate the color image Dim nRays As Long Dim fName As String Dim X() As Double, Y() As Double, Z() As Double fName = "C:\temp\colorImageOutput.fgd" nRays = ColorImageToFile( detSurf, -1, tAna, fName )
End Sub
See Also
|