org.vast.swe.helper

Class VectorHelper

java.lang.Object

org.vast.data.SWEFactory

org.vast.swe.SWEHelper

org.vast.swe.helper.VectorHelper

All Implemented Interfaces:

Factory

Direct Known Subclasses:

GeoPosHelper

public class VectorHelper
extends SWEHelper

Helper class to create SWE structures used in vector math

Since:

March 2016

Author:

Alex Robin

Property Summary

Properties inherited from class org.vast.data.SWEFactory

newEncodedValuesProperty

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_COEF
static String	DEF_LOCATION
static String	DEF_ORIENTATION_EULER
static String	DEF_ORIENTATION_QUAT
static String	DEF_ROT_MATRIX
static String	DEF_ROW
static String	DEF_UNIT_VECTOR

Fields inherited from class org.vast.swe.SWEHelper

PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
VectorHelper()

Method Summary

Methods

Modifier and Type	Method and Description
Vector	newEulerAngles() Creates a 3D euler angles vector with unspecified order of rotations about X/Y/Z axes. This is only used when order and axes of rotations are specified separately.
Vector	newLocationVectorXYZ(String def, String refFrame, String uomCode) Creates a 3D location vector in an ortho-normal frame with X/Y/Z axes
Matrix	newMatrix(int nRows, int nCols) Creates a matrix (i.e.
Matrix	newMatrix(String def, String refFrame, int nRows, int nCols) Creates a matrix (i.e.
Vector	newUnitVectorXYZ(String def, String refFrame) Creates a 3D unit vector in an ortho-normal frame with X/Y/Z axes
protected Vector	newVector3()
Vector	newVector3(String def, String refFrame) Creates a 3D vector with atrbitrary axes called u1, u2, u3

Methods inherited from class org.vast.swe.SWEHelper

assignBinaryEncoding, createDataParser, createDataWriter, ensureXmlCompatible, findComponent, findComponentByDefinition, findComponentByName, findComponentByPath, findComponentByPath, getDefaultBinaryEncoding, getDefaultEncoding, getEpsgUri, getPropertyUri, getTimeStampIndexer, newArray, newBinaryEncoding, newBoolean, newCategory, newCount, newCount, newDataStream, newLinkProperty, newLinkProperty, newLinkProperty, newQuantity, newQuantity, newRgbImage, newSystemIdComponent, newText, newTextEncoding, newTimeStamp, newTimeStampIsoGPS, newTimeStampIsoUTC, newTimeStampOnBoardClock, newVector, wrapWithTimeStamp, wrapWithTimeStampUTC

Methods inherited from class org.vast.data.SWEFactory

newAllowedTimes, newAllowedTokens, newAllowedValues, newBinaryBlock, newBinaryComponent, newBinaryEncoding, newBoolean, newCategory, newCategoryRange, newCount, newCount, newCountRange, newCountRange, newDataArray, newDataArray, newDataChoice, newDataRecord, newDataRecord, newDataStream, newEncodedValuesProperty, newMatrix, newMatrix, newNilValue, newNilValues, newQuantity, newQuantity, newQuantityRange, newQuantityRange, newText, newTextEncoding, newTime, newTime, newTimeRange, newTimeRange, newUnitReference, newVector, newXMLEncoding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEF_UNIT_VECTOR

public static final String DEF_UNIT_VECTOR

DEF_ROW

public static final String DEF_ROW

DEF_COEF

public static final String DEF_COEF

DEF_ROT_MATRIX

public static final String DEF_ROT_MATRIX

DEF_LOCATION

public static final String DEF_LOCATION

DEF_ORIENTATION_EULER

public static final String DEF_ORIENTATION_EULER

DEF_ORIENTATION_QUAT

public static final String DEF_ORIENTATION_QUAT

Constructor Detail

VectorHelper

public VectorHelper()

Method Detail

newVector3

protected Vector newVector3()

newVector3

public Vector newVector3(String def,
                String refFrame)

Creates a 3D vector with atrbitrary axes called u1, u2, u3

Parameters:

def - semantic definition of velocity vector (must be set)

refFrame - reference frame within which the vector is expressed

Returns:

the new Vector component object

newUnitVectorXYZ

public Vector newUnitVectorXYZ(String def,
                      String refFrame)

Creates a 3D unit vector in an ortho-normal frame with X/Y/Z axes

Parameters:

def - semantic definition of velocity vector (if null, DEF_UNIT_VECTOR is used)

refFrame - reference frame within which the vector is expressed

Returns:

the new Vector component object

newLocationVectorXYZ

public Vector newLocationVectorXYZ(String def,
                          String refFrame,
                          String uomCode)

Creates a 3D location vector in an ortho-normal frame with X/Y/Z axes

Parameters:

def - semantic definition of velocity vector (if null, DEF_LOCATION is used)

refFrame - reference frame within which the vector is expressed

uomCode - unit of distance to use on all 3 axes

Returns:

the new Vector component object

newEulerAngles

public Vector newEulerAngles()

Creates a 3D euler angles vector with unspecified order of rotations about X/Y/Z axes.
This is only used when order and axes of rotations are specified separately.

Returns:

the new Vector component object

newMatrix

public Matrix newMatrix(int nRows,
               int nCols)

Creates a matrix (i.e. 2D tensor) with no definition nor reference frame

Parameters:

nRows - number of rows

nCols - number of columns

Returns:

the new Matrix component object

newMatrix

public Matrix newMatrix(String def,
               String refFrame,
               int nRows,
               int nCols)

Creates a matrix (i.e. 2D tensor)

Parameters:

def - semantic definition of matrix (e.g. rotation matrix, stress matrix, etc.)

refFrame - reference frame within which the matrix is expressed, if applicable, null otherwise

nRows - number of rows

nCols - number of columns

Returns:

the new Matrix component object