Navigation: Scripting Reference Manual > Data Structures > T_TABULATEDSCATTER

 

T_TABULATEDSCATTER

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure for the Tabulated Scatter model.

 

Definition

Type T_TABULATEDSCATTER

Name As String

Description As String

ExcludeRegion As Double

FileName As String

Type As Long

InterpType As Long

InterpNeighNum As Long

Reserved As Long

CollapseTol As Double

MinBSDF As Double

MaxBSDF As Double

TISSpecRegionSemiApeX As Double

TISSpecRegionSemiApeY As Double

TISSpecRegionSampleCountX As Long

TISSpecRegionSampleCountY As Long

TISRegionSampleCountX As Long

TISRegionSampleCountY As Long

ApplyRefl As Boolean

ApplyTrans As Boolean

HaltIncident As Boolean

SymmetryType As String

End Type

 

Members

Name

Contains string name of scatter model.

 

Description

Contains string description of scatter model.

 

ExcludeRegion

Near-specular exclusion angle specified as sin(X), where X is the near specular angle in degrees.  Samples inside of this exclusion angle will not contribute to the interpolation of BSDF values.

 

FileName

Full path to the tabulated data file.

 

TISSpecRegionSemiApeX As Double

Semi aperture in degrees for the specular region in the X direction.

 

TISSpecRegionSemiApeY As Double

Semi aperture in degrees for the specular region in the Y direction.

 

TISSpecRegionSampleCountX As Long

Number of TIS samples in the X direction of the specular region.

 

TISSpecRegionSampleCountY As Long

Number of TIS samples in the Y direction of the specular region.

 

TISRegionSampleCountX As Long

Number of total TIS samples in the X direction.

 

TISRegionSampleCountY As Long

Number of total TIS samples in the Y direction.

 

ApplyRefl

Determines if the scatter model is applied on reflection.

 

ApplyTrans

Determines if the scatter model is applied on transmission.

 

HaltIncident

Determines if the scatter model halts the incident ray.

 

SymmetryType

This argument specifies the type of symmetry that the associated data exhibits and influences the data search scheme for choosing interpolation points.  It is recommended that the “Beta – Beta0” option be used unless another symmetry has been explicitly determined. Valid options are:

Beta - Beta0

Beta + Beta0

Isotropic UVW

 

 

The following members are no longer used as of FRED version 20.00.

 

 

Type

Model type specification. 0 indicates Constant dimensionality while 1 indicates that dimensionality varies with angle.

 

InterpType

Specifies the type of interpolation to be used on the data.  Options are:

100 for 4 Nearest - Bilinear (default)

101 for N Weighted Average

102 for N Median Window Filter

 

InterpNeighNum

Specifies the number of neighbors used for the interpolation options N Weighted Average and N Median Window Filter.  This value must be a positive integer.

 

Reserved

This member should not be modified.  It has been reserved for future use.

 

CollapseTol

Tolerance value in radians. BSDF values found to be in closer angular proximity than this value will be collapsed to a single value.

 

MinBSDF

Minimum allowed BSDF value.

 

MaxBSDF

Maximum allowed BSDF value.

 

 

Used as Parameter in

AddTabulatedScatter

GetTabulatedScatter

InitTabulatedScatter

SetTabulatedScatter

 

See Also

T_BLACKPAINT

T_HARVEYSHACKSCATTER

T_LAMBERTIANSCATTER

T_MIESCATTER

T_PHONGSCATTER

T_ABGSCATTER

 

 

 

 

 

 

Copyright © Photon Engineering, LLC