globalmapper Base Classes

The main globalmapper module is a python library auto-generated from the Global Mapper SDK, which makes calls into global_mapper.pdb See Functions for functions contained in the globalmapper module. By convention, classes in globalmapper end with a “_t” suffix. Types ending with a number, such as “_t32” or “_t8” are Enumerations of constants.

Classes

GM_RotatedRect_t

class globalmapper.GM_RotatedRect_t(mTopLeft, mTopRight, mBottomRight, mBottomLeft)

This type defines a rotated rectangle with a ground coordinate at each of 4 corners

Attributes

• mTopRight : GM_Point_t

  Top right x, y coordinate

• mBottomRight : GM_Point_t

  Bottom right x, y coordinate

• mBottomLeft : GM_Point_t

  Bottom left x, y coordinate

GM_GroundControlPoint_t

class globalmapper.GM_GroundControlPoint_t(mPixelX, mPixelY, mGroundX, mGroundY)

This type is used when rectifying imagery

Attributes

X pixel coordinate

• mPixelY : double

  Y Pixel coordinate

• mGroundX : double

  X ground control coordinate

• mGroundY : double

  Y ground control coordinate

GM_AttrValue_t

class globalmapper.GM_AttrValue_t(mName, mVal)

This type is used to represent a single attribute value pair

Attributes

Attribute name

• mVal : char

  Attribute value

GM_PaletteEntry_t

class globalmapper.GM_PaletteEntry_t(mColor, mName)

This type is used to represent a single color palette entry

Attributes

• mColor : COLORREF

  rgbCOLOR

• mName : char

  Palette Name

GM_LayerInfo_t

class globalmapper.GM_LayerInfo_t

This type is used when returning information about a layer

Attributes

Filename within archive file (e.g. .zip or .tar.gz) from which layer was loaded, if any (might be NULL)

• mBandBitDepth : uint16

  RASTER/ELEV ONLY: number of bits per band value. Multiply by mNumBands to get total bit depth per sample.

• mBandValType : GM_BandValType_t8

  RASTER/ELEV ONLY: type of data for the bands

• mCodePage : uint32

  Code page for text in layer. 0 is default and current active code page (CP_ACP). CP_UTF8 is for UTF-8 interpretation

• mDescription : char

  Layer description

• mDfltViewGlobal : GM_Rectangle_t

  Default view bounding rect of layer in global coordinates (usually same as mGlobalRect)

• mElevUnits : GM_ElevUnits_t8

  Elevation units for layer

• mEnabled : boolean

  Is this layer enabled for display or it it hidden?

• mExtraLoadFlags : char

  Additional load flags with options selected by user during load. Pass these to GM_LoadLayerListEx to remember options

• mFileName : char

  Filename from which layer was loaded (if this is an archive file, like .zip, then the name of the actual loaded file will be in mArchiveFilename)

• mGlobalPixelHeight : uint32

  RASTER/ELEV ONLY: Approximate number of pixels required in height for a 1:1 pixel mapping in the current projection

• mGlobalPixelWidth : uint32

  RASTER/ELEV ONLY: Approximate number of pixels required in width for a 1:1 pixel mapping in the current projection

• mGlobalRect : GM_Rectangle_t

  Bounding rect of layer in global coordinates

• mGroupName : char

  Group name that the layer is in. NULL for no group. Separated with <sep> if multiple levels.

• mHasRasterData : boolean

  Does this layer have raster or elevation data?

• mHasVectorData : boolean

  Does this layer have vector data (the features counts can all be 0 for things like map catalogs)

• mLayerFlags : GM_LayerFlags_t32

  Extra GM_LayerFlags_t32 flags for the layer

• mMaxElevation : float

  RASTER/ELEV ONLY: Maximum elevation in meters

• mMinElevation : float

  RASTER/ELEV ONLY: Minimum elevation in meters

• mMetadataList : GM_Attr_Value_t

  List of metadata attributes and values for the layer

• mMetadataListSize : uint32

  Size of metadata list containing attributes and values

• mNativeRect : GM_Rectangle_t

  Native projection of layer

• mNumAreas : uint32

  VECTOR ONLY: Number of area features

• mNumBands : uint32

  Number of bands in a raster image (use GM_SetRasterDisplayOptions to change color band layout)

• mNumGCPs : uint32

  Number of ground control points

• mNumLidarPoints : uint64

  VECTOR ONLY: Number of Lidar point cloud points (fetch with GM_GetLidarPoint)

• mNumLines : uint32

  VECTOR ONLY: Number of line features

• mNumMeshes : uint32

  Number of mesh layers

• mNumPoints : uint32

  VECTOR ONLY: Number of point features

• mPalette : GM_PaletteEntry_t

  List of palette entries for palette-based raster layer

• mPaletteSize : uint32

  Palette size

• mParentLayer : GM_LayerHandle_t32

  Handle to parent layer if this is a child (i.e. from catalog or online layer). NULL for all top-level layers.

• mPixelHeight : uint32

  RASTER/ELEV ONLY: Layer pixel height

• mPixelSizeX : double

  RASTER/ELEV ONLY: Pixel size in meters in the x direction

• mPixelSizeY : double

  RASTER/ELEV ONLY: Pixel size in meters in the y direction

• mPixelWidth : uint32

  RASTER/ELEV ONLY: Layer pixel width

• mRasterTypeFlags : GM_RasterTypeFlags_t32

  Raster type flags, specifies what type of data a raster layer actually contains

• mTypeName : char

  Layer type name

• mUserData: void

  Custom data associated with layer provided by user via GM_SetLayerUserData function

• mUsedDefaultPos : boolean

  RASTER/ELEV ONLY: Was the default position used for this layer since the file could not be automatically positioned?

• mUseDefaultProj : boolean

  RASTER/ELEV ONLY: Was the default projection used for this layer since the file could not be automatically positioned?

• mUserText : char

  Custom text string associated with layer provided by user via GM_SetLayerUserText function or loaded form workspace.

GM_Color_t

class globalmapper.GM_Color_t(mRed, mGreen, mBlue)

This type is used when returning a color

Attributes

• mRed : uint8

  Red value

• mGreen : uint8

  Green value

• mBlue : uint8

  Blue value

GM_FontDef_t

class globalmapper.GM_FontDef_t(mRed, mGreen, mBlue)

This type is used to describe a font used for rendering text

Attributes

• mAngle : float

  Counter-clockwise rotation angle of angle (0 is horizontal left to right)

• mBgMode : GM_FontBackground_t8

  Background fill mode (i.e. opaque or transparent)

• mCharset : uint8

  Character set (use GM_MiscOpt_SetDefaultFontCharset = 263 for default behavior)

• mColor : COLORREF

  Color reference for text

• mFaceName : character

  Font face name

• mFixedHgt : float

  Fixed height of font in meters (use 0.0 for normal point-size font)

• mHalo : boolean

  Draw thin halo around text to make it visible on any background?

• mItalicize : boolean

  Is the text italicized?

• mPlacement : GM_LabelPlacement_t8

  Label placement relative to point features (only applies for point features)

• mPointSize : uint8

  Font point size

• mReserved2 : uint8

  Reserved, must be 0

• mReserved3 : uint8

  Reserved, must be 0

• mStrikeout : boolean

  Is the strikeout applied to text?

• mUnderline : boolean

  Is the text underlined?

• mWeight : uint16

  Font weight

GM_AreaStyle_t

class globalmapper.GM_AreaStyle_t

This type is used to describe a style used for drawing an area feature and its label (if any)

Attributes

• mBorderPenColor : COLORREF

  Border pen color

• mBorderPenStyle : GM_PenStyle_t16

  Border pen style

• mBorderPenWidth : uint16

  Border pen width

• mBrushColor : COLORREF

  Brush color

• mBrushStyle : GM_BrushStyle_t16

  Brush style

• mDrawLabel : boolean

  Render the label for this line if there is one

• mDrawLabelAlways : boolean

  Render the label for this line even if it collides with another display label

• mFont : GM_FontDef_t

  Font style

GM_LineStyle_t

class globalmapper.GM_LineStyle_t

This type is used to describe a style used for drawing a line feature and its label (if any)

Attributes

• mBgPenColor : COLORREF

  For double line pens, the color of the background line

• mBgPenWidth : uint16

  For double line pens, the width of the background line; if bg width is > 0, then this is a double line style

• mDrawLabel : boolean

  Render the label for this line if there is one

• mDrawLabelAlways : boolean

  Render the label for this line even if it collides with another display label

• mDrawLabelOnLine : boolean

  Render the label for this line (if any) directly on the line rather than offset from it?

• mExtraStyleData : uint8

  Extra parameter for some styles (i.e. scallop height for scallop line styles). Set to 0 for default behavior

• mFont : boolean

  Font Style

• mFixedWidthMeters : float

  Fixed width in meters to use for pen (only used if mPenWidth is zero)

• mLabelSegment : sint32

  Segment number (1-based) on which to render label (use 0 to use default label placement)

• mPenStyle : GM_PenStyle_t16

  Pen style (i.e. solid, dashed)

• mPenWidth : uint16

  Pen width in pixels

• mPenColor : COLORREF

  Pen color

GM_PointStyle_t

class globalmapper.GM_PointStyle_t

This type is used to describe a style used for drawing a point feature and its label (if any)

Attributes

• mDrawLabel : boolean

  Render the label for this line if there is one

• mDrawLabelAlways : boolean

  Render the label for this line even if it collides with another display label

• mFont : GM_FontDef_t

  Font Style

• mRotation : uint16

  Rotation angle in degrees (0 is up/north, 90 right/east, etc.) and rotation sense flags

• mScale : float

  Symbol scaling factor to apply (use negative values to make symbol a fixed height in meters, i.e. -10 would make symbol 10 meters high)

• mSymbolName : char

  Name of symbol

GM_VectorFeature_t

class globalmapper.GM_VectorFeature_t

This type is used as the base for any vector feature information

Attributes

List of attributes associated with feature

• mClass : boolean

  Global Mapper classification assigned to the feature

• mDesc : char

  Description of the feature

• mName : char

  Name of the feature

• mNumAttrs : uint16

  Number of attributes of vector feature

GM_HoleInArea_t

class globalmapper.GM_HoleInArea_t

This type is used to store information about holes within area features

Attributes

• mVertexElevList : uint32

  Optional list of elevations for each point in line. If present, must have mNumPoints values

GM_AreaFeature_t

class globalmapper.GM_AreaFeature_t

Attributes

• mAreaStyle : GM_AreaStyle_t

  Area render style (symbol and font)

• mFeatureInfo : GM_VectorFeature_t

  The General Vector Feature Info

• mHoleList : GM_HoleInArea_t

  Optional list of elevations for each point in area.

• mPointList : GM_Point_t

  List of points that make up the area (global coordinates when getting, native when adding feature)

• mNumHoles : uint32

  Number of elevations for each point in area

• mNumPoints : uint32

  Number of points that make up the area

• mVertexElevList : float

  Optional list of elevations for each point in line. If present, must have mNumPoints values

GM_LineFeature_t

class globalmapper.GM_LineFeature_t

Attributes

• mFeatureInfo : GM_VectorFeature_t

  The General Vector Feature Info

• mLineStyle : GM_LineStyle_t

  Optional list of elevations for each point in line. If present, must have mNumPoints values

GM_PointFeature_t

class globalmapper.GM_PointFeature_t

This type is used to return information about area features

Attributes

• mAreaStyle : GM_AreaStyle_t

  Area render style (symbol and font)

• mFeatureInfo : GM_VectorFeature_t

  The General Vector Feature Info

• mHoleList : GM_HoleInArea_t

  Optional list of elevations for each point in area.

• mPointList : GM_Point_t

  List of points that make up the area (global coordinates when getting, native when adding feature)

• mNumPoints : uint32

  Number of points that make up the area

• mVertexElevList : float

  Optional list of elevations for each point in line. If present, must have mNumPoints values

GM_FoundFeature_t

class globalmapper.GM_FoundFeature_t

?

Attributes

• mDistance : uint32

  Distance in pixels of feature from search location (Read-Only)

• mFeatureClassType : GM_FeatureClassType_t8

  Type of feature class (area, point, line) (Read-Only)

• mFeatureIndex : uint32

  Index of feature in layer (Read-Only)

• mLayer : GM_LayerHandle_t32

  Layer the feature is in (Read-Only)

GM_ExportOptsDXF_DWG_t

class globalmapper.GM_ExportsOptsDXF_DWG_t

?

Attributes

• mCADType : GM_ExportsOptsCADType_t8

  CAD Export Type

• mDWGVersion : GM_ExportOptsDWGVersion_t8

  DWG export only: version

• mFlags : GM_ExportsOptsDXFFlags_t3

  Export Flags

• mLabelType : GM_ExportsOptsDXFLabels_t8

  Export setting for area and line feature labels

• mLayerAttr : char

  Attribute value to get layer name from (NULL to use description/type)

• mTenPointFontHeight : float

  Height (in ground units) to use for 10 pt label fonts (other sizes will be scaled appropriately)

GM_ExportOptsKML_t

class globalmapper.GM_ExportsOptsKML_t

?

Attributes

• mAreaDisplayAtElev : boolean

  Display area features at feature elevation

• mFeatureInfo : GM_VectorFeature_t

  ?

• mAreaOpacity : float

  Opacity values for area features

• mExtrudeAreas : boolean

  Extrude 3D areas to make 3D shapes like buildings (only valid if mAreaDisplayAtElev set)

• mHidePointsInitialy : boolean

  Initially hide point features when displayed in Google Earth

• mLineDisplayAtElev : boolean

  Display line features at feature elevation

• mLineElevsRelative : boolean

  ?

• mDesc : char

  ?

• mBorderColor : COLORREF

  Border line color

• mBorderStyle : GM_PenStyle_t16

  Border pen style (i.e. solid, dash, etc.)

• mBorderWidth : uint16

  Border width in PDF points (pixels)

• mDPI : uint32

  Export DPI

• mFlags : GM_PDFExportsFlags_t32

  ?

• mDistance : uint32

  Footer font (NULL for default)

• mFooterStr : char

  Footer for page (NULL for none)

• mHeaderFont : GM_FontDef_t

  Header font (NULL for default)

• mHeaderStr : char

  Header for page (NULL for none)

• mMarginRect : GM_Rectangle_t

  Margins for each side in inches

• mPageSizeName : char

  Name of page size, like “Letter”, “Legal”, “A0”, etc.

• mSymbolScale : double

  Point symbol scaling factor (0.0 will be treated as 1.0, use 2.0 to double size, 0.5 to half size, etc.)

• mFeatureList : GM_FoundFeature_t

  This type is used to return a result set. The library will allocate it then you free it with a call to GM_FreeFeatureResultList

• mAddLabelAttr : boolean

  Include the display label as a LABEL attribute if present

• mAddLayerAttr : boolean

  Add LAYER and GM_TYPE attribute values

• mCADType : GM_ExportsOptsCADType_t8

  This type is used to describe custom export options for DXF/DWG vector exports

GM_ExportOptsSimpleText_t

class globalmapper.GM_ExportsOptsSimpleText_t

?

Attributes

• mAddStyleAttrs : boolean

  Include style attributes if attributes are included

• mCoordSep : char

  Coordinate separator (use NULL for default of comma)

• mFeatureSep : char

  Feature separator (use NULL for default of blank line)

• mReserved1 : uint8

  Reserved (for padding), must be 0

• mReseraved2 : uint8

  This type is used to describe custom export options for KML vector exports. To create a KMZ file, pass a filename with a .kmz extension to the GM_ExportVector function.

• mAreaDisplayAtElev : boolean

  Export Y/latitude/northing before X/longitude/easting

GM_ViewShedParams_t

class globalmapper.GM_ViewShedParams_t

?

Attributes

• mAngleEnd : float

  End angle in radians for radar sweep

• mAngleStart : float

  Start angle in radians for radar sweep

• mAtmosphericCorr : double

  Atmospheric correction value (1.0 for none)

• mCenterPoint : GM_Point_t

  Center point in global coordinates

• mColor : COLORREF

  ?

• mBorderColor : COLORREF

  View shed description

• mFilterRec : GM_Rectangle_t

  Optional rectangle for filtering view shed to a certain area of interest

• mFresnelFreq : double

  Frequency (in GHz) to use for testing clearance of first Fresnel zone (use 0.0 to not do Fresnel testing)

• mFresnelPctClear : double

  Percentage of first Fresnel zone that must be clear of obstacles (use 0.6 for 60%). If 0 is specified, the default of 60% is used.

• mGenCoveragePolys : boolean

  Generate area/polygon features for the covered area (these are vector and exportable to vector formats)

• mRadius : double

  Search radius in meters

• mReceiverAngle : double

  Angle (in degrees) above horizon to test at (NULL for none)

• mReceiverAngleEnd : double

  Angle (in degrees) above horizon to stop test at (NULL for none) - if this and mReceiverAngle are provided, an angle range view shed test is done (like a flashlight beam).

• mReceiverHeight : float

  Height at which transmitter must be visible

• mReceiverHeightAbs : boolean

  Is the receiver height absolute or relative to the ground?

• mShowHiddenPoints : boolean

  Make hidden points visible instead of viewable points.

• mAddLabelAttr : boolean

  This type is used to describe custom export options for Shapefile vector exports

• mSize : uint32

  Size of structure in bytes

• mTransmitterHeight : float

  Transmitter height in meters

• mTransmitterHeightAbs : boolean

  Is the transmitter height absolute or relative to the ground?

• mUseEarthCurvature : boolean

  This type is used to describe custom export options for Simple Text vector exports

• mVectorLayerList : GM_LayerHandle_t32

  List of vector layers to use features with elevation attributes from

• mVectorLayerListCnt : uint32

  Number of vector layers in list

• mXSpacing : double

  X sample spacing (use 0.0 for default spacing)

• mYSpacing : double

  Y sample spacing (use 0.0 for default spacing)

GM_ContourParams_t

class globalmapper.GM_ContourParams_t

?

Attributes

• mContourBounds : GM_Rectangle_t

  Bounds of contour lines to create. Pass empty rectangle to use entirety of passed in layer(s)

• mContourInterval : float

  This type is used to provide the parameters for performing a Viewshed analysis

• mCreateNonOverlappingAreas : boolean

  Create non-overlapping areas

• mDesc : char

  Contour layer description

• mDisableSmoothing : boolean

  Do not smooth the generated contour lines to improve their appearance

• mGenerateAreas : boolean

  Generate iso-height areas in addition to contour lines

• mGenerateSpotElevs : boolean

  Generate spot elevation points at minimum and maximum elevations

• mIntervalInFeet : boolean

  Set to TRUE if the contour interval is in feet rather than meters

• mNumberOnlyLabels : boolean

  Only include the value (and not the units string) in the contour labels

• mShowProgress : boolean

  Display contour generation progress dialog

• mSimpleThreshold : double

  Simplification threshold, use 0.0 for no simplification

• mSingleLevelOnly : boolean

  Only create a single contour level rather than treating as interva

• mSize : uint32

  Size of structure

• mXSpacing : double

  Sample spacing in the x direction

• mYSpacing : double

  Sample spacing in the y direction

GM_PathProfileLOSParams_t

class globalmapper.GM_PathProfileLOSParams_t

?

Attributes

• mAtmosphericCorr : double

  Atmospheric correction for LOS (1.3333 is standard for radio waves, 1.0 is no correction)

• mDetailsStr : char

  String containing path details (set to NULL if you don’t care)

• mDetailsStrMaxLen : uint32

  Maximum length of details string

• mDfltElev : float

  Elev to use when none could be found

• mElevList : float

  List of Elevations (set to NULL if you don’t care).

• mEndX : double

  End X coord in current projection

• mEndY : double

  End Y coord in current projection

• mFlags : GM_PathProfileLOSFlags_t32

  Flags controlling behavior

• mFresnelFreq : double

  Frequency (in GHz) to use for testing clearance of first Fresnel zone (use 0.0 to not do Fresnel testing)

• mFresnelPctClear : double

  Percentage of first Fresnel zone that must be clear of obstacles (use 0.6 for 60%). If 0 is specified, the default of 60% is used.

• mListSize : uint32

  Number of elevations to retrieve

• mLOSFirstBlockedPos_t : GM_Point_t

  Location of first blocked location along path (only valid if mLOSMinClearance is negative)

• mLOSFromHeight_t : float

  Line-of-sight from height in meters

• mLOSLastBlockedPos_t : GM_Point_t

  Location of last blocked location along path (only valid if mLOSMinClearance is negative)

• mLOSMinClearance_t : flaot

  This type is used to provide the parameters for generating contours

• mLOSToHeight_t : float

  Line-of-sight to height in meters

• mSize : uint32

  Size of structure

• mStartX : double

  Start X coord in current projection

• mStartY : double

  Start Y coord in current projection

GM_AreaVolumeParams_t

class globalmapper.GM_AreaVolumeParams_t

?

Attributes

• mCutHeight : float

  Cut height in meters above sea level

• mFillGaps : boolean

  Interpolate to fill small gaps in data

• mPoints : GM_Point_t

  List of points in area in global coordinate system

• mNumPoints : uint32

  Number of points in area

• mSize : uint32

  Size of structure

• mXSpacing : double

  Sample spacing in the x direction in global units

• mYSpacing : double

  Sample spacing in the y direction in global units

GM_LineVolumeParams_t

class globalmapper.GM_LineVolumeParams_t

Attributes

• mCooridorWidth : double

  Width (i.e. diameter) in meters of corridor around line in which to calculate volume

• mCutHeight : float

  Cut height for each point in meters

• mCutHeightsAbsolute : boolean

  Are the cut heights in mCutHeights relative to sea level (TRUE) or ground level (FALSE)

• mPoints : GM_Point_t

  List of points in area in global coordinate system

• mNumPoints : uint32

  Number of points

• mSize : uint32

  Size of structure

• mXSpacing : double

  Sample spacing in the x direction in global units

• mYSpacing : double

  Sample spacing in the y direction in global units

GM_ValueStats_t

class globalmapper.GM_ValueStats_t

?

Attributes

• mAvg : double

  Average value

• mCount : uint64

  Count

• mMin : double

  Minimum

• mMax : double

  Maximum

• mStdDev : double

  Standard Deviation

GM_AreaElevStats_t

class globalmapper.GM_AreaElevStats_t

Attributes

• mAvgElev : double

  Average elevation in meters

• mAvgSlope : double

  Average elevation in degrees

• mMaxElev : double

  Maximum elevation in meters

• mMaxSlope : double

  Maximum slope in degrees

• mMinElev : double

  Minimum elevation in meters

• mModeElev : double

  Approximate mode value of elevation in meters

• mNumIgnoredSamples : uint64

  Number of samples that were ignored due to being outside the crop areas or having no elevation

• mNumSamples : uint64

  Number of locations sampled to compute statistics

• mSize : uint32

  Size of structure

• mStdDevElev : double

  Standard deviation of elevation in meters

• mStdDevSlope : double

  Standard deviation of slope in degrees

GM_ContrastBandRange_t

class globalmapper.GM_ContrastBandRange_t

Attributes

• mBand : uint32

  Number of Bands

• mMinVal : float

  Minimum value

• mMaxVal : float

  Maximum value

GM_ContrastSetup_t(aContrastMode=0, aNumStdDevs = 0.0)

class gm.GM_ContrastSetup_t

Attributes

• aContrastMode : GM_ContrastMode_t8

  Contrast mode

• aNumStdDevs : float

  Number of standard deviations

• mBandRanges : GM_ContrastBandRange_t

  Number of Bands

• mMode : GM_ContrastMode_t8

  Mode

• mNumBandRanges : uint32

  Number of band ranges

• mNumStdDevs : double

  Number of standard deviations

GM_RasterDisplayOptions_t

class globalmapper.RasterDisplayOptions_t

Attributes

• mAutoClipCollar : boolean

  Automatically crop off a DRG, BSB, or other known collar boundary

• mBandIdxBlue : uint8

  Index of color band (0-based) to use for blue color channel

• mBandIdxGreen : uint8

  Index of color band (0-based) to use for green color channel

• mBandIdxRed : uint8

  Index of color band (0-based) to use for red color channel

• mBandLayoutValid : boolean

  Are the band layout values valid?

• mBlendMode : GM_BlendMode_t8

  Blend mode to use to blend this raster layer with underlying layers or to interpret the color values of the layer

• mBlueAdjustPercent : sint8

  Percentage to adjust blue color channel by (-100 to 100)

• mColorGradeBlueInMax : uint8

  Maximum Blue input color value

• mColorGradeBlueInMin : uint8

  Minimum Blue input color value

• mColorGradeBlueOutMax : uint8

  Maximum Blue output color value

• mColorGradeBlueOutMin : uint8

  Minimum Blue output color value

• mColorGradeGreenInMax : uint8

  Maximum Green input color value

• mColorGradeGreenInMin : uint8

  Minimum Green input color value

• mColorGradeGreenOutMax : uint8

  Maximum Green output color value

• mColorGradeGreenOutMin : uint8

  Minimum Green output color value

• mColorGradeRedInMax : uint8

  Maximum red input color value

• mColorGradeRedInMin : uint8

  Minimum red input color value

• mColorGradeRedOutMax : uint8

  Maximum red output color value

• mColorGradeRedOutMin : uint8

  Minimum red output color value

• mColorGradeSaturation : float

  Saturation (valid 0.0 - 1.0)

• mColorGradeValid : boolean

  Are the color grade options valid?

• mColorIntensity : uint8

  Color intensity (0-20). Lower values are lighter, higher values are darker.

• mContrastMode : GM_ContrastMode_t8

  Contrast adjustment mode

• mContrastNumStdDev : double

  Number of standard deviations from mean to stretch for contrast adjustment (if 0 is used the default of 2 will be used)

• mContrastShared : boolean

  Is the contrast adjustment shared with other loaded layers?

• mGreenAdjustPercent : sint8

  Percentage to adjust green color channel by (-100 to 100)

• mRedAdjustPercent : sint8

  Percentage to adjust red color channel by (-100 to 100)

• mSamplingMethod : GM_SamplingMethod_t8

  Specify how resampling should be done for this layer for display and export

• mSize : uint32

  Size of structure

• mTextureMap : boolean

  Texture map this raster layer over any underlying elevation layers.

• mTranslucency : uint16

  Translucency level of layer (0 - completely see-through, 512 - completely opaque)

• mTransparent : boolean

  Is layer transparent?

• mTransparentColor : COLORREF

  Color to make transparent

• mTransparentColorDist : uint8

  Fuzzy transparency support. Distance from transparent color to treat nearby colors transparent.

• mTransparentColorList : COLORREF

  List of colors to make transparent.

GM_ElevationOverrides_t

class globalmapper.GM_ElevationOverrides_t

Attributes

• mClampVals : boolean

  Clamp out of range values to specified min/max.

• mElevUnits : GM_ElevUnits_t8

  Native elevation units for file.

• mLayerShader : character

  Name of elevation shader to use for layer (NULL for default shared shader)

• mMaxElev : float

  Maximum valid elevation (meters)

• mMaxValid : boolean

  Is the new maximum elevation valid

• mMinElev : float

  Minimum valid elevation (meters)

• mMinValid : boolean

  Is the new minimum elevation valid

• mOffset : float

  Offset to apply to elevations in meters

• mScale : double

  Scale factor to apply

• mVoidElev : float

  Elevation to use for void values

• mVoidValid : boolean

  Is the void elevation value valid?

GM_ShaderOptions_t

class globalmapper.GM_ShaderOptions_t

This type is used to provide the parameters for calculating path profiles and performing line of sight analysis

Attributes

• ?

  Surface color for daylight shader

• mGradientShaderHiColor : COLORREF

  Max elevation color for gradient shader.

• mGradientShaderLoColor : COLORREF

  Min elevation color for gradient shader

• mHSVShaderLoColorStart : COLORREF

  HSV Shader - Low Color Start in Degrees (0-360)

• mHSVShaderRange : double

  HSV Shader - Range (>1)

• mHSVShaderReverse : boolean

  HSV Shader - Reverse colors

• mHSVShaderSaturation : double

  HSV Shader - Saturation (0-1)

• mHSVShaderValue : double

  HSV Shader - Value (0-1)

• mReserved : uint8

  Reserved padding bytes

• mSize : uint32

  Size of structure

• mSlopeShaderCustomColor : COLORREF

  Color to display between min and max slope for slope shader (set mSlopeShaderCustomValid to TRUE to enable)

• mSlopeShaderCustomValid : boolean

  Is the custom slope shader color valid?

• mSlopeShaderMaxColor : COLORREF

  Max slope color for slope shader

• mSlopeShaderMinColor : COLORREF

  Min slope color for slope shader

• mSlopeShaderMaxSlope : float

  Max slope for slope shader in radians

•mSlopeShaderMinSlope : float

Min slope for slope shader in radians

GM_MapCatalogInfo_t

class globalmapper.GM_MapCatalogInfo_t

Attributes

• mDisplayType : GM_MapCatalogDisplayType_t8

  Controls when layers in catalog are displayed

• mDisplayValue : double

  First value related to display type

• mDisplayValue2 : double

  Second value for range of scales

• mNumMaps : uint32

  Number of maps in catalog.

• mReserved : uint8

GM_RasterLayout_t

class globalmapper.GM_RasterLayout_t

?

Attributes

• ?

  Cut height in meters above sea level

• mFillGaps : boolean

  Interpolate to fill small gaps in data

• mPoints : GM_Point_t

  List of points in area in global coordinate system

• mNumPoints : uint32

  Number of points in area

• mSize : uint32

  Size of structure

• mXSpacing : double

  Sample spacing in the x direction in global units

• mYSpacing : double

  Sample spacing in the y direction in global units

GM_ContrastSetup_t(aContrastMode=0, aNumStdDevs = 0.0)

class globalmapper.GM_ContrastSetup_t

This type represents the options available for a contrast adjustment mode

Attributes

• aContrastMode : GM_ContrastMode_t8

  Contrast mode

• aNumStdDevs : float

  Number of standard deviations

• mBandRanges : GM_ContrastBandRange_t

  Number of Bands

• mMode : GM_ContrastMode_t8

  Mode

• mNumBandRanges : uint32

  Number of band ranges

• mFlags : GM_RasterLayoutFlags_t32

  General flags for layout.

• mTopLeft : GM_Point_t

  Ground coordinates of top left corner of the top left pixel

• mXPixelSize : double

  Size of each pixel in the x direction

• mAutoClipCollar : boolean

  This type represents the display options available for raster and elevation layers

• mPixelHeight : sint32

  Number of pixels in the x direction

• mNumBands : uint32

  Number of bands of data (usually 1 for grayscale or 3 for RGB). Does NOT include alpha unless GM_RasterLayout_AlphaPresent is set and mAlphaBandIdx < mNumBands. Use mAlphaBandIdx to see which band is alpha.

• mBitsPerBand : uint32

  Number of bits per band of data (usually 8)

• mBytesPerRow : uint32

  Number of bytes per row of data in data buffer. If 0 this will be calculated for you.

• mPalette : COLORREF*

  Array of colors for palette (set to NULL for no palette)

• mPaletteSize : uint32

  Number of colors in palette

• mAlphaBandIdx : uint32

  0-based alpha channel band index (usually = mNumBands). Ignored unless GM_RasterLayout_AlphaPresent flag is set.

• mValType : GM_BandValType_t8

  Band value type (only used if size matches mBitsPerBands or mBitsPerBand is 0)

• mAlphaValType : GM_BandValType_t8

  Band value type of alpha band. Only use something other than GM_VAL_NUM_TYPES if you want the opaque alpha to be based on the maximum of a band type different than mValType. For example, if the opaque alpha is 255 but you have 16-bit samples (mValType = GM_VAL_U16), use mAlphaValType = GM_VAL_U8 to specify this.

GM_GridLayout_t

class globalmapper.GM_GridLayout_t

This type represents any adjustments to apply to elevation values within a gridded elevation layer.

Attributes

• mClampVals : boolean

  Clamp out of range values to specified min/max.

• mElevUnits : GM_ElevUnits_t8

  Native elevation units for file.

• mLayerShader : character

  Name of elevation shader to use for layer (NULL for default shared shader)

• mMaxElev : float

  Maximum valid elevation (meters)

• mMaxValid : boolean

  Is the new maximum elevation valid

• mMinElev : float

  Minimum valid elevation (meters)

• mMinValid : boolean

  Is the new minimum elevation valid

• mOffset : float

  Offset to apply to elevations in meters

• mScale : double

  Scale factor to apply

• mVoidElev : float

  Elevation to use for void values

• mVoidValid : boolean

  Is the void elevation value valid?

GM_FillGapsParams_t

class globalmapper.GM_FillGapsParams_t

Structure defining parameters for gap filling

Attributes

• mFlags : GM_RasterLayoutFlags_t32

  General flags for layout.

• mTopLeft : GM_Point_t

  Ground coordinates of center of the top left pixel

• mXSpacing : double

  Spacing of sample cells in the X direction

• mYSpacing : double

  Spacing of sample cells in the Y direction

• mNumSamplesX : sint32

  Number of pixels in the x direction

• mNumSamplesY : sint32

  Number of pixels in the y direction

• mBytesPerRow : uint32

  Number of bytes per row of data in data buffer. If 0 this will be calculated for you.

• mNoDataValue : float

  Value of samples for which the value isn’t known (i.e. -9999.9)

• mValType : GM_BandValType_t8

  Band value type

• mElevUnits : GM_ElevUnits_t8

  Elevation units

• mReserved[2] : uint8

  Reserved for alignment purposes

GM_AsciiFormatInfo_t

class globalmapper.GM_AsciiFormatInfo_t

This type represents layout information for a generic ASCII import

Attributes

• mImportType : GM_AsciiImportType_t8

  specify import type

• mCoordDelim : GM_AsciiCoordDelim_t8

  sepcify coordinate delimeter

• mCoordOrder : GM_AsciiCoordOrder_t8

  coordinate order

• mIncludeCoordAttrs : boolean

  include attributes from coordinate lines

• mIncludeCoordsAsAttrs : boolean

  include coordinates as attributes

• mColumnHeadersInFirstRow : boolean

  is the first row of the file column headers? (like for CSV files)

• mIncludeElevCoords : boolean

  is the 3rd coordinate column an elevation or Z value? Must be TRUE for eAsciiImportElevation import type.

• mColumnsToSkip : uint8

  columns to skip before reaching coordinate columns

• mLinesToSkip : uint8

  number of lines to skip at start of file

• mCoordLinePrefix : const char*

  prefix to look for at beginning of coordinate lines (default to NULL or empty)

• mAreaType : AreaFeatureClass_t16

  area type to assign to imported created area features

• mLineType : LineFeatureClass_t16

  line type to assign to imported created line features

• mPointType : PointFeatureClass_t16

  point type to assign to imported point features

• mIgnoreZeroElevations : boolean

  ignore features with an elevation of zero

• mFillToBounds : boolean

  fill grid to full bounds of data (i.e. don’t constrict to convex hull)

• mOffsetX : double

  offset to apply to X coordinates

• mOffsetY : double

  offset to apply to Y coordinates

• mOffsetZ : double

  offset to apply to Z coordinates

• mScaleX : double

  Scale to apply to X coordinates (default is 1.0)

• mScaleY : double

  Scale to apply to Y coordinates (default is 1.0)

• mScaleZ : double

  Scale to apply to Z coordinates (default is 1.0)

• mNoDataDistanceFactor : double

  tightness factor to use when gridding 3D data. Use 0.0 for default.

• mBreakOnColumnIdx : uint8*

  index of column to break features on when value changes. Pass NULL for default break behavior.

• mCoordFormat : GM_AsciiCoordFormat_t8

  coordinate format

GM_GridGenSetup_t

class globalmapper.GM_GridGenSetup_t

This type represents the input needed for gridding a set of vector data

Attributes

• mDesc : const char*

  Grid description

• mFlags : GM_GridGenFlags_t32

  Flags for grid generation

• mXRes : double

  X resolution (in current proj units) to generate grid at (use 0.0 for auto-spacing determination)

• mYRes : double

  Y resolution (in current proj units) to generate grid at (use 0.0 for auto-spacing determination)

• mElevUnits : UNIT

  Units to generate grid at (elevation values in other units will be converted as needed)

• mGridAlg : GM_GridAlg_t8

  Algorithm to use for creating elevation grid (if any)

• mLidarField : GM_LidarGridField_t8

  Field of Lidar data to grid if gridding Lidar point clouds

• mBandType : GM_BandValType_t8

  Band type to use for non-elevation gridding

• mLidarBreaklineBinMult : uint8

  Number of cells to clear from a Lidar grid around 3D breaklines before applying breakline heights and filling gaps (valid if GM_GridGen_ApplyLidarBreaklines used). Typically in range 1-4.

• mBounds : const GM_Rectangle_t*

  Bounding box to grid to in current proj units. Pass NULL to use the combined bounds of all input layers (the default).

• mTightnessMult : double

  Grid tightness multiplier (multiplies resolution) for discarding values far from a sample. Default of zero discards nothing. For Lidar bin gridding you typically do NOT want to use 0 as it can be very slow to fill all gaps in irregular Lidar data. Use GM_GRID_DISABLE_GAP_FILL to disable gap filling altogether. For Lidar bin grids, gap fill values in the range 1-32 are common.

• mGridBinMult : double

  Grid bin multiplier for use if using a bin-based grid method. This is multiple of calculated point density.

• mTaperValue : double

  Taper value for gridding areas. 0.0 for no taper (default)

• mGapFillSetup : const GM_FillGapsParams_t*

  Parameters to perform gap fill operations. Use NULL for default parameters.

GM_GridCombineSetup_t

class globalmapper.GM_GridCombineSetup_t

This type represents the input needed for creating a new grid layer by combining 2 input grid layers

Attributes

• mCombineOp : GM_CombineOp_t8

  Combine operation

• mLayer1 : GM_LayerHandle_t32

  First input grid layer

• mLayer2 : GM_LayerHandle_t32

  Second input grid layer

• mRectBounds : GM_Rectangle_t

  Bounding rectangle in current projection in which to perform operation. Keep at null rectangle (all zero values) to use default of intersection of input grid layers.

• mXRes : double

  X resolution (in current proj units) to generate grid at (use 0.0 for auto-spacing determination)

• mYRes : double

  Y resolution (in current proj units) to generate grid at (use 0.0 for auto-spacing determination)

• mDesc : const char*

  Grid description

• mFlags : GM_CombineOpFlags_t32

  Flags to control operation

• mElevUnits : GM_ElevUnits_t8

  Elevation units for new grid layer

• mCompareVal : float

  Compare value to use for operations that compare to a value

GM_DatumInfo_t

class globalmapper.GM_DatumInfo_t

This type represents information about a datum

Attributes

• mMethod : GM_DatumXForm_t32

  Transformation method

• mDatumName : const char*

  Name of datum

• mEllipsoidName : const char*

  Name of ellipsoid this datum is based on

• mDeltaX : double

  Delta X in meters

• mDeltaY : double

  Delta Y in meters

• mDeltaZ : double

  Delta Z in meters

• mScale : double

  Scale factor (GM_Datum_BursaWolfe only)

• mRotX : double

  Rotation in X in arc seconds (GM_Datum_BursaWolfe only)

• mRotY : double

  Rotation in Y in arc seconds (GM_Datum_BursaWolfe only)

• mRotZ : double

  Rotation in Z in arc seconds (GM_Datum_BursaWolfe only)

• mPrimeMeridian : double

  Prime meridian for datum (0.0 for Greenwich)

• mPrimeMeridianName : const char*

  Optional name of prime meridian

• mSemiMajor : double

  Ellipsoid semi-major axis (output only)

• mSemiMinor : double

  Ellipsoid semi-major axis (output only)

GM_ElevColor_t

class globalmapper.GM_ElevColor_t

This type represents a single elevation/color pair for a custom shader

Attributes

• mElev : float

  Elevation value in meters

• mColor : COLORREF

  Color value

GM_CustomShader_t

class globalmapper.GM_CustomShader_t

This type represents a custom elevation shader

Attributes

• mShaderName : const char*

  Name to use for the shader

• mFlags : GM_CustomShaderFlags_t32

  Shader flags

• mNumElevs : uint32

  Number of elevation/color pairs

• mElevColorList : GM_ElevColor_t*

  List of elevation/color pairs for shader

GM_WebFormatExportOpts_t

class globalmapper.GM_WebFormatExportOpts_t

This type represents the options when exporting to a web format

Attributes

• mMapName : const char*

  Name to use for map set (applies to web formats that generate a HTML or source definition file of some kind).

• mMaxZoomLevel : sint32

  Maximum zoom level to export at (Google Maps, Virtual Earth/Bing Maps, WorldWind, MBTiles, RMaps exports only). Use zero for default value based on resolution of most detailed layer involved in export.

• mNumZoomLevels : uint32

  Number of zoom levels to export (Google Maps, Virtual Earth/Bing Maps, WorldWind, MBTiles, RMaps exports only)

• mFormat : GM_RasterExportFormat_t32

  Image format (doesn’t apply to vector formats, like GM_Export_MBVT)

• mFlags : GM_WebExportFlags_t32

  Export flags

• mApiKey : const char*

  API key (used for Google Maps and Bing Maps exports)

• mBgMapName : const char*

  Background map name - used for Google Maps export (ie. ROADMAP, SATELLITE, HYBRID, or TERRAIN) or Bing Maps (i.e. road, aerial, birdseye, canvasDark, canvasLight, or grayscale)

• mTranslucency : double

  Translucency setting for new map (0.0 - 1.0). 1.0 is opaque. If 0.0 is provided, it will be assumed to be 1.0.

• mXRes : double

  X resolution for export (arc degrees for KML, meters for other, default of 0.0 is full resolution). Used to auto-select mMaxZoomLevel if not provided.

• mYRes : double

  Y resolution for export (arc degrees for KML, meters for other, default of 0.0 is full resolution). Used to auto-select mMaxZoomLevel if not provided.

• mWWTilePath : const char*

  path to where WorldWind tiles should be stored. If NULL the path to the provide XML file will be used

• mTileCount : uint32*

  save how many tiles were saved (or would be if estimating with GM_WebExport_OnlyGetTileCount)

• mCustomTileFName : const char*

  custom definition for tile filenames. Use NULL for default for format. Use variables like %z for zoom, %x for column, and %y for row. For example, use “%zprefix_%y_%x.png” to do one folder per zoom level. The tiles are created in the path under the HTML filename path.

• mMapDescription : const char*

  Description for the map. Currently only used with MBTiles exports.

• mMapType : const char*

  Type of MBTiles map. Must be “baselayer” or “overlay”.

• mTileSize : uint32

  Pixel size of tile (i.e. 256, 512, 1024, etc.). Value of 0 results in default tile size (usually 256x256)

GM_ExportOptsGeoPackage_t

class globalmapper.GM_ExportOptsGeoPackage_t

This type is used to describe custom export options for GeoPackage exports

Attributes

• mOverwriteExisting : boolean

  Indicates whether or not to overwrite an existing GeoPackage file

• mAreaTableName : const char*

  Table name for area features. NULL if not exporting areas.

• mLineTableName : const char*

  Table name for line features. NULL if not exporting lines.

• mPointTableName : const char*

  Table name for point features. NULL if not exportin points.

• mSplitByLayer : boolean

  Indicates whether or not to split features in to separate tables by layer.

• mGen3dFeatures : boolean

  Indicates whether or not to create 3D features.

• mTileTableName : const char*

  Table name for raster tiles. NULL for default “tile_data”.

• mDescription : const char*

  Description for tile layer

• mMaxZoomLevel : sint32

  Maximum zoom level to export. Valid range is 3 to 22.

• mNumZoomLevels : uint32

  Total number of zoom levels to export

• mImageFormat : GM_RasterExportFormat_t32

  Image format (PNG or JPEG)

• mImageQuality : uint32

  Image quality. Applies only to JPEG exports. Range is 1 to 100. Default is 75.

• mTileSize : uint32

  Tile size in pixels. Valid values are 256, 512, and 1024. Default is 256. Tiles are square, so 256 means 256 x 256 pixel tiles.

• mFlags : GM_WebExportFlags_t32

  Additional related for skipping empty tiles, skipping tiles that already exist, etc.

GM_DensityGridParams_t

class globalmapper.GM_DensityGridParams_t

Structure to define options for calculating a density grid

Attributes

• mFlags : GM_DensityGridFlags_t32

  ?

• mKernelType : GM_DensityKernelType_t8

  ?

• mRadiusMeters : double

  radius in meters for kernel (use 0 for a default)

• mCellsPerRadius : uint32

  how many cells in each direction to have per radius (use 0 to use default of 3 cells in each direction per radius)

• mLayerDesc : const char*

  description to use for new layer, or NULL/empty for default

• mField : const char*

  name of attribute field to compute on. Set to NULL/empty string to just count points

• mAreaUnits : GM_AreaUnits_t8

  units of area measure

• mBoundingBox : GM_Rectangle_t

  bounding box in layer units. Provide empty box to use default of entire layer.

GM_RoughnessGridParams_t

class globalmapper.GM_RoughnessGridParams_t

Structure defining setup for a roughness operation

Attributes

• mTable : GM_RoughnessTable_t

  table to use for converting color/land cover type to roughness values

• mFlags : GM_RoughnessGridFlags_t32

  misc. flags to control operation

• mBounds : GM_Rectangle_t

  bounding rectangle (in specified projection) for roughness grid (pixel-is-area, i.e. provide coordinates of outer edge of sample not center of pixel)

• mDesc : const char*

  layer description

• mXSpacing : double

  grid cell spacing in X dimension in specified projection coordinates (use 0.0 for default)

• mYSpacing : double

  grid cell spacing in Y dimension in specified projection coordinates (use 0.0 for default)

• mCreateAreas : boolean

  create roughness areas.

GM_WatershedParams_t

class globalmapper.GM_WatershedParams_t

Type defining parameters for watershed/drainage/stream calculation

Attributes

• mFlags : GM_WatershedFlags_32

  flags with misc. options

• mBounds : GM_Rectangle_t

  bounding rectangle (in specified projection) for watershed

• mDesc : const char*

  layer description

• mXSpacing : double

  grid cell spacing in X dimension in specified projection coordinates (use 0.0 for default)

• mYSpacing : double

  grid cell spacing in Y dimension in specified projection coordinates (use 0.0 for default)

• mFilledDEMFilename : const char*

  filename to save filled DEM to as a GMG file (typically NULL or empty string)

• mMaxDepressionDepth : float

  Maximum depth of depression to fill in meters (0.0 for no depression filling)

• mStreamThreshold : uint32

  Drainage threshold for how many cells have to flow to a cell before it is considered part of a stream.

GM_EqualValueAreaSetup_t

class globalmapper.GM_EqualValueAreaSetup_t

Type defining the parameters for creating equal-value areas

Attributes

• mFlags : GM_EqualValueAreaFlags_t32

  flags controlling the operation

• mValAttrName : const char*

  name of attribute to save value (color/elev/slope) in

• mAreaType : AreaFeatureClass_t16

  area type to assign to area features

• mColorDist : sint32

  allowed fudge factor for colors

• mElevDist : double

  (meters) allowed difference for elevations (bucket size will be twice this value)

• mSlopeDist : double

  (radians) allowed difference for slopes or (degrees) slope direction [if GM_EqualValueArea_UseSlopeDir is set in mFlags]

• mBounds : GM_Rectangle_t

  bounds to create in (empty means all)

• COLORREF* : const

  list of colors to consider (NULL for all)

• mColorListSize : uint32

  number of colors in the list of colors to consider

• mValAttrFormat : const char*

  formatting string to use for value attribute (NULL is default, can be C-style format string like “RGB( %d, %d, %d )” or “#%02X%02X%02X”). Must have 3 values for color, 1 for slope or elevation.

• mLayerDesc : const char*

  name of the resulting layer

• mElevRangeHigh : double

  (meters) highest elevation to consider if GM_EqualValueArea_UseElevRange is in mFlags

• mElevRangeLow : double

  (meters) lowest elevation to consider if GM_EqualValueArea_UseElevRange is in mFlags

• mMinHoleSizeSqM : double

  (square meters) minimum size of island/hole area to keep. Any islands smaller than this will be marked as deleted.

• mMinAreaSizeSqM : double

  (square meters) minimum size of area feature to keep. Any area featurs smaller than this will be marked as deleted.

• mSimplifyMult : double

  simplification threshold multiplier for simplifying results. The simplification threshold will be the ‘pixel_spacing * mSimplifyMult’. Use 0.0 to just remove vertices along straight edges.

• mSmoothCount : uint8

  how many times to smooth resulting features. Use 0 to disable smoothing passes.

GM_OnlineSourceInfo_t

class globalmapper.GM_OnlineSourceInfo_t

This type is used to return information about available online sources

Attributes

• mName : const char*

  Name of the online source. This can be passed to GM_LoadOnlineLayer

• mType : GM_OnlineSourceType_t

  Source type

• mAttrList : GM_AttrValue_t*

  List of additional attributes and values for the source

• mAttrListSize : uint32

  Number of entries in mAttrList

GM_ConvolutionLayerSetup_t

class globalmapper.GM_ConvolutionLayerSetup_t

Settings for creating a new layer by applying a convolution filter

Attributes

• mFlags : GM_ConvolutionLayerFlags_t32

  misc. options for the process

• mLayerDesc : const char*

  description for new layer (NULL for default)

• mSamplingMethod : GM_SamplingMethod_t8

  sampling method for convolution filter to apply (if not custom). GM_SAMPLING_NEAREST_NEIGHBOR can be used to just get a direct copy.

• mCustomFilter : const double*

  if non-NULL, specifies a NxN array of weight values to apply to generate the new layer

• mCustomFilterSize : uint8

  if mCustomFilter is not NULL, specifies the size of each N dimension of the filter. For example, a value of 3 means a 3x3 grid of 9 values.

• mPixelRect : GM_PixelRect_t

  portion of the image to include in the new layer. An empty rectangle (default) means use the entire image.

GM_MouseEventInfo_t

class globalmapper.GM_MouseEventInfo_t

Structure for holding mouse event information

Attributes

• mFlags : uint32

  Flags passed in with WM_* mouse message

• mX : sint32

  Mouse pointer location X value

• mY : sint32

  Mouse pointer location Y value

GM_OnlineEventInfo_t

class globalmapper.GM_OnlineEventInfo_t

Structure for holding online layer info for event

Attributes

• mLayerHandle : void*

  handle to online layer (OnlineRasterOverlay*)

• mZoomScale : sint32

  zoom scale for draw/export if applicable

• mDataStr : const char*

  extra string data, like tile filename, if applicable

• mRenderAborted : boolean

  did the user request a cancel after this failure?

GM_Point3D_t

class globalmapper.GM_Point3D_t

Structure for holding a 3D Point

Attributes

• mX : double

  Easting/Longitude

• mY : double

  Northing/Latitude

• mElev : float

  Elevation

GM_MouseMoveInfo_t

class globalmapper.GM_MouseMoveInfo_t

Structure for holding mouse move information

Attributes

• mFlags : uint32

  Flags passed in with WM_MOUSEMOVE mouse message

• mX : sint32

  Mouse pointer location X value

• mY : sint32

  Mouse pointer location Y value

• mPosition : GM_Point3D_t

  Geographic location

GM_PreTranslateMessageInfo_t

class globalmapper.GM_PreTranslateMessageInfo_t

Structure used for the GM_PreTranslateMessage event. Sent only to GM extensions, and should only be required if your extension has a modeless dialog or its own main window.

Attributes

• mMSG : void*

  The windows MSG structure to be passed to CWinApp::PreTranslateMessage()

• mMsgProcessed : boolean

  Set this to TRUE if your extension processes the message, FALSE to have the message processed by GM.

GM_GPS_Position_t

class globalmapper.GM_GPS_Position_t

Structure for holding GPS position

Attributes

• mLat : double

  Latitude

• mLon : double

  Longitude

GM_GPS_Waypoint_t

class globalmapper.GM_GPS_Waypoint_t

Structure for holding GPS waypoint information

Attributes

• mPos : GM_GPS_Position_t

  Current location (lat/lon radians)

• mAltitude : float

  Altitude above sea level in meters

• mName[256] : char

  Waypoint name

• mGroupId : uint8

  Group ID (0 - 99)

• mIcon : uint8

  Icon (0-99)

• mSerialCode : uint32

  Serial code of sender

• mTimeStamp : time_t

  UTC time of waypoint creation

GM_GPS_Text_Msg_t

class globalmapper.GM_GPS_Text_Msg_t

Structure for holding GPS text message information

Attributes

• mDeviceName[32] : char

  Sending device name

• mMessage[256] : char

  Message

• mGroupId : uint8

  Group ID (0 - 99)

• mIcon : uint8

  Icon (0-99)

• mSerialCode : uint32

  Serial code of sender

• mTimeStamp : time_t

  UTC time of message transmission

GM_ExtCommandState_t

class globalmapper.GM_ExtCommandState_t

Structure for holding enable/check state for extension toolbar button/menu items

Attributes

• mCmdId : uint32

  command ID for toolbar button or menu

• mFlags : GM_ExtCmdStateFlags_t32

  flags to set. Change to disable or check item (defaults are zero)

GM_BandValEx_t32

class globalmapper.GM_BandValEx_t32

Define what a band value is. For layers that can also have floating point values use GM_BandValEx_t32

Attributes

• mInt : GM_BandVal_t32

  32-bit integer value

• mFloat : float

  32-bit float value

GM_Point_t

class globalmapper.GM_Point_t

This describes a single point location

Attributes

• mX : double

  X (or longitude) coordinate

• mY : double

  Y (or latitude) coordinate

GM_Rectangle_t

class globalmapper.GM_Rectangle_t

This type describes a bounding rectangle in world coordinates ???

Attributes

• mMinX : double

  Minimum x/easting/longitude coordinate

• mMinY : double

  Minimum y/northing/latitude coordinate

• mMaxX : double

  Maximum x/easting/longitude coordinate

• mMaxY : double

  Maximum y/northing/latitude coordinate

GM_PixelRect_t

class globalmapper.GM_PixelRect_t

This type describes a bounding rectangle in pixel coordinates

Attributes

• mLeft : sint32

  Left coordinate of rectangle

• mRight : sint32

  Right coordinate of rectangle

• mTop : sint32

  Top coordinate of rectangle

• mBottom : sint32

  Bottom coordinate of rectangle

GM_VerticalDisplayOptions_t

class globalmapper.GM_VerticalDisplayOptions_t

Structure with options controlling the display of terrain data NOTE: This structure is also used by the Global Mapper SDK, so new members should only be added to the bottom unless you can fit a new one in unused packing space.

Attributes

• mSize : uint32

  Size of structure

• mShaderName : const char*

  Shader name

• mAmbientLight : float

  Ambient light level (Range: 0.0 - 1.0)

• mVertExag : float

  Vertical exaggeration (Range: 0.1 - 10.0)

• mLightAltitude : float

  Light altitude (Range: 0.0 - 90.0)

• mLightAzimuth : float

  Light azimuth (Range: 0.0 - 360.0)

• mHillShading : boolean

  Is hill shading enabled?

• mWaterEnabled : boolean

  Is Water display enabled?

• mWaterAlpha : uint8

  Alpha translucency of water (Range: 0 - 255)

• mWaterColorRed : uint8

  Water color - red component

• mWaterColorGrn : uint8

  Water color - green component

• mWaterColorBlue : uint8

  Water color - blue component

• mWaterLevel : float

  Water level (meters)

• mShadeDarkness : uint8

  Maximum hill shader shadow darkness (0 - 255, 0 is black, 255 is white)

• mShadeHighlight : uint8

  Highlight level (whiteness) to apply for direct sunlight (0 is no additional whiteness, and 255 is completely white)

• mSlopeAlgorithm : GM_SlopeAlg_t8

  Slope calculation algorithm

• mLightBlendingAlgorithm : GM_ShaderBlendingAlg_t8

  Algorithm used to blend intensity when using multiple light sources

• mLightNumSources : uint32

  Number of light sources (Range: 1 - 360)

GM_ProjAttrValue_t

class globalmapper.GM_ProjAttrValue_t

This type is used to describe a single projection attribute value

Attributes

• mAttr : PROJATTR

  Attribute

• mValue : double

  Attribute value

GM_Projection_t

class globalmapper.GM_Projection_t

This type is used to fully describe a projection.

Attributes

• mProjSys : PROJSYS

  Projection system

• mDatum : DATUM

  Horizontal datum

• mUnit : UNIT

  Ground units

• mNumAttrs : unsigned long

  Number of attributes in attribute list

• GM_ProjAttrValue_t : mAttrList[GM_ProjAttrValue_t]

  Attribute list

GM_ProjDef_t

class globalmapper.GM_ProjDef_t

This type is used to fully describe a projection.

Attributes

• mDefinition : GM_Projection_t

  ?

• mWKT : const char*

  ?

GM_ValName_t

class globalmapper.GM_ValName_t

This type is used to describe a value and its associated name

Attributes

• mVal : int

  Value

• mName : const char*

  Value name

GM_ProjectionInfo_t

class globalmapper.GM_ProjectionInfo_t

This type is used to describe all of the available units, datums, zones, and attributes available for a projection

Attributes

• mProjSys : PROJSYS

  Projection system

• char* : const

  Projection system name

• mDatumList : GM_ValName_t*

  List of DATUM values available for this projection

• mDatumListSize : int

  Number of datums in the datum list

• mUnitList : GM_ValName_t*

  List of UNIT values available for this projection

• mUnitListSize : int

  Number of values in the unit list

• mZoneList : GM_ValName_t*

  List of zone numbers available for this projection

• mZoneListSize : int

  Number of values in the zone list

• mAttrList : GM_ValName_t*

  List of PROJATTR values available for this projection

• mAttrListSize : int

  Number of values in the datum list

GM_LidarClassFilter_t

class globalmapper.GM_LidarClassFilter_t

Define a filter for Lidar classes with 1 bit for each Lidar class (from 0-255).

Attributes

• mBitMask0 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask1 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask2 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask3 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask4 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask5 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask6 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

• mBitMask7 : UInt32

  Bit mask for which classes are DISabled. If the bit is 0 the class is enabled. If 1 it is disabled.

GM_LidarClassInfo_t

class globalmapper.GM_LidarClassInfo_t

This type is used to get/set information about Lidar classes

Attributes

• mClass : GM_LidarClass_t8

  Classification

• mClassGroup : GM_LidarClassGroup_t16

  Mask of group(s) the class is in

• mName : String

  Classification name (set to NULL to reset to default name in GM_SetLidarClassInfo)

• mColor : Color

  Color to use for rendering class points

GM_LidarPoint_t

class globalmapper.GM_LidarPoint_t

This type is used to return information out Lidar point cloud features

Attributes

• mLayerHandle : IntPtr

  Layer the point is from

• mPointIdx : ulong

  Point index in cloud

• mFlags : GM_LidarFlags_t32

  Flags about the point

• mPos : GM_Point_t

  Location of the point (global coordinates when getting, native when adding feature)

• mElevMeters : float

  Elevation of point in meters

• mIntensity : UInt16

  Intensity

• mClass : GM_LidarClass_t8

  Classification

• mRetNum : byte

  Return number

• mRetCount : byte

  Number of returns

• mUserData : byte

  User data

• mScannerChannel : byte

  Scanner channel

• mScanAngle : float

  Scan Angle

• mGpsTime : double

  GPS time

• mSourceId : UInt16

  Point Source ID

• mRed : UInt16

  Red color value

• mGreen : UInt16

  Green color value

• mBlue : UInt16

  Blue color value

• mNIR : UInt16

  NIR (near infrared) value

GM_LidarReturnInfo_t

class globalmapper.GM_LidarReturnInfo_t

Statistics about different Lidar point This can be used for statistics for a single class or return type

Attributes

• mCount : UInt64

  Number of points encountered of this type

• mMinZ : double

  Minimum Z value

• mMaxZ : double

  Maximum Z value

• mMinI : UInt16

  Minimum Intensity value

• mMaxI : UInt16

  Maximum Intensity value

• mSyntheticCount : UInt64

  Synthetic count

• mWithheldCount : UInt64

  Withheld count

• mKeyPointCount : UInt64

  Model key count

• mOverlapCount : UInt64

  Overlap point count

GM_LidarAttrInfo_t

class globalmapper.GM_LidarAttrInfo_t

Definition of statistics for a Lidar point cloud

Attributes

• mAllPointsStats : GM_LidarReturnInfo_t

  statistics for everything together

• mAttrStats : GM_LidarAttrInfo_t

  statistics by attribute

• mClassStats[256] : GM_LidarReturnInfo_t

  statistics by class

• mReturnStats : GM_LidarReturnInfo_t

  statistics by return type

• mAvgElev : double

  average of elevation values

• mStdDevElev : double

  standard deviation of elevation values

• mAvgIntensity : uint16

  average of intensity values

• mStdDevIntensity : uint16

  standard deviation of intensity values

GM_LidarQueryFilter_t

class globalmapper.GM_LidarQueryFilter_t

Definition of Lidar query filter. Use GM_InitLidarQueryFilter to initialize. IMPORTANT NOTE: Always add new items to end for backwards compatibility

Attributes

• mSize : uint32

  size of structure (for backwards compatibility)

• mClassFilter : GM_LidarClassFilter_t

  classification filter (zero’d out means all enabled)

• mColorDist : uint32

  maximum color “distance” to search when using mColorsToKeep

• mColorsToKeep : const COLORREF*

  optional list of colors to keep (NULL to not filter by color)

• mColorsToKeepCount : uint32

  count of colors in mColorsToKeepList

• mFilterFlags : GM_LidarFilterFlags_t32

  mask of filter flags to check. Default of 0 doesn’t check any flags.

• mElevMaxValidM : float

  maximum elevation to keep (meters). Use GM_INVALID_ELEV_VALUE for none.

• mElevMinValidM : float

  minimum elevation to keep (meters). Use GM_INVALID_ELEV_VALUE for none.

• mHeightMaxValidM : float

  maximum height above ground to keep (meters). Use GM_INVALID_ELEV_VALUE for none.

• mHeightMinValidM : float

  minimum height above ground to keep (meters). Use GM_INVALID_ELEV_VALUE for none.

• mIntensityMin : uint16

  minimum intensity to keep

• mIntensityMax : uint16

  maximum intensity to keep

• mKeepFirstRetIfNoDelta : boolean

  keep first returns if the return height delta is 0 (use for files with missing last returns - Bug 15754)

• mNdviMaxValid : float

  minimum valid NDVI value (Range: [-1,+1])

• mNdviMinValid : float

  maximum valid NDVI value (Range: [-1,+1])

• mNdviRangeValid : boolean

  should we check the NDVI (requires NIR channel)?

• mNdwiMaxValid : float

  minimum valid NDWI value (Range: [-1,+1])

• mNdwiMinValid : float

  maximum valid NDWI value (Range: [-1,+1])

• mNdwiRangeValid : boolean

  should we check the NDWI (requires NIR channel)?

• mPointSourceIdList : const uint32*

  list of point source IDs to keep (NULL to not filter by point source ID)

• mPointSourceIdListCount : uint32

  count of point source IDs in list

• mReturnHeightMaxAngle : uint8

  maximum gradient angle in degrees between first and last point to filter out if return height outside of allowed range.

• mReturnHeightMaxValidM : float

  maximum return height delta to keep (meters)

• mReturnHeightMinValidM : float

  minimum return height delta to keep (meters)

• mReturnHeightMinKeepAllReturnCount : uint32

  if filtering to a return height range, minimum number of returns to have to keep and ignore the max angle

• mReturnMask : GM_LidarReturnMask_t32

  list of return masks to keep

• mScanAngleMax : double

  maximum scan angle (degrees) to keep

• mScanAngleMin : double

  minimum scan angle (degrees) to keep

• mScanAngleValid : boolean

  is the scan angle range filter valid?

• mDensityMax : float

  max density to keep in points / m^2

• mDensityMin : float

  min density to keep in points / m^2

• mDensityRangeValid : boolean

  should we filter by density range?

• mInvert : boolean

  invert the results (return things that are NOT in the filter)

• mSegmentIdList : const GM_LidarSegmentId_t*

  list of segment IDs to keep

• mSegmentIdCount : uint32

  how many segment IDs are in the list

GM_LidarQueryInfo_t

class globalmapper.GM_LidarQueryInfo_t

Define structure to hold information about a Lidar query

Attributes

• mNumPoints : uint64

  total number of points in query

• mLayerList : GM_LayerHandle_t32*

  list of layers that have points in query

• mLayerCount : uint32

  number of layers in mLayerList

GM_ClassifyGroundSetup_t

class globalmapper.GM_ClassifyGroundSetup_t

Define setup for classifying ground points

Attributes

• mFlags : GM_ClassifyGroundFlags_t32

  flags for operation

• mResMult : double

  resolution multiplier (1.0 for native resolution, negative for resolution in meters)

• mConvergencePercent : double

  minimum percent of non-ground returns that must be classified to not go to next scale

• mCurvature : double

  initial curvature value (t) in meters for MCC algorithm

• mBaseWindowSizePix : sint32

  base window size in pixels (used in equation w = 2 * k * b + 1, where b is this base window size and k is index)

• mDeltaHeightMaxM : double

  maximum height delta to allow when looking for non-ground (meters)

• mDeltaHeightMinM : double

  minimum height delta to allow when looking for non-ground (meters)

• mMaxWindowSizeM : double

  maximum window size in meters. This controls how large we will go in looking for non-ground things. Should be size of largest building or so.

• mSlopeDeg : double

  slope degrees used to calculate maximum Z delta. Higher in areas of steep terrain

GM_ClassifyNoiseSetup_t

class globalmapper.GM_ClassifyNoiseSetup_t

Define setup for classifying noise points

Attributes

• mMeanGridBinMult : double

  grid size for finding noise

• mMovingWindowSize : sint32

  number of pixels on each side of moving window for checking noise (i.e. 5 is a 5x5 set of cells around cell sample is in)

• mMinNoiseStdDev : double

  minimum number of std dev from mean point needs to be for noise.

• mMinHighNoiseOffsetM : float

  minimum offset in meters above from local max average to possibly be high noise. Prevents small offsets in mostly flat areas, like individual power line points.

• mMinLowNoiseOffsetM : float

  minimum offset in meters below from local min average to possibly be high noise. Prevents small offsets in mostly flat areas, like individual power line points.

• mMinValidElevM : float

  minimum valid elevation in meters. Anything lower is marked as low noise. Use INVALID_ELEV_VALUE to not add this check

• mMaxValidElevM : float

  maximum valid elevation in meters. Anything higher is marked as high noise. Use INVALID_ELEV_VALUE to not add this check

• mMinValidHeightM : float

  minimum valid height above ground in meters. Anything lower is marked as low noise. Use INVALID_ELEV_VALUE to not add this check

• mMaxValidHeightM : float

  maximum valid height above ground in meters. Anything higher is marked as high noise. Use INVALID_ELEV_VALUE to not add this check

GM_ClassifyBuildingVegSetup_t

class globalmapper.GM_ClassifyBuildingVegSetup_t

Define setup for classifying vegetation and building points

Attributes

• mMeanGridBinMult : float

  mean grid multiplier of resolution. Usually keep at default

• mGridBinSizeUnits : GM_LidarResMult_t

  units for resolution

• mMinHeightAboveGround : float

  minimum height above ground in meters to consider

• mPlanarThresholdM : float

  treshold in meters to consider all points planar enough to be building

• mTreeThresholdM : float

  threshold in meters above which the points are non-planar enough to be trees

• mRoofInvalidMinAngle : float

  minimum angle (degrees) at which we don’t consider a plane a roof

• mRoofInvalidMaxAngle : float

  maximum angle (degrees) for the invalid roof range.

• mPlanarAngleMaxDiff : float

  maximum difference in angle between planes to be consider close enough to be same plane

GM_ClassifyNonGroundSetup_t

class globalmapper.GM_ClassifyNonGroundSetup_t

Define setup for classifying non-ground points

Attributes

• mTypes : GM_LidarClassifyTypes_t32

  types to classify

• mFlags : GM_ClassifyNonGroundFlags_t32

  flags

• mBuildingVegOpts : GM_ClassifyBuildingVegSetup_t

  options to building/high vegetation auto-classify

GM_ClassifyPowerlineSetup_t

class globalmapper.GM_ClassifyPowerlineSetup_t

Define setup for classifying powerline points

Attributes

• mPowerlineClass : GM_LidarClass_t8

  classification to assing to powerline points

• mBinSizeM : double

  bin size in meters per side (usually keep defaults)

• mMinHeightAboveGround : float

  minimum height above ground in meters to consider as possible powerline

• mMaxHeightAboveGround : float

  maximum height above ground in meters to consider as possible powerline

• mMaxGroundPtHeight : float

  maximum height above ground in meters to consider a ground point to ignore for histogram in cell

• mMaxVertDiffPerM : float

  maximum difference in height in meters over a meter of distance between points

• mMinLineVertDiff : float

  minimum vertical spacing of powerlines

• mMaxDistFromLine : float

  maximum distance in meters from best-fit straight lines that multiple candidates in a single cell can be

• mMinAreaSqM : double

  minimum area of powerline region

GM_ClassifyPoleLikeObjectSetup_t

class globalmapper.GM_ClassifyPoleLikeObjectSetup_t

Define setup for classifying pole/powerline points

Attributes

• mPoleLikeObjectClass : GM_LidarClass_t8

  classification to assing to pole like object points

• mBinSizeM : double

  bin size in meters per side (usually keep defaults)

• mSmoothingDistance : float

  maximum distance of neighbor points used for smoothing and classification algorithms

• mSmoothingVal : int

  Number of times to smooth point cloud before running classification

• mMinSegmentCount : int

  minimum number of points for a segment to be considered for final classification

• mMinHeightAboveGround : float

  minimum height above ground in meters to consider as possible pole

• mMaxHeightAboveGround : float

  maximum height above ground in meters to consider as possible pole

• mMinHeightOfPole : float

  how small of a vertical segment can we accept as a pole

• mMinDegreeOfPole : float

  minimum degree of candidate points for a segment to be classified

• mMaxXDisOfGroup : float

  maximin X distance that a segments can span in meters

• mTruePointSpacing : double

  get the point spacing during dialog

• mGroundBase : bool

  only search for poles that start at or near ground level

GM_ClassifyPolePowerSetup_t

class globalmapper.GM_ClassifyPolePowerSetup_t

Define setup for classifying pole/powerline points

Attributes

• mTypes : GM_LidarClassifyTypes_t32

  types to classify

• mFlags : GM_ClassifyNonGroundFlags_t32

  flags

• mPowerlineOpts : GM_ClassifyPowerlineSetup_t

  options for powerline auto-classify

• mPoleLikeObjectsOpts : GM_ClassifyPoleLikeObjectSetup_t

  options for pole like object auto-classify

GM_SegmentationSetup_t

class globalmapper.GM_SegmentationSetup_t

Define setup for segmentation related parameters used in graph-based classification and extraction

Attributes

• mMaxMahalanobisDistance : float

  ?

• mMinClusterSize : int

  ?

• mMaxCurvature : float

  ?

GM_ClassifyGraphSetup_t

class globalmapper.GM_ClassifyGraphSetup_t

Define setup for classifying non-ground points using graph-based methods

Attributes

• mTypes : GM_LidarClassifyTypes_t32

  types to classify

• mFlags : GM_ClassifyNonGroundFlags_t32

  flags

• mSegmentationOpts : GM_SegmentationSetup_t

  options for segmentation

• mBuildingVegOpts : GM_ClassifyBuildingVegSetup_t

  options to building/high vegetation auto-classify

• mMinHeightAboveGroundUnits : GM_LidarResMult_t

  Veg options

• mVegLow : float

  Veg height ranges

• mVegMed : float

  Veg height ranges

• mVegHigh : float

  Veg height ranges

• mVegWidthUnits : GM_LidarResMult_t

  Veg height ranges

• mVegMaxWidth : float

  Veg max width

• mVegHeightUnits : GM_LidarResMult_t

  Veg max width

• mPoleMinDiameter : float

  Pole diameter range

• mPoleMaxDiameter : float

  Pole diameter range

• mPoleDiameterUnits : GM_LidarResMult_t

  Pole diameter range

• mpPCAFingerprints : void*

  Pointer to PCA feature odel fingerprints

• mpIsClassProcessed : void*

  Pointer to generalized class processing mask which incudes custom classes

• mpSegmentationParameters : void*

  Pointer to segmentation parameters

• mbUnclassifiedOnly : bool

  ?

GM_LidarExtractSetup_t

class globalmapper.GM_LidarExtractSetup_t

Define setup for extraction feature outlines

Attributes

• mTypes : GM_LidarExtractType_t32

  types to extract

• mFlags : GM_LidarExtractFlags_t32

  flags

• mGridBinMultBuildings : float

  resolution to extract buildings

• mGridBinMultBuildingsUnits : GM_LidarResMult_t

  units for resolution

• mGridBinMultTrees : float

  resolution to extract trees

• mGridBinMultTreesUnits : GM_LidarResMult_t

  units for resolution

• mBuildingFloorType : AreaFeatureClass_t16

  area type for floor (AFC_INVALID to not create floor when creating walls)

• mBuildingRoofType : AreaFeatureClass_t16

  area type for roof

• mBuildingWallType : AreaFeatureClass_t16

  area type for building wall

• mBuildingMinAreaSqM : float

  minimum area of a building to keep in square meters

• mSimplifyFootprints : bool

  simplification options

• mBuildingSimpEps : float

  simplification options

• mBuildingSimpEpsUnits : GM_LidarResMult_t

  simplification options

• mRegularizeFootprints : bool

  regularization options

• mMinPointsInPlane : int

  regularization options

• mMinPointsInTree : int

  regularization options

• mMaxDistanceToPlane : float

  regularization options

• mCreateGroundFootprints : bool

  regularization options

• mPinFootprintsToHeight : bool

  regularization options

• mFootprintHeight : float

  regularization options

• mMinFootprintAreaSqM : float

  regularization options

• mPseudoMeasurementsAtPlanarIntersections : bool

  regularization options

• mCreateSideWalls : bool

  regularization options

• mColorVertices : bool

  regularization options

• mIsMeshReconstructed : bool

  regularization options

• mReconstructionRate : float

  regularization options

• mNormalWeight : float

  regularization options

• mMaxIterations : int

  regularization options

• mTreeMinWidthM : float

  minimum width of tree defining area in which it is the dominant high vegetation

• mTreeMaxWidthM : float

  maximum width of tree defining area when using spoke/wheel algorithm to get coverage

• mTreeMinHeightM : float

  minimum height above ground of a tree point

• char* : const

  name of model to use for tree

• mTreeType : PointFeatureClass_t16

  point type for tree

• mbReclassifyByHeight : bool

  Veg height reclassification thresholds

• mVegLow : float

  Veg height reclassification thresholds

• mVegMed : float

  Veg height reclassification thresholds

• mVegHigh : float

  Veg height reclassification thresholds

• mVegHeightUnits : GM_LidarResMult_t

  Veg height reclassification thresholds

• mbVegCreateMesh : bool

  Veg 3d model

• mbVegSimplifyFootprints : bool

  Footprints

• mVegSimpEps : float

  Footprints

• mVegSimpEpsUnits : GM_LidarResMult_t

  Footprints

• mPowerlineBinSizeM : double

  bin size in meters per side (usually keep defaults)

• mPowerlineBinMult : double

  multiplier to apply to bin size to get actual sample size. This allows bin size to be shared with automatic classification.

• mPowerlineClassGroupMask : GM_LidarClassGroup_t16

  Lidar class group(s) to treat as powerline types

• mPowerlineMaxDistFromLineM : float

  maximum distance from point in bin to best-fit line to keep

• mPowerlineMaxVertDiffPerM : float

  maximum difference in height in meters over a meter of distance between points

• mPowerlineMaxAngleDeltaDeg : float

  maximum departure from the same bearing in degrees that a new segment can be when added

• mPowerLineMaxGapLenM : float

  maximum gap length to cross in meters

• mPowerlineMinLineLenM : float

  minimum length of connected line to keep as a powerline segment

• mPowerlineMinLineSegLenM : float

  minimum length of in-cell line segment to start with for building powerlines

• mPoleBinSizeM : double

  bin size in meters per side (usually keep defaults)

• mPoleMinSegmentCount : int

  minimum number of points for a segment to be considered for final classification

• mPoleMinHeightOfPole : float

  how small of a vertical segment can we accept as a pole

• mPoleMaxXDisOfGroup : float

  maximin X distance that a segments can span in meters

• mPoleHighPoint : bool

  place marker on high point (false is low point)

• mPoleType : PointFeatureClass_t16

  point type for pole

• mbPoleCreateMesh : bool

  Pole 3d model

GM_LidarExtractOutput_t

class globalmapper.GM_LidarExtractOutput_t

Structure with output of Lidar extraction

Attributes

• mExtractedLayers : GM_LayerHandle_t32

  Member data

GM_GpsFitError_t

class globalmapper.GM_GpsFitError_t

Define fit error in meters for GPS

Attributes

• mValid : boolean

  Member data

• mMin : double

  Member data

• mMean : double

  Member data

• mMedian : double

  Member data

• mMax : double

  Member data

GM_P2PImagePixel_t

class globalmapper.GM_P2PImagePixel_t

Defines apixel location in an input image for a Pixels-to-Points process

Attributes

• mPixelPos : GM_Point_t

  pixel coordinates on image associated with control point

• mImageFilename : const char*

  filename (path not required) of image this pixel location is for

GM_P2PControlPoint_t

class globalmapper.GM_P2PControlPoint_t

Defines a P2P control point. This will be a lat/lon/Z location associated with a pixel location in multiple images.

Attributes

• mName : const char*

  optional name of control point

• mLatLonPos : GM_Point3D_t

  position in lat/lon WGS84 with an elevation in meters above the WGS84 ellipsoid

• mImagePixelList : GM_P2PImagePixel_t*

  list of associated image pixels for this control point

• mImagePixelCount : uint32

  how many entries are in the mImagePixelList

GM_P2PSetup_t

class globalmapper.GM_P2PSetup_t

Structure providing P2P setup options

Attributes

• mWorkspaceFilename : const char*

  filename of .gmp2p workspace file defining project to build. If not-NULL, most of these settings

• mImageListFilename : const char*

  filename of text file containing list of image filenames to use as input. If NULL, mImageFolder or mWorkspaceFilename must be provided.

• mImageFolder : const char*

  name of folder containing images to use. If NULL, mImageListFilename or mWorkspaceFilename must be provided

• mImageFilenameMask : const char*

  filename mask for images in mImageFolder

• mFlags : GM_P2PFlags_t32

  option flags

• mGeoRegOrderFlags : GM_GeoRegistrationOrderFlags_t8

  flags defining order we should apply landmarks (GCPs) and EXIF information

• mImageReduceFactor : double

  factor to reduce image size by (i.e. 2 means use half the size, etc.). Should be >= 1.

• mLogFileFolder : const char*

  folder to save log file in. If NULL or empty, the default folder will be used

• mProjectName : const char*

  project name (if blank use default)

• mRelativeAltBaseM : float

  base altitude (meters) for relative heights if we want to use those for elevation rather than EXIF values.

• mWorkingFolder : const char*

  folder to store temporary work files in. If NULL or empty, a default folder under the temp folder will be used.

• GM_P2PControlPoint_t* : const

  optional list of known control points to fit the result to

• mControlPointCount : uint32

  how many control points are in mControlPointList

• mCloudLayerDesc : const char*

  point cloud layer description (NULL for default)

• mCloudLayerFilename : const char*

  point cloud layer filename (must be .gmp file). If NULL and GM_P2P_AddCloudLayer is provided, the cloud layer will just be loaded.

• mImageLayerDesc : const char*

  orthoimage layer description

• mImageLayerFilename : const char*

  orthoimage layer filename (must be .gmp file). If NULL, no ortho-image will be generated.

• mMeshLayerDesc : const char*

  mesh layer description (NULL for default)

• mMeshLayerFilename : const char*

  mesh layer filename (must be .gmp or supported 3D model format). If NULL, no mesh (3D model) layer will be generated.

• mCloudLayerHandle : GM_LayerHandle_t32

  handle to loaded output point cloud layer

• mImageLayerHandle : GM_LayerHandle_t32

  handle to loaded output orthoimage layer

• mMeshLayerHandle : GM_LayerHandle_t32

  handle to loaded output mesh layer

• mErrorStr : const char*

  string holding detailed error if it fails (pass in NULL, will become non-NULL on output if needed)

• mGpsFitError : GM_GpsFitError_t

  GPS fit error for all used images

• mReportFilename : const char*

  filename of generated report (if any)

• mResultsStr : const char*

  string holding results information (pass in NULL, will become non-NULL on output)

• mColorHarmonizationRefFilename : const char*

  filename of reference image for color harmonization (if GM_P2P_UseColorHarmonization is set)

• mSceneClusterUpperBound : int

  upper bound to cluster size (in number of input images). Applicable if GM_P2P_UseSceneClustering in mFlags.

• mSceneClusterLowerBound : int

  lower bound to cluster size (in number of input images)

• mImageLayerResMult : double

  resolution multiplier for created image layer (negative is fixed in meters, positive is cloud spacing multiple)

• mImageLayerGapSize : double

  how large of gap to fill for image (in pixels)

• mImageSamplingMethod : GM_SamplingMethod_t8

  what sampling method should we use for the image layer by default

• mMeshDecimateFactor : float

  decimation factor for ReconstructMesh (0.0 to use default)

• mSfmMethod : GM_SfmMethod_t8

  SfM method to use (global vs. incremental)

• mSfmQuality : GM_SfmQuality_t8

  quality setting when looking for feature matches

• mSfmInitializer : GM_SfmInitializer_t8

  Incremental SfM(2) initializer method

• mSfmTriMethod : GM_SfmTriMethod_t8

  Incremental SfM(2) triangulation method

• mSfmResection : GM_SfmResection_t8

  Incremental SfM(2) resection method

• mCameraModel : GM_CameraModel_t8

  camera model to use

• mDescriberMethod : GM_SfmImageDescriberMethod_t8

  method for ComputeFeatures image describer (i.e. SIFT, AKAZE)

• mDensifyReducePower : sint32

  power to reduce large image sizes by for DensifyPointCloud (use -1 for default)

• mDensifyNumViews : sint32

  number of adjacent views to use (-1 for default of 0 [all images], 4 is default from MVS)

• mDensifyNumViewsFuse : uint32

  minimum number of images that agrees with an estimate during fusion in order to consider it inlier (0 for default of 3, 2 fills gaps but is noisier)

GM_LidarSpatialThinSetup_t

class globalmapper.GM_LidarSpatialThinSetup_t

Settings for spatial thinning of Lidar data

Attributes

• mLayerDesc : const char*

  description to use for thinned layer (NULL or empty for default)

• mMedianPercentile : uint32

  median percentile to use

• mNthCount : uint32

  how many to skip or keep if using GM_ThinAlg_KeepNth or GM_ThinAlg_SkipNth thinning

• mResMult : double

  resolution multiplier (1.0 for native resolution, negative for resolution in meters)

• mElevResMult : float

  elevation resolution multiplier to keep for GM_ThinAlg_3D (1.0 for native resolution, negative for resolution in meters, 0.0 for elev equivalent of mResMult)

• mKeepAllReturns : bool

  should we just thin the first return, then add all remaining returns for the single pulse to the thinned cloud?

• mCreateNewCloud : bool

  should we create a new cloud or just mark thinned points as deleted?

• mThinAlg : GM_SpatialThinAlg_t8

  thinning algorithm

• mHideProgress : bool

  don’t show progress for this operation

• mThinnedLayer : GM_LayerHandle_t32

  new layer with thinned point cloud. Caller must close with GM_CloseLayer if non-NULL. If NULL and thin succeeded, thinning was done in-place in provided layer handle (mCreateNewCloud was false)

• mDeletedCount : uint64

  number of points that were deleted

GM_LidarCompareSetup_t

class globalmapper.GM_LidarCompareSetup_t

Structure for performing a Lidar cloud comparison

Attributes

• mFlags : GM_LidarCompareFlags_t32

  flags for operation

• mBoundsGlobal : GM_Rectangle_t

  bounding box to limit search to. If the bounds are all 0, the intersection of the 2 layer sets will be used.

• mMaxDistResMult : float

  maximum compare distance / resolution multiplier specifying the min required distance when looking for changes. (1.0 for native resolution, negative for resolution in meters, 0.0 to require exact match for no change)

• mMinNearbyNewCount : uint32

  minimum number of nearby ‘new points’ to require before treating point as new. This allows discarding of isolated new points. (0 to keep all)

• mNewLayerDesc : const char*

  base description to use for new point cloud layers created from the differences . Use NULL for default.

• mQueryNewComparePoints : GM_LidarQueryHandle_t

  Lidar query that will hold all points in ‘compare to’ set that aren’t in the ‘compare’ set (if GM_LidarCompare_CreateNewQueries is set) Call GM_FreeLidarQuery to free when you are done with this

• mQueryNewCompareToPoints : GM_LidarQueryHandle_t

  Lidar query that will hold all points in ‘compare to’ set that aren’t in the ‘compare’ set (if GM_LidarCompare_CreateNewQueries and GM_LidarCompare_CompareBothDirs are set) Call GM_FreeLidarQuery to free when you are done with this

• mNewComparePointsLayer : GM_LayerHandle_t32

  handle to new layer holding all points from mQueryNewComparePoints (created if GM_LidarCompare_CreateNewLayers is set)

• mNewCompareToPointsLayer : GM_LayerHandle_t32

  handle to new layer holding all points from mQueryNewCompareToPoints (created if GM_LidarCompare_CreateNewLayers and GM_LidarCompare_CompareBothDirs are set)

GM_LidarColorizeSetup_t

class globalmapper.GM_LidarColorizeSetup_t

Define options for colorizing Lidar data from imagery sources

Attributes

• mFields : GM_LidarColorizeFields_t8

  Member data: Input?

• mFlags : GM_LidarColorizeFlags_t8

  Member data: Input?

• mIntensityMethod : GM_LidarColorizeIntensity_t8

  method to use to fill intensity if mFields = GM_LidarColorize_Inten

• mNumModifiedPoints : uint64

  how many Lidar returns were modified by the operation

GM_SwathSeparationImageSetup_t

class globalmapper.GM_SwathSeparationImageSetup_t

Structure with options for creating Swath Separation Images (SSI)

Attributes

• mPointCloudLayerList : GM_LayerHandle_t32*

  list of point clouds to consider (NULL for all loaded layers)

• mPointCloudLayerListCount : uint32

  number of layers in mPointCloudLayerList

• GM_Rectangle_t* : const

  current projection bounds to limit operation to. If not provided, use full bounds.

• mClassFilter : GM_LidarClassFilter_t

  Lidar class filter with point types to consider

• mReturnMask : GM_LidarReturnMask_t32

  Lidar return mask for point types to consider

• mGridAlg : GM_GridAlg_t8

  grid algorithm to use

• mGridBinMult : double

  grid size to use for each flight line grid (negative for meters, positive for multiple of cloud spacing)

• mShaderName : const char*

  name of shader to use for final result. If none is provided, a default will be used

• mOverlapDiffGridDesc : const char*

  layer description to use for overlap difference grid (NULL for default). If GM_SSI_SaveOverlapDiffGridLayer specified.

GM_LidarSmoothSetup_t

class globalmapper.GM_LidarSmoothSetup_t

Settings for smoothing of Lidar data

Attributes

• mShowErrors : bool

  show error messages?

• mHideProgress : bool

  hide any progress display?

• mSearchDistM : double

  max distance to search from each point to smooth in meters

• mAdjustPercent : sint32

  percent to adjust (from 0-100)

• mAdjustXY : bool

  adjust XY in addition to Z

• mOnlyAdjustZLower : bool

  only adjust Z values if local mean is lower than initial Z

• mOnlySameClass : bool

  only consider points in same class when calculating local average

• mModCount : uint64

  how many points were modified by the smooth operation?

GM_Distance_t

class globalmapper.GM_Distance_t

Structure defining a combination of distance + units. Note: for C language users, initializing this struct to all 0’s, as with memset(), may yield different behavior than that of the C++ constructor. It is recommended to use the function GM_DistanceInit() for this, which uses the C++ constructor.

Attributes

• mDistance : double

  ?

• mUnits : UNIT

  ?

GM_SpatialOps_Params_t

class globalmapper.GM_SpatialOps_Params_t

Structure defining parameters for spatial operations and spatial predicates Note: for C language users, initializing this struct to all 0’s, as with memset(), will yield different behavior than that of the C++ constructor, since defaults for some of the members (e.g. the GM_FeatureFilters_t8 members) are are bit flags, and useless with a 0 value. It is recommended to use the function GM_SpatialOpsParameterInit() for this, which uses the C++ constructor.

Attributes

• mFeatureTypes1 : GM_FeatureFilters_t8

  IN: Feature class type(s) for layer 1

• mFeatureTypes2 : GM_FeatureFilters_t8

  IN: Feature class type(s) for layer 2

• mPredicateResultTarget : GM_PredicateResultTargets_t8

  IN: Where to store the results of a predicate

• mResultLayerName : const char*

  IN: Name of result layer

• mResultFeatures : GM_FoundFeatureResults_t

  OUT: Result features for predicates using a result target of GM_PredicateResult_ReturnFeatures

• mResultLayer : GM_LayerHandle_t32

  OUT: Layer created to hold results for spatial operations and predicates using SaveToLayer result target

• mResultFeatureTypes : GM_FeatureFilters_t8

  IN: Desired feature class type(s) for results

• mResultLayerIsTemp : bool

  IN: If true, result layer should not appear in the Control Panel

• mErrorHandling : GM_SpatialOps_Errorhandling_t8

  IN: Error handling behavior for inputs to the operation

• mAttemptRepair : bool

  IN: Attempt repair on invalid input geometries

• mLogCallback : GM_MessageCallbackFunc

  IN: Callback for displaying error and warning messages.