Class: RawVectorField<ArrayType, GridType>
Defined in: RawField.ts:116
A class representing a 2D gridded field of vectors
Type Parameters
| Type Parameter |
|---|
ArrayType extends TypedArray |
GridType extends Grid |
Constructors
Constructor
new RawVectorField<
ArrayType,GridType>(grid,u,v,opts?):RawVectorField<ArrayType,GridType>
Defined in: RawField.ts:128
Create a vector field.
Parameters
| Parameter | Type | Description |
|---|---|---|
grid | GridType | The grid on which the vector components are defined |
u | ArrayType | The u (east/west) component of the vectors, which should be given as a 1D array in row-major order, with the first element being at the lower-left corner of the grid |
v | ArrayType | The v (north/south) component of the vectors, which should be given as a 1D array in row-major order, with the first element being at the lower-left corner of the grid |
opts? | RawVectorFieldOptions | Options for creating the vector field. |
Returns
RawVectorField<ArrayType, GridType>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
relative_to | readonly | VectorRelativeTo | RawField.ts:119 |
u | readonly | RawScalarField<ArrayType, GridType> | RawField.ts:117 |
v | readonly | RawScalarField<ArrayType, GridType> | RawField.ts:118 |
Methods
getWGLTextureSpecs()
getWGLTextureSpecs(
gl,mag_filter):object
Defined in: RawField.ts:151
Parameters
| Parameter | Type |
|---|---|
gl | WebGLAnyRenderingContext |
mag_filter | number |
Returns
object
u
u:
WGLTextureSpec
v
v:
WGLTextureSpec
sampleField()
sampleField(
lon,lat): [number,number]
Defined in: RawField.ts:184
Parameters
| Parameter | Type |
|---|---|
lon | number |
lat | number |
Returns
[number, number]