Back to [[110:orbitgis:datasets:contents:index|]]\\ Back to [[110:orbitgis:datasets:contents:rules|]]
====== Attribute Formulas ====== ===== Page Index ===== * **[[#Standard available Formulas]]** * [[#Object Functions]] * [[#Spatial Functions]] * **[[#Formulas available with Extensions]]** * [[#Mobile Mapping and Asset Inventory]] * [[#Spatial Mobile Mapping functions]] * [[#Mathematical Mobile Mapping functions]] * **[[#Formulas available in Configuration]]** * [[#Argument Functions]] * [[#Logical Functions]] * [[#Mathematical Functions]] * [[#Spatial Functions - Multiple Arguments]] * [[#String Functions]] ====== Standard available Formulas ====== Standard formulas are available from the Orbit user interface as [[110:orbitgis:datasets:contents:rules|Attribute Rules]]. All standard formulas use only one argument. ===== Object Functions ===== ^ Formula ^ Datatype ^ Spatial type ^ Description ^ | CreationDate | String | All | Indicates the exact date the object was created | | CreationDateTime | String | All | Indicates the exact date and time the spatial object was created | | ObjectId | Integer | All | | | UniqueId | Integer | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ===== Spatial Functions ===== ^ Formula ^ Datatype ^ Spatial type ^ Description ^ Example ^ | Center | | CenterM | Integer | Point | Returns the user Defined **M**easurement from the point object (will be 0 if coordinatesystem is 2D or 3D or if there is no measurement). | {{line_center.png?100&nolink|}} | | ::: | ::: | Line, Area | Shows the user Defined measurement from the center of the rectangle that surrounds the line or area object | ::: | | CenterX | Float | Point | Shows the X coordinate from the point object (value refers to the used [[110:technologies:crs:crs_theory|CRS]]). | ::: | | ::: | ::: | Line, Area | Shows the X coordinate from the center of the rectangle that surrounds the line or area object | ::: | | CenterY | Float | Point | Shows the Y coordinate from the point object (value refers to the used [[110:technologies:crs:crs_theory|CRS]]). | {{area_center.png?100&nolink|}} | | ::: | ::: | Line, Area | Shows the Y coordinate from the center of the rectangle that surrounds the line or area object | ::: | | CenterZ | Float | Point | Shows the Z coordinate from the point object ([[110:orbitgis:datasets:contents:structure#coordinate|will be 0 if coordinatesystem is 2D or 2D M or if there is no heigh reference.]])| ::: | | ::: | ::: | Line, Area | Shows the Z coordinate from the center of the rectangle that surrounds the line or area object | ::: | | CoordinateCount | Integer | All | Shows the number of points that an object contains | | | First | | FirstM | Float | Point | Shows the user Defined **M**easurement from the point object (will be 0 if coordinatesystem is 2D or 3D or if there is no measurement). | | ::: | ::: | Line, Area | Shows the user defined measurement from the first point/vertex of the line or area object. first indicates the first point that is placed when the object is drawn. | | FirstSegmentAngle | | FirstSegmentLength | | FirstTriangleHeight | | FirstX | Float | Point | | ::: | ::: | Line, Area | Shows the X coordinate from the first point/vertex of the line or area object. first indicates the first point that is placed when the object is drawn. | | FirstY | Float | Point | | ::: | ::: | Line, Area | Shows the Y coordinate from the first point/vertex of the line or area object. first indicates the first point that is placed when the object is drawn. | | FirstZ | Float | Point | | ::: | ::: | Line, Area | Shows the Z coordinate from the first point/vertex of the line or area object. first indicates the first point that is placed when the object is drawn.* | | IsClosed | String, Boolean | all | Returns true for a line object if the beginpoint and the endpoint are the same. Area and point objects are always closed, thus true. | | IsWellFormed | String, Boolean | All | Returns true if the geometry of the spatial object is well formed according the rules of the [[http://www.opengeospatial.org/|OGC]] | | Last | | LastM | Float | Point | | ::: | ::: | Line, Area | Shows the user defined measurement from the last point/vertex of the line or area object. Last indicates the last point that is placed when the object is drawn.* | | LastX | Float | Point | | ::: | ::: | Line, Area | Shows the X coordinate from the last point/vertex of the line or area object. Last indicates the last point that is placed when the object is drawn. | | LastY | Float | Point | | ::: | ::: | Line, Area | Shows the Y coordinate from the last point/vertex of the line or area object. Last indicates the last point that is placed when the object is drawn. | | LastZ | Float | Point | | ::: | ::: | Line, Area | Shows the Z coordinate from the last point/vertex of the line or area object. Lastt indicates the last point that is placed when the object is drawn.** | | Max | | MaxM | Float | Point | | ::: | ::: | Line, Area | Shows the user defined measurement from the right upper corner corner of the rectangle that surrounds the line or area object. | | MaxX | Float | Point | | ::: | ::: | Line, Area | Shows the X coordinate from the right upper corner corner of the rectangle that surrounds the line or area object. | | MaxY | Float | Point | | ::: | ::: | Line, Area | Shows the Y coordinate from the right upper corner corner of the rectangle that surrounds the line or area object. | | MaxZ | Float | Point | | ::: | ::: | Line, Area | Shows the Z coordinate from the right upper corner corner of the rectangle that surrounds the line or area object.* | | Min | | MinM | Float | Point | | ::: | ::: | Line, Area | Shows the user defined measurement from the left bottom corner corner of the rectangle that surrounds the line or area object. | | MinX | Float | Point | | ::: | ::: | Line, Area | Shows the X coordinate from the left bottom corner of the rectangle that surrounds the line or area object. | | MinY | Float | Point | | ::: | ::: | Line, Area | Shows the Y coordinate from the left bottom corner of the rectangle that surrounds the line or area object. | | MinZ | Float | Point | | ::: | ::: | Line, Area | Shows the Z coordinate from the left bottom corner of the rectangle that surrounds the line or area object. | | ObjectArea | Float | Line, Area | Calculates the area in square meter. Line objects will return 0.0 if they are not closed (cfr. IsClosed) | | | ObjectLength | Float | Line, Area | Calculates the length in meter. | | | PartCount | Integer | | Enumerates the amount of parts from which the object is build. | | PointCount | Integer | | Enumerates the amount of points from which the object is build. | | SpatialImage.SampleValue | | | | [[110:orbitgis:datasets:contents:formulas|Back to top]] \\ \\ ====== Formulas available with Extensions ====== ===== Mobile Mapping and Asset Inventory ===== These formulas are only available with the Orbit Mobile Mapping products : [[110:mobile_mapping:desktop:index|]]. \\ \\ All formulas with the Pano prefix are calculated and updated when editing the object from the panorama / mobile mapping extension tab. \\ Formulas calculating an Pano area or length (distance) are using an on the fly calculated projected coordinate system to achieve the exact metric result. ==== Spatial Mobile Mapping functions ==== ^ Formula ^ Datatype ^ Spatial type ^ Description ^ | Pano Area XY | Float | Area | | | Pano Area XYZ | Float | Area | | | Pano Distance 2D| Float | Line | | | Pano Distance 3D | Float | Line | | | Pano Distance Error XY | Float | Line | | | Pano Distance Error XYZ | Float | Line | | | Pano Distance Error Z | Float | Line | | | Pano Distance X | Float | Line | | | Pano Distance Y | Float | Line | | | Pano Distance Z | Float | Line | | | Pano Length XY | Float | Line, Area | | | Pano Length XYZ | Float | Line, Area | | | Pano Point1 Distance to Ground | Float | Point | | | Pano Point1 Error XY | Float | Point | | | Pano Point1 Error XYZ | Float | Point | | | Pano Point1 Error Z | Float | Point | | | Pano Point1 X-Position | Float | Point | | | Pano Point1 Y-Position | Float | Point | | | Pano Point1 Z-Position | Float | Point | | | Pano Point2 Distance to Ground | Float | Point | | | Pano Point2 Error XY | Float | Point | | | Pano Point2 Error XYZ | Float | Point | | | Pano Point2 Error Z | Float | Point | | | Pano Point2 X-Position | Float | Point | | | Pano Point2 Y-Position | Float | Point | | | Pano Point2 Z-Position | Float | Point | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ==== Mathematical Mobile Mapping functions===== ^ Formula ^ Datatype ^ Description / Arguments^ | PanFromDirectionAndUp() | Float | ([Direction_Easting],[Direction_Northing],[Direction_Elevation],[Up_Easting],[Up_Northing],[Up_Elevation]) | | TiltFromDirectionAndUp() | Float | ([Direction_Easting],[Direction_Northing],[Direction_Elevation],[Up_Easting],[Up_Northing],[Up_Elevation]) | | RollFromDirectionAndUp() | Float | ([Direction_Easting],[Direction_Northing],[Direction_Elevation],[Up_Easting],[Up_Northing],[Up_Elevation]) | | PanFromRotationYXZ | Float | ([rotation_y],[rotation_x],[rotation_z]) | | TiltFromRotationYXZ | Float | ([rotation_y],[rotation_x],[rotation_z]) | | RollFromRotationYXZ | Float | ([rotation_y],[rotation_x],[rotation_z]) | | PanFromOmegaPhiKappa | Float | ([Omega],[Phi],[Kappa]) | | TiltFromOmegaPhiKappa | Float | ([Omega],[Phi],[Kappa]) | | RollFromOmegaPhiKappa | Float | ([Omega],[Phi],[Kappa]) | [[110:orbitgis:datasets:contents:formulas|Back to top]] \\ \\ ====== Formulas available in Configuration ====== Contact the Orbit Support (support at orbitgt dot com) for more information. \\ Formulas available via configuration may need more than one argument and are only available via direct ord-file editing. Attribute argument references can only be used withing the same Attribute Set. The syntax is straightforward but needs to be exact. Some examples : * Function : Function() * Arguments in function comma separated : Function(Argument1,Argument2,...) * Attribute reference by using [ ] : Function([Atribute1],[Atribute2],Argument3,...) * Decimal character is dot : Function([Atribute1],[Atribute2],3.1457,Argument4,...) ===== Argument Functions ===== ^ Formula ^ Datatype ^ Description ^ | ArgumentAt | | | | ArgumentsAt | | | | ArgumentCount | | | | FirstArgument | | | | LastArgument | | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ===== Logical Functions ===== ^ Formula ^ Datatype ^ Description ^ | And | Boolean | | | Between | Boolean | | | Equal | Boolean | | | If | Any | | | In | Boolean | | | IsNull | Boolean | | | Larger |Boolean | | | LargerOrEqual | | | | Not | Boolean | | | Or | Boolean | | | Smaller | Boolean | | | smallerOrEqual | Boolean | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ===== Mathematical Functions ===== ^ Formula ^ Datatype ^ Description ^ | Abs | Double | | | Add | Double | | | ACos | Double | | | ASin | Double | | | ATan | Double | | | ATan2 | Double | | | Cos | Double | | | DegToRad | Double | | | Double | Double | | | Divide | Double | | | Exp | Double | | | Hypot2D(A,B,C) | Double | [[http://en.wikipedia.org/wiki/Hypotenuse]] | | Hypot3D(A,B,C) | Double | [[http://en.wikipedia.org/wiki/Hypotenuse]] | | Int | Double | | | Log | Double | | | Multiply | Double | | | Pi | Double | | | Power | Double | | | RadToDeg | Double | | | Random | Double | | | Sin | Double | | | Sqrt | Double | | | Subtract | Double | | | Tan | Double | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ===== Spatial Functions - Multiple Arguments ===== ^ Formula ^ Datatype ^ Spatial type ^ Description ^ | Angle | Float | All | | | Center | Float | All | | | Distance2D | Float | All | | | Distance3D | Float | All | | | DistanceZ | Float | All | | | First | Float | All | | | GetM | Float | All | | | GetX | Float | All | | | GetY | Float | All | | | GetZ | Float | All | | | Last | Float | All | | | Max | Float | All | | | Min | Float | All | | | NewPoint2D | Float | All | | | NewPoint2DM | Float | All | | | NewPoint3D | Float | All | | | NewPoint3DM | Float | All | | | PerpendicularLine | Float | All | | | PointInterpolation | | Point | Float | All | | | ProjectPointOnLine | Float | All | | [[110:orbitgis:datasets:contents:formulas|Back to top]] ===== String Functions ===== ^ Formula ^ Datatype ^ Description ^ | Char(code) | String | Add a character with a specific code \\ e.g. : Char(9) results in a 'TAB' character \\ e.g. : Char(13,10) results in a DOS newline sequence | | Concat | String | Combines one or more strings, attributevalues or functions \\ e.g. Concat([KERKHOFCODE],"_",[ZONECODE],"_",[RIJCODE],"_",[GRAF]) | | Decimals | String | | | FirstUpperCase | String | | | IndexOf(A,B) | Integer | Displays the numeric position of a substring \\ e.g. : IndexOf("The last emperor","emperor") results in 9 | | LastIndexOf(A,B) | Integer | Displays the last numeric position of a substring \\ e.g. : LastIndexOf("C:\temp\my.map\file.txt",".") results in 19 | | Left | String | Takes a part of a string, starting from the left position. The second parameter determines the number of characters.\\ e.g.Left([//Attribute//],7) | | Length([Attribute]) | | Calculates string length of the attribute. | | LowerCase | String | | | LPad(A,B,C) | String | Left pad a value with a pad character to the requested size \\ e.g. : LPad("123",6,"0") results in 000123 \\ e.g. : LPad("de",3,"+") results in +de | | LTrim | String | | | Max | String | | | Min | String | | | NewLine | String | | | NowDate | String | | | NowDateTime | String | | | NowTime | String | | | PatternMatch(A,B) | String | Determines whether a particular pattern occurs \\ e.g. : PatternMatch("255.17.23","*.17.*") results in 'true' | | Printf | String | | | Replace(A,B,C) | String | Replaces a substring by another \\ e.g. : Replace("the last emperor","last","first) results in "the first emperor" | | Right | String | | | RPad(value,size,pad) | String | Right pad a value with a pad character to the requested size \\ e.g. : RPad("123",6,"0") results in 123000 \\ e.g. : RPad("de",3,"+") results in de+ | | RTrim | String | | | Split(A,B) | String | Split a string in different parts \\ e.g. : Split("127.B.3",".") results in "127" "B" and "3" | | SubString | String | Returns a substring from string A, starting at index position B with length C. | | SubString2(A,B,C) | String | Returns a substring from string A, starting at index position B til, index position C. | | Trim | String | | | UpperCase | String | | [[110:orbitgis:datasets:contents:formulas|Back to top]]