GetFilterParams Method
Description
Gets parameters used in filtering of scan data
Syntax
| Visual Basic |
|---|
Public Function GetFilterParams( _ ByRef dCutAxisLocation As Double, _ ByRef nAxis As Long, _ ByRef dMaxIncrement As Double, _ ByRef dMinIncrement As Double, _ ByRef dMaxAngle As Double, _ ByRef dMinAngle As Double _ ) As Boolean |
Parameters
- dCutAxisLocation
- Used for Manual scans with Filter property set to BSF_BODYAXISDISTANCE.
- nAxis
- Required Long variable that gets the cut axis. Returns non-zero only for axis filters. For axis filters, 0 means the X axis, 1 means the Y-axis, and 2 means the Z-axis.
- dMaxIncrement
- Required Double variable that gets the maximum increment. For fixed-length filters, this is simply the fixed increment. This is the Time delta values in case the filter is BSF_TIME_DELTA or BSF_VARIABLEDISTANCE for Manual scans.
- dMinIncrement
- Required Double variable that gets the minimum increment for Variable Distance Filters. This is the Drop Point distance when a Manual scan is being used with the filter set to BSF_VARIABLEDISTANCE.
- dMaxAngle
- Required Double variable that gets the maximum angle used in Variable Distance Filters.
- dMinAngle
- Required Double variable that gets the minimum angle used in Variable Distance Filters.
Return Type
Boolean value.
Remarks
|
Filter |
GetFilterParams (dCutAxisLocation, nAxis, dMaxIncrement, dMinIncrement, dMaxAngle, dMinAngle) |
|---|---|
|
Distance |
,,dMaxIncrement |
|
BodyAxisDistance (DCC) |
,nAxis, dMaxIncrement |
|
BodyAxisDistance (Manual) |
NCutLocation,nAxis |
|
Time |
,,dMaxIncrement |
|
VariableDistance |
,,dMaxIncrement, dMinIncrement, dMaxAngle, dMinAngle |
See Also