QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
This class represents a coordinate reference system (CRS). More...
#include <qgscoordinatereferencesystem.h>
Public Types | |
enum | CrsType { InternalCrsId, PostgisCrsId, EpsgCrsId } |
Enumeration of types of IDs accepted in createFromId() method. More... | |
Public Member Functions | |
QgsCoordinateReferenceSystem () | |
Constructs an invalid CRS object. More... | |
QgsCoordinateReferenceSystem (const QString &definition) | |
Constructs a CRS object from a string definition using createFromString() More... | |
QgsCoordinateReferenceSystem (long id, CrsType type=PostgisCrsId) | |
Constructor a CRS object using a PostGIS SRID, an EPSG code or an internal QGIS CRS ID. More... | |
QgsCoordinateReferenceSystem (const QgsCoordinateReferenceSystem &srs) | |
Copy constructor. More... | |
~QgsCoordinateReferenceSystem () | |
QString | authid () const |
Returns the authority identifier for the CRS. More... | |
QgsRectangle | bounds () const |
Returns the approximate bounds for the region the CRS is usable within. More... | |
bool | createFromId (long id, CrsType type=PostgisCrsId) |
Sets this CRS by lookup of the given ID in the CRS database. More... | |
bool | createFromOgcWmsCrs (const QString &crs) |
Sets this CRS to the given OGC WMS-format Coordinate Reference Systems. More... | |
bool | createFromProj4 (const QString &projString) |
Sets this CRS by passing it a PROJ style formatted string. More... | |
bool | createFromSrid (long srid) |
Sets this CRS by lookup of the given PostGIS SRID in the CRS database. More... | |
bool | createFromSrsId (long srsId) |
Sets this CRS by lookup of internal QGIS CRS ID in the CRS database. More... | |
bool | createFromString (const QString &definition) |
Set up this CRS from a string definition. More... | |
bool | createFromUserInput (const QString &definition) |
Set up this CRS from various text formats. More... | |
bool | createFromWkt (const QString &wkt) |
Sets this CRS using a WKT definition. More... | |
QString | description () const |
Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". More... | |
QString | ellipsoidAcronym () const |
Returns the ellipsoid acronym for the ellipsoid used by the CRS. More... | |
long | findMatchingProj () |
Walks the CRS databases (both system and user database) trying to match stored PROJ string to a database entry in order to fill in further pieces of information about CRS. More... | |
QString | geographicCrsAuthId () const |
Returns auth id of related geographic CRS. More... | |
bool | hasAxisInverted () const |
Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS. More... | |
bool | isGeographic () const |
Returns whether the CRS is a geographic CRS (using lat/lon coordinates) More... | |
bool | isValid () const |
Returns whether this CRS is correctly initialized and usable. More... | |
QgsUnitTypes::DistanceUnit | mapUnits () const |
Returns the units for the projection used by the CRS. More... | |
operator QVariant () const | |
Allows direct construction of QVariants from QgsCoordinateReferenceSystem. More... | |
bool | operator!= (const QgsCoordinateReferenceSystem &srs) const |
Overloaded != operator used to compare to CRS's. More... | |
QgsCoordinateReferenceSystem & | operator= (const QgsCoordinateReferenceSystem &srs) |
Assignment operator. More... | |
bool | operator== (const QgsCoordinateReferenceSystem &srs) const |
Overloaded == operator used to compare to CRS's. More... | |
long | postgisSrid () const |
Returns PostGIS SRID for the CRS. More... | |
QString | projectionAcronym () const |
Returns the projection acronym for the projection used by the CRS. More... | |
bool | readXml (const QDomNode &node) |
Restores state from the given DOM node. More... | |
long | saveAsUserCrs (const QString &name) |
Save the proj4-string as a custom CRS. More... | |
void | setValidationHint (const QString &html) |
Set user hint for validation. More... | |
long | srsid () const |
Returns the internal CRS ID, if available. More... | |
QString | toProj4 () const |
Returns a Proj4 string representation of this CRS. More... | |
QString | toWkt () const |
Returns a WKT representation of this CRS. More... | |
void | validate () |
Perform some validation on this CRS. More... | |
QString | validationHint () |
Gets user hint for validation. More... | |
bool | writeXml (QDomNode &node, QDomDocument &doc) const |
Stores state to the given Dom node in the given document. More... | |
Static Public Member Functions | |
static CUSTOM_CRS_VALIDATION | customCrsValidation () |
Gets custom function. More... | |
static Q_INVOKABLE QgsCoordinateReferenceSystem | fromEpsgId (long epsg) |
Creates a CRS from a given EPSG ID. More... | |
static QgsCoordinateReferenceSystem | fromOgcWmsCrs (const QString &ogcCrs) |
Creates a CRS from a given OGC WMS-format Coordinate Reference System string. More... | |
static QgsCoordinateReferenceSystem | fromProj4 (const QString &proj4) |
Creates a CRS from a proj4 style formatted string. More... | |
static QgsCoordinateReferenceSystem | fromSrsId (long srsId) |
Creates a CRS from a specified QGIS SRS ID. More... | |
static QgsCoordinateReferenceSystem | fromWkt (const QString &wkt) |
Creates a CRS from a WKT spatial ref sys definition string. More... | |
static void | invalidateCache (bool disableCache=false) |
Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects. More... | |
static QStringList | recentProjections () |
Returns a list of recently used projections. More... | |
static void | setCustomCrsValidation (CUSTOM_CRS_VALIDATION f) |
Sets custom function to force valid CRS. More... | |
static void | setupESRIWktFix () |
Make sure that ESRI WKT import is done properly. More... | |
static int | syncDatabase () |
Update proj.4 parameters in our database from proj.4. More... | |
static QList< long > | validSrsIds () |
Returns a list of all valid SRS IDs present in the CRS database. More... | |
Properties | |
QgsUnitTypes::DistanceUnit | mapUnits |
Friends | |
class | TestQgsCoordinateReferenceSystem |
This class represents a coordinate reference system (CRS).
Coordinate reference system object defines a specific map projection, as well as transformations between different coordinate reference systems. There are various ways how a CRS can be defined: using well-known text (WKT), PROJ string or combination of authority and code (e.g. EPSG:4326). QGIS comes with its internal database of coordinate reference systems (stored in SQLite) that allows lookups of CRS and seamless conversions between the various definitions.
Most commonly one comes across two types of coordinate systems:
Internally QGIS uses proj4 library for all the math behind coordinate transformations, so in case of any troubles with projections it is best to examine the PROJ representation within the object, as that is the representation that will be ultimately used.
Methods that allow inspection of CRS instances include isValid(), authid(), description(), toWkt(), toProj4(), mapUnits() and others. Creation of CRS instances is further described in Object Construction and Copying section below. Transformations between coordinate reference systems are done using QgsCoordinateTransform class.
For example, the following code will create and inspect "British national grid" CRS:
This will produce the following output:
This section gives an overview of various supported CRS definition formats:
Authority and Code. Also referred to as OGC WMS format within QGIS as they have been widely used in OGC standards. These are encoded as <auth>:<code>
, for example EPSG:4326
refers to WGS84 system. EPSG is the most commonly used authority that covers a wide range of coordinate systems around the world.
An extended variant of this format is OGC URN. Syntax of URN for CRS definition is urn:ogc:def:crs:<auth>:[<version>]:<code>
. This class can also parse URNs (versions are currently ignored). For example, WGS84 may be encoded as urn:ogc:def:crs:OGC:1.3:CRS84
.
QGIS adds support for "USER" authority that refers to IDs used internally in QGIS. This variant is best avoided or used with caution as the IDs are not permanent and they refer to different CRS on different machines or user profiles.
See authid() and createFromOgcWmsCrs() methods.
PROJ string. This is a string consisting of a series of key/value pairs in the following format: +param1=value1 +param2=value2 [...]
. This is the format natively used by the underlying proj4 library. For example, the definition of WGS84 looks like this:
+proj=longlat +datum=WGS84 +no_defs
See toProj4() and createFromProj4() methods.
Well-known text (WKT). Defined by Open Geospatial Consortium (OGC), this is another common format to define CRS. For WGS84 the OGC WKT definition is the following:
GEOGCS["WGS 84", DATUM["WGS_1984", SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]], AUTHORITY["EPSG","6326"]], PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]], UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]], AUTHORITY["EPSG","4326"]]
See toWkt() and createFromWkt() methods.
The database of CRS shipped with QGIS is stored in a SQLite database (see QgsApplication::srsDatabaseFilePath()) and it is based on the data files maintained by GDAL project (a variety of .csv and .wkt files).
Sometimes it happens that users need to use a CRS definition that is not well known or that has been only created with a specific purpose (and thus its definition is not available in our database of CRS). Whenever a new CRS definition is seen, it will be added to the local database (in user's home directory, see QgsApplication::qgisUserDatabaseFilePath()). QGIS also features a GUI for management of local custom CRS definitions.
There are therefore two databases: one for shipped CRS definitions and one for custom CRS definitions. Custom CRS have internal IDs (accessible with srsid()) greater or equal to USER_CRS_START_ID. The local CRS databases should never be accessed directly with SQLite functions, instead you should use QgsCoordinateReferenceSystem API for CRS lookups and for managements of custom CRS.
In some cases (most prominently when loading a map layer), QGIS will try to ensure that the given map layer CRS is valid using validate() call. If not, a custom validation function will be called - such function may for example show a GUI for manual CRS selection. The validation function is configured using setCustomCrsValidation(). If validation fails or no validation function is set, the default CRS is assigned (WGS84). QGIS application registers its validation function that will act according to user's settings (either show CRS selector dialog or use project/custom CRS).
The easiest way of creating CRS instances is to use QgsCoordinateReferenceSystem(const QString&) constructor that automatically recognizes definition format from the given string.
Creation of CRS object involves some queries in a local SQLite database, which may be potentially expensive. Consequently, CRS creation methods use an internal cache to avoid unnecessary database lookups. If the CRS database is modified, then it is necessary to call invalidateCache() to ensure that outdated records are not being returned from the cache.
Since QGIS 2.16 QgsCoordinateReferenceSystem objects are implicitly shared.
There are two different flavors of WKT: one is defined by OGC, the other is the standard used by ESRI. They look very similar, but they are not the same. QGIS is able to consume both flavors.
Definition at line 189 of file qgscoordinatereferencesystem.h.
Enumeration of types of IDs accepted in createFromId() method.
Enumerator | |
---|---|
InternalCrsId |
Internal ID used by QGIS in the local SQLite database. |
PostgisCrsId |
SRID used in PostGIS. |
EpsgCrsId |
EPSG code. |
Definition at line 198 of file qgscoordinatereferencesystem.h.
QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem | ( | ) |
Constructs an invalid CRS object.
Definition at line 84 of file qgscoordinatereferencesystem.cpp.
QgsCoordinateReferenceSystem::~QgsCoordinateReferenceSystem | ( | ) |
Definition at line 200 of file qgscoordinatereferencesystem.cpp.
|
explicit |
Constructs a CRS object from a string definition using createFromString()
It supports the following formats:
If no prefix is specified, WKT definition is assumed.
definition | A String containing a coordinate reference system definition. |
Definition at line 89 of file qgscoordinatereferencesystem.cpp.
|
explicit |
Constructor a CRS object using a PostGIS SRID, an EPSG code or an internal QGIS CRS ID.
id | The ID valid for the chosen CRS ID type |
type | One of the types described in CrsType |
Definition at line 95 of file qgscoordinatereferencesystem.cpp.
QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem | ( | const QgsCoordinateReferenceSystem & | srs | ) |
Copy constructor.
Definition at line 101 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::authid | ( | ) | const |
Returns the authority identifier for the CRS.
The identifier includes both the authority (e.g., EPSG) and the CRS number (e.g., 4326). This is the best method to use when showing a very short CRS identifier to a user, e.g., "EPSG:4326".
If CRS object is a custom CRS (not found in database), the method will return internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005"
Definition at line 1005 of file qgscoordinatereferencesystem.cpp.
QgsRectangle QgsCoordinateReferenceSystem::bounds | ( | ) | const |
Returns the approximate bounds for the region the CRS is usable within.
The returned bounds represent the latitude and longitude extent for the projection in the WGS 84 CRS.
Definition at line 1075 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromId | ( | long | id, |
CrsType | type = PostgisCrsId |
||
) |
Sets this CRS by lookup of the given ID in the CRS database.
Definition at line 204 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromOgcWmsCrs | ( | const QString & | crs | ) |
Sets this CRS to the given OGC WMS-format Coordinate Reference Systems.
Accepts both "<auth>:<code>" format and OGC URN "urn:ogc:def:crs:<auth>:[<version>]:<code>". It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning and refer to QGIS internal CRS IDs.
Definition at line 334 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromProj4 | ( | const QString & | projString | ) |
Sets this CRS by passing it a PROJ style formatted string.
The string will be parsed and the projection and ellipsoid members set and the remainder of the proj4 string will be stored in the parameters member. The reason for this is so that we can easily present the user with 'natural language' representation of the projection and ellipsoid by looking them up in the srs.db sqlite database.
We try to match the proj4 string to internal QGIS CRS ID using the following logic:
projString | A proj4 format string |
Definition at line 697 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromSrid | ( | long | srid | ) |
Sets this CRS by lookup of the given PostGIS SRID in the CRS database.
srid | The PostGIS SRID for the desired spatial reference system. |
Definition at line 435 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromSrsId | ( | long | srsId | ) |
Sets this CRS by lookup of internal QGIS CRS ID in the CRS database.
If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise user's local CRS database from home directory is used.
srsId | The internal QGIS CRS ID for the desired spatial reference system. |
Definition at line 459 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromString | ( | const QString & | definition | ) |
Set up this CRS from a string definition.
It supports the following formats:
If no prefix is specified, WKT definition is assumed.
definition | A String containing a coordinate reference system definition. |
Definition at line 225 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromUserInput | ( | const QString & | definition | ) |
Set up this CRS from various text formats.
Valid formats: WKT string, "EPSG:n", "EPSGA:n", "AUTO:proj_id,unit_id,lon0,lat0", "urn:ogc:def:crs:EPSG::n", PROJ string, filename (with WKT, XML or PROJ string), well known name (such as NAD27, NAD83, WGS84 or WGS72), ESRI::[WKT string] (directly or in a file), "IGNF:xxx"
For more details on supported formats see OGRSpatialReference::SetFromUserInput() ( http://www.gdal.org/ogr/classOGRSpatialReference.html#aec3c6a49533fe457ddc763d699ff8796 )
definition | A String containing a coordinate reference system definition. |
Definition at line 288 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::createFromWkt | ( | const QString & | wkt | ) |
Sets this CRS using a WKT definition.
If EPSG code of the WKT definition can be determined, it is extracted and createFromOgcWmsCrs() is used to initialize the object. Otherwise the WKT will be converted to a proj4 string and createFromProj4() set up the object.
wkt | The WKT for the desired spatial reference system. |
Definition at line 589 of file qgscoordinatereferencesystem.cpp.
|
static |
Gets custom function.
Definition at line 1588 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::description | ( | ) | const |
Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94".
In most cases this is the best method to use when showing a friendly identifier for the CRS to a user.
Definition at line 1010 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::ellipsoidAcronym | ( | ) | const |
Returns the ellipsoid acronym for the ellipsoid used by the CRS.
Definition at line 1034 of file qgscoordinatereferencesystem.cpp.
long QgsCoordinateReferenceSystem::findMatchingProj | ( | ) |
Walks the CRS databases (both system and user database) trying to match stored PROJ string to a database entry in order to fill in further pieces of information about CRS.
Definition at line 1248 of file qgscoordinatereferencesystem.cpp.
|
static |
Creates a CRS from a given EPSG ID.
epsg | epsg CRS ID |
Definition at line 174 of file qgscoordinatereferencesystem.cpp.
|
static |
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
ogcCrs | OGR compliant CRS definition, e.g., "EPSG:4326" |
Definition at line 167 of file qgscoordinatereferencesystem.cpp.
|
static |
Creates a CRS from a proj4 style formatted string.
proj4 | proj4 format string |
Definition at line 179 of file qgscoordinatereferencesystem.cpp.
|
static |
Creates a CRS from a specified QGIS SRS ID.
srsId | internal QGIS SRS ID |
Definition at line 193 of file qgscoordinatereferencesystem.cpp.
|
static |
Creates a CRS from a WKT spatial ref sys definition string.
wkt | WKT for the desired spatial reference system. |
Definition at line 186 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::geographicCrsAuthId | ( | ) | const |
Returns auth id of related geographic CRS.
Definition at line 2402 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::hasAxisInverted | ( | ) | const |
Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS.
Definition at line 562 of file qgscoordinatereferencesystem.cpp.
|
static |
Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects.
This should be called whenever the srs database has been modified in order to ensure that outdated CRS objects are not created.
If disableCache is TRUE then the inbuilt cache will be completely disabled. This argument is for internal use only.
Definition at line 2460 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::isGeographic | ( | ) | const |
Returns whether the CRS is a geographic CRS (using lat/lon coordinates)
Definition at line 1062 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::isValid | ( | ) | const |
Returns whether this CRS is correctly initialized and usable.
Definition at line 692 of file qgscoordinatereferencesystem.cpp.
QgsUnitTypes::DistanceUnit QgsCoordinateReferenceSystem::mapUnits | ( | ) | const |
Returns the units for the projection used by the CRS.
|
inline |
Allows direct construction of QVariants from QgsCoordinateReferenceSystem.
Definition at line 242 of file qgscoordinatereferencesystem.h.
bool QgsCoordinateReferenceSystem::operator!= | ( | const QgsCoordinateReferenceSystem & | srs | ) | const |
Overloaded != operator used to compare to CRS's.
Returns opposite bool value to operator ==
Definition at line 1330 of file qgscoordinatereferencesystem.cpp.
QgsCoordinateReferenceSystem & QgsCoordinateReferenceSystem::operator= | ( | const QgsCoordinateReferenceSystem & | srs | ) |
Assignment operator.
Definition at line 106 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::operator== | ( | const QgsCoordinateReferenceSystem & | srs | ) | const |
Overloaded == operator used to compare to CRS's.
Internally it will use authid() for comparison.
Definition at line 1324 of file qgscoordinatereferencesystem.cpp.
long QgsCoordinateReferenceSystem::postgisSrid | ( | ) | const |
Returns PostGIS SRID for the CRS.
Definition at line 1000 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::projectionAcronym | ( | ) | const |
Returns the projection acronym for the projection used by the CRS.
Definition at line 1022 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::readXml | ( | const QDomNode & | node | ) |
Restores state from the given DOM node.
If it fails or if the node is empty, a default empty CRS will be returned.
node | The node from which state will be restored |
Definition at line 1349 of file qgscoordinatereferencesystem.cpp.
|
static |
Returns a list of recently used projections.
Definition at line 2418 of file qgscoordinatereferencesystem.cpp.
long QgsCoordinateReferenceSystem::saveAsUserCrs | ( | const QString & | name | ) |
Save the proj4-string as a custom CRS.
Copied from QgsCustomProjectionDialog /// Please refactor into SQL handler !!! ///.
Returns the new CRS srsid(), or -1 if the CRS could not be saved.
Definition at line 1629 of file qgscoordinatereferencesystem.cpp.
|
static |
Sets custom function to force valid CRS.
Definition at line 1583 of file qgscoordinatereferencesystem.cpp.
|
static |
Make sure that ESRI WKT import is done properly.
This is required for proper shapefile CRS import when using gdal>= 1.9.
Definition at line 313 of file qgscoordinatereferencesystem.cpp.
void QgsCoordinateReferenceSystem::setValidationHint | ( | const QString & | html | ) |
Set user hint for validation.
Definition at line 1615 of file qgscoordinatereferencesystem.cpp.
long QgsCoordinateReferenceSystem::srsid | ( | ) | const |
Returns the internal CRS ID, if available.
Definition at line 995 of file qgscoordinatereferencesystem.cpp.
|
static |
Update proj.4 parameters in our database from proj.4.
Definition at line 1889 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::toProj4 | ( | ) | const |
Returns a Proj4 string representation of this CRS.
If proj and ellps keys are found in the parameters, they will be stripped out and the projection and ellipsoid acronyms will be overridden with these.
Definition at line 1046 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::toWkt | ( | ) | const |
Returns a WKT representation of this CRS.
Definition at line 1335 of file qgscoordinatereferencesystem.cpp.
void QgsCoordinateReferenceSystem::validate | ( | ) |
Perform some validation on this CRS.
If the CRS doesn't validate the default behavior settings for layers with unknown CRS will be consulted and acted on accordingly. By hell or high water this method will do its best to make sure that this CRS is valid - even if that involves resorting to a hard coded default of geocs:wgs84.
Definition at line 418 of file qgscoordinatereferencesystem.cpp.
QString QgsCoordinateReferenceSystem::validationHint | ( | ) |
Gets user hint for validation.
Definition at line 1621 of file qgscoordinatereferencesystem.cpp.
|
static |
Returns a list of all valid SRS IDs present in the CRS database.
Any of the returned values can be safely passed to fromSrsId() to create a new, valid QgsCoordinateReferenceSystem object.
Definition at line 112 of file qgscoordinatereferencesystem.cpp.
bool QgsCoordinateReferenceSystem::writeXml | ( | QDomNode & | node, |
QDomDocument & | doc | ||
) | const |
Stores state to the given Dom node in the given document.
node | The node in which state will be restored |
doc | The document in which state will be stored |
Definition at line 1454 of file qgscoordinatereferencesystem.cpp.
|
friend |
Definition at line 804 of file qgscoordinatereferencesystem.h.
|
read |
Definition at line 193 of file qgscoordinatereferencesystem.h.