Data Structures
class	Rect2D
	Class representing rectangle with floating point values. More...
class	Rect2DPP
	Rectangle specified by 2 points (with floating point values). More...
class	Rect2DPS
	Rectangle specified by point and size (with floating point values). More...
class	UnitConversion
	Class for converting units. More...
Functions
def	normalize_whitespace
	Remove redundant whitespace from a string.
def	split
	Platform spefic shlex.split.
def	GetTempfile
	Creates GRASS temporary file using defined prefix.
def	GetLayerNameFromCmd
	Get map name from GRASS command.
def	GetValidLayerName
	Make layer name SQL compliant, based on G_str_to_sql()
def	ListOfCatsToRange
	Convert list of category number to range(s)
def	ListOfMapsets
	Get list of available/accessible mapsets.
def	ListSortLower
	Sort list items (not case-sensitive)
def	GetVectorNumberOfLayers
	Get list of vector layers.
def	Deg2DMS
	Convert deg value to dms string.
def	DMS2Deg
	Convert dms value to deg.
def	GetCmdString
def	CmdToTuple
	Convert command list to tuple for gcmd.RunCommand()
def	PathJoin
	Check path created by os.path.join.
def	ReadEpsgCodes
	Read EPSG code from the file.
def	ReprojectCoordinates
	Reproject coordinates.
def	GetListOfLocations
	Get list of GRASS locations in given dbase.
def	GetListOfMapsets
	Get list of mapsets in given GRASS location.
def	GetColorTables
	Get list of color tables.
def	DecodeString
	Decode string using system encoding.
def	EncodeString
	Return encoded string using system locales.
def	GetFormats
	Get GDAL/OGR formats.
def	GetSettingsPath
	Get full path to the settings directory.
def	convertRGB
	Converts wx.Colour(r,g,b,a) to string 'r:g:b' or named color, or named color/r:g:b string to wx.Colour, depending on input.
def	PaperMapCoordinates
	Converts paper (inch) coordinates <-> map coordinates.
def	AutoAdjust
	Computes map scale, center and map frame rectangle to fit region (scale is not fixed)
def	SetResolution
	If resolution is too high, lower it.
def	ComputeSetRegion
	Computes and sets region from current scale, map center coordinates and map rectangle.
def	projInfo
	Return region projection and map units information, taken from render.py.
def	GetMapBounds
	Run ps.map -b to get information about map bounding box.
def	getRasterType
	Returns type of raster map (CELL, FCELL, DCELL)
def	PilImageToWxImage
	Convert PIL image to wx.Image.
def	BBoxAfterRotation
	Compute bounding box or rotated rectangle.
Variables
	formats = None
	havePILImage = True
	unitConv

Function Documentation

def utils.AutoAdjust	(	self,
		scaleType,
		rect,
		map = `None`,
		mapType = `None`,
		region = `None`
	)

Computes map scale, center and map frame rectangle to fit region (scale is not fixed)

Definition at line 195 of file psmap/utils.py.

Referenced by frame.PsMapBufferedWindow.OnLeftUp().

def utils.BBoxAfterRotation	(	w,
		h,
		angle
	)

Compute bounding box or rotated rectangle.

Parameters:

w	rectangle width
h	rectangle height
angle	angle (0, 360) in degrees

Definition at line 382 of file psmap/utils.py.

Referenced by instructions.Image.Read(), and dialogs.ImageDialog.update().

def utils.CmdToTuple ( cmd )

Convert command list to tuple for gcmd.RunCommand()

Definition at line 481 of file core/utils.py.

Referenced by colorrules.VectorColorTable.CreateAttrTable(), colorrules.ColorTable.CreateColorTable(), colorrules.ColorTable.LoadTable(), model.Model.Run(), render.Layer.SetCmd(), and instructions.Instruction.SetRegion().

def utils.ComputeSetRegion	(	self,
		mapDict
	)

Computes and sets region from current scale, map center coordinates and map rectangle.

Definition at line 271 of file psmap/utils.py.

References projInfo(), and gcmd.RunCommand().

Referenced by frame.PsMapBufferedWindow.OnLeftUp().

def utils.convertRGB ( rgb )

Converts wx.Colour(r,g,b,a) to string 'r:g:b' or named color, or named color/r:g:b string to wx.Colour, depending on input.

Definition at line 135 of file psmap/utils.py.

References dialogs.type.

Referenced by frame.PsMapBufferedWindow.DrawGraphics(), frame.PsMapBufferedWindow.DrawRotText(), dialogs.update(), dialogs.MapinfoDialog.update(), dialogs.TextDialog.update(), dialogs.PointDialog.update(), and dialogs.updateRasterLegend().

def utils.DecodeString ( string )

Decode string using system encoding.

Parameters:

string string to be decoded

Returns:: decoded string

Definition at line 656 of file core/utils.py.

def utils.Deg2DMS	(	lon,
		lat,
		string = `True`,
		hemisphere = `True`,
		precision = `3`
	)

Convert deg value to dms string.

Parameters:

lon	longitude (x)
lat	latitude (y)
string	True to return string otherwise tuple
hemisphere	print hemisphere
precision	seconds precision

Returns:: DMS string or tuple of values; empty string on error

Definition at line 321 of file core/utils.py.

Referenced by statusbar.SbGoTo.GetCenterString(), statusbar.SbGoTo.OnGoTo(), statusbar.SbCoordinates.ReprojectENFromMap(), and statusbar.SbRegionExtent.ReprojectRegionFromMap().

def utils.DMS2Deg	(	lon,
		lat
	)

Convert dms value to deg.

Parameters:

lon	longitude (x)
lat	latitude (y)

Returns:: tuple of converted values; ValueError on error

Definition at line 375 of file core/utils.py.

Referenced by statusbar.SbGoTo.ReprojectENToMap().

def utils.EncodeString ( string )

Return encoded string using system locales.

Parameters:

string string to be encoded

Returns:: encoded string

Definition at line 673 of file core/utils.py.

Referenced by dialogs.ModelSearchDialog.GetCmd().

def utils.GetCmdString ( cmd )

Get GRASS command as string.

@param cmd GRASS command given as dictionary

@return command string

Definition at line 453 of file core/utils.py.

Referenced by render.Layer.GetCmd(), and instructions.Instruction.SetRegion().

def utils.GetColorTables ( )

Get list of color tables.

Definition at line 646 of file core/utils.py.

References gcmd.RunCommand().

Referenced by preferences.PreferencesDialog.__init__().

def utils.GetFormats ( )

Get GDAL/OGR formats.

Definition at line 739 of file core/utils.py.

Referenced by gselect.FormatSelect.__init__().

def utils.GetLayerNameFromCmd	(	dcmd,
		fullyQualified = `False`,
		param = `None`,
		layerType = `None`
	)

Get map name from GRASS command.

Parameter dcmd can be modified when first parameter is not defined.

Parameters:

dcmd	GRASS command (given as list)
fullyQualified	change map name to be fully qualified
param	params directory
layerType	check also layer type ('raster', 'vector', '3d-raster', ...)