iwfm.logtrans¶
- iwfm.logtrans(q, zero_offset=-2.0, neg_val=1e-09, roundoff=4)[source]¶
Log-transform a number, accounting for non-zero and negative values.
- Parameters:
q (float) – value to be log-transformed
zero_offset (float, default=-2.0) – value to return if q == 0
neg_val (float, default=1e-9) – value to return if q < 0
roundoff (int, default=4) – decimal places to round result
Returns –
the log-transformed value for positive q
neg_val for negative q, or
zero_offset for q == 0