Description

Data structure for an analysis surface.

Definition

Type T_ANALYSISSURF

anaXmin As Double
anaYmin As Double
anaXmax As Double
anaYmax As Double
anaScale As Double
renXmin As Double
renYmin As Double
renXmax As Double
renYmax As Double
anaNumX As Long
anaNumY As Long
renNumX As Long
renNumY As Long
anaDrawMode As String
renDrawMode As String
name As String
description As String
anaRed As Integer
anaGreen As Integer
anaBlue As Integer
renRed As Integer
renGreen As Integer
renBlue As Integer
anaAutoScale As Boolean
preserveAspect As Boolean
anaDraw As Boolean
renDraw As Boolean
samplePointAtMinMax As Boolean

End Type

Members

anaXmin

Minimum X value of the analysis rectangle area.

anaYmin

Minimum Y value of the analysis rectangle area.

anaXmax

Maximum X value of the analysis rectangle area.

anaYmax

Maximum Y value of the analysis rectangle area.

anaScale

Scale factor for the size of the analysis rectangle area.

renXmin

Minimum X value of the rendering (drawable) rectangle area.

renYmin

Minimum Y value of the rendering (drawable) rectangle area.

renXmax

Maximum X value of the rendering (drawable) rectangle area.

renYmax

Maximum Y value of the rendering (drawable) rectangle area.

anaNumX

Number of sample points in the X direction of the analysis rectangle area.

anaNumY

Number of sample points in the Y direction of the analysis rectangle area.

renNumX

Number of sample points in the X direction of the rendering rectangle area.

renNumY

Number of sample points in the Y direction of the rendering rectangle area.

anaDrawMode

Drawing mode for the rectangle showing the Analysis area. Options are "Fill", "Points", or "Lines".

renDrawMode

Drawing mode for the rectangle showing the Rendering Area (for drawing only). Options are "Fill", "Points", or "Lines".

name

Name of the analysis surface.

description

The description of the analysis surface.

anaRed

The red component ( 0-255) of the color to draw the analysis rectangle area.

anaGreen

The green component ( 0-255) of the color to draw the analysis rectangle area.

anaBlue

The blue component ( 0-255) of the color to draw the analysis rectangle area.

renRed

The red component ( 0-255) of the color to draw the rendering rectangle area.

renGreen

The green component ( 0-255) of the color to draw the rendering rectangle area.

renBlue

The blue component ( 0-255) of the color to draw the rendering rectangle area.

anaAutoScale

True for automatically scaling the size of the analysis rectangle to include all the data from the rays included in the analysis.  False otherwise.

preserveAspect

True for preserving a 1:1 aspect ratio in the analysis rectangle area.  False otherwise.

anaDraw

True for drawing the analysis area.  False for not drawing the analysis area.

renDraw

True for drawing the rendering area.  False for not drawing the rendering area.

samplePointAtMinMax

True if the outer sample points are a half cell size inside the outer boundary (at center of outer pixel); False if the the outer sample points are exactly on the outer boundary of the rectangular analysis area (at edge of outer pixel).

Remarks

Note that T_ANALYSISSURF is not the same thing as T_ANALYSIS.  T_ANALYSISSURF describes an analysis surface that is part of the FRED document, while T_ANALYSIS describes a sample plane in space for use by other analysis script commands such as Irradiance, Intensity, etc.

Used as Parameter in

AddAnalysisSurf

SetAnalysisSurf

GetAnalysisSurf

Examples