Google Earth toolbox - ge_circle

View source code of the function ge_circle() in the MATLAB editor
Google Earth toolbox contents

ge_circle

Visualization of circular polygons on the Earth's surface.

Syntax

kmlStr = ge_circle(X,Y,R)

kmlStr = ge_circle(X,Y,R,Parameter,Value)

Description

kmlStr = ge_circle(X,Y,R)

Generates a kml character array used for visualizing a circular area on the Earth's surface, the centerpoint of which is located at [X,Y] and the radius of which is equal to R.

kmlStr = ge_circle(X,Y,R,Parameter,Value)

Generates a kml character array used for visualizing a circular area on the Earth's surface, the centerpoint of which is located at [X,Y] and the radius of which is equal to R.

A number of options can be set regarding the appearance of the circle. Assigning values to the parameters can be accomplished by inclusion of an alternating sequence of parameters and their value. The table below provides an overview of the authorized options. The order in which the parameters are included does not matter. Please be aware that the options are case-sensitive. Examples are provided further down.

Parameter	Description
'altitude'	The altitude at which the object is located can be specified in this parameter. Altitudes are interpreted differently depending on the value of parameter 'altitudeMode'.
'altitudeMode'	Character array used in interpreting the position of objects along the vertical axis. Value can be one of 'clampToGround', 'relativeToGround', or 'absolute'.
'description'	A description of the object can be included using this parameter. Its value must be passed as a character array. Including a description will cause a text balloon to pop up from the map at the object's location. This balloon contains the character array included in 'description'.
'divisions'	Circles are plotted as adjacent triangles. The number of triangles to be used can be set using this parameter. The number of triangles is defined as (d+1)*2, in which 'd' is the value of the 'devisions' parameter. Default number is 8.
'lineColor'	Line color specification, including transparency. Color value format must be passed as a character array according to the format string 'TTRRGGBB', with 'TT' representing transparency; 'RR', 'GG', and 'BB' representing red, green, and blue colors, respectively. Intensity values are denoted as two-digit hexadecimal numbers ranging from 00 to FF. For example, '80FF0000' is semi-transparent red and 'FF0000FF' is fully opaque blue.
'lineWidth'	Line width specification. Must be passed as a 1x1 numerical array.
'msgToScreen'	Defines whether verbose feedback is provided by the function when it is accessed and when it finishes. Default is false (which is equivalent to logical(0), but quicker).
'name'	Character array with the name of the object.
'nameVisibility'	boolean value display name with object. (default = true)
'polyColor'	Polygon color specification, including transparency. Color value format same as 'LineColor'.
'snippet'	A short description of the feature. In Google Earth, this description is displayed in the Places panel under the name of the feature. If a Snippet is not supplied, the first two lines of the description are used
'timeSpanStart'	See Dynamic visualization.
'timeSpanStop'	See Dynamic visualization.
'visibility'	Defines whether the object is initially visible. Must be passed as numerical value 1 or 0.

Remarks

Latitudes on the Southern hemisphere and longitudes on the Western hemisphere must be passed as negative values.

Some transformation may occur due to the projection (see example below).

Latitudes and longitudes should be passed in units of decimal degrees (also known as fractional degrees). Google Earth uses Simple Cylindrical projection (also known as Plate Carée) with a WGS84 datum. Circle radius is in meters.

Examples

See the demo file demo_ge_circle for more details.

The above lines of code will display as follows when viewed in Google Earth:

---