Description Data structure for describing a sampling plane consisting of a rectilinear array of sample points. This structure is used by certain other script commands (see below).
Definition Type T_ANALYSIS posX As Double posY As Double posZ As Double AcellX As Double AcellY As Double AcellZ As Double BcellX As Double BcellY As Double BcellZ As Double Amin As Long Amax As Long Bmin As Long Bmax As Long End Type
Members posX X coordinate of the sampling plane's origin at sample point (0,0).
posY Y coordinate of the sampling plane's origin at sample point (0,0).
posZ Z coordinate of the sampling plane's origin at sample point (0,0).
AcellX X component of vector A, used to define the first sample direction.
AcellY Y component of vector A, used to define the first sample direction.
AcellZ Z component of vector A, used to define the first sample direction.
BcellX X component of vector B, used to define the second sample direction.
BcellY Y component of vector B, used to define the second sample direction.
BcellZ Z component of vector B, used to define the second sample direction.
Amin The most negative sample index in the A vector direction.
Amax The most positive sample index in the A vector direction.
Bmin The most negative sample index in the B vector direction.
Bmax The most positive sample index in the B vector direction.
Remarks The parameters of T_ANALYSIS describe a plane in space that is uniformly sampled in a regular grid of cell positions. The position, P(i,j), of cell (i,j) is given by
P(i,j) = O + i * A + j * B
where (i,j) are integers in the range
Amin <= i <= Amax Bmin <= j <= Bmax.
and
O = (posX,posY,posZ) "the origin vector". A = (AcellX,AcellY,AcellZ) "the first sample direction vector" B = (BcellX,BcellY,BcellZ) "the second sample direction vector"
Note that the lengths of the A and B vectors determine the sample spacings. The directions of the A and B vectors determine the sample directions. Typically, the A and B vectors are mutually perpendicular.
See also the SetAnalysisParameters and LoadAnalysis commands for simple and direct ways to set the data for this structure.
If the T_ANALYSIS will be used for intensity, then the meanings of the vectors O, A, and B are slightly altered because intensity is defined in terms of directions, as opposed to positions as is the case for the other script commands which use it. For more information, see the Intensity command in the help.
Note that T_ANALYSIS that is not the same thing as T_ANALYSISSURF. T_ANALYSIS describes a sample plane in space for use by other analysis script commands such as Irradiance, Intensity, etc., while T_ANALYSISSURF describes an analysis surface entity that is part of the FRED document. Note in particular that T_ANALYSIS does not contain a ray filter specification and will not, of itself, apply a ray filter when used as an argument in any script command.
Used as Parameter in
Examples
|