API Docs for: 0.0.1
Show:

Wetness Class

Extends Value
Module: niviz

Stores wetness as volume fraction in %.

Constructor

Wetness

(
  • [top]
  • [value]
  • [bottom]
)

Parameters:

Item Index

Methods

Methods

clone

() Value

Inherited from Value: lib/value.js:96

A clone that can be used to set new values

Returns:

parse

(
  • value
)
Number static

Converts a string 'value' to an index. It is interpreted as a wetness code;

Parameters:

Returns:

Properties

caamlcodes

Array.

code

String

Wetness code string.

codes

Array.

height

Number

Inherited from Value: lib/value.js:48

index

Object

Wetness code to numeric index mapping.

index

Number

Wetness index from 1 to 9

mean

Object

Wetness code to mean value mapping.

numeric

Number

Inherited from Value: lib/value.js:67

The numeric value (defaults to .value) used for comparisons.

text

String

Inherited from Value: lib/value.js:57

A string represantation of this value.

thickness

Number

Inherited from Value: lib/value.js:77

The thickness value only makes sense with top and bottom defined

top

Number

Inherited from Value: lib/value.js:36

value

Number

Inherited from Value but overwritten in lib/values/wetness.js:46

The wetness as volume fraction in %.