 | CMATHrLogZ Method |
Given a Z value and the Log style and Log Minimum this
function will return the log value.
Namespace:
GeoEngine.Core.GXNetX
Assembly:
geoengine.core.gxnetx (in geoengine.core.gxnetx.dll) Version: 2024.2.0.25
Syntaxpublic static double rLogZ(
CGXNETCore gxNetShared,
double z,
int mode,
double min
)
public static double rLogZ(
CGXNETCore gxNetShared,
double z,
int mode,
double min
)
Public Shared Function rLogZ (
gxNetShared As CGXNETCore,
z As Double,
mode As Integer,
min As Double
) As Double
Public Shared Function rLogZ (
gxNetShared As CGXNETCore,
z As Double,
mode As Integer,
min As Double
) As Double
public:
static double rLogZ(
CGXNETCore^ gxNetShared,
double z,
int mode,
double min
)
public:
static double rLogZ(
CGXNETCore^ gxNetShared,
double z,
int mode,
double min
)
static member rLogZ :
gxNetShared : CGXNETCore *
z : float *
mode : int *
min : float -> float
static member rLogZ :
gxNetShared : CGXNETCore *
z : float *
mode : int *
min : float -> float
Parameters
- gxNetShared
- Type: GeoEngine.Core.GXNetXCGXNETCore
A shared CGXNETCore - z
- Type: SystemDouble
Z Value - mode
- Type: SystemInt32
Log Mode (0 - Log, 1 - LogLinearLog) - min
- Type: SystemDouble
Log Minimum (must be greater than 0)
Return Value
Type:
DoubleThe Log Value.
Remarks
Mode = 0 (regular log mode) returns:
::
Log10(Z) for Z > minimum
Log10(minimum) for Z <= minimum
Mode = 1 (log / linear / negative log mode) returns:
::
minimum * ( log10( |Z| / minimum) + 1 ) for Z > minimum
Z for |Z| <= minimum (the linear part of the range)
-minimum * ( log10( |Z| / minimum) + 1 ) for Z < -minimum
See Also