Projection Factory for coded projections defined in database. More...

#include <ossimWktProjectionFactory.h>

Inheritance diagram for ossimWktProjectionFactory:

Public Member Functions
virtual ossimProjection *	createProjection (const ossimFilename &filename, ossim_uint32 entryIdx) const
	STUB. Not implemented. More...

virtual ossimProjection *	createProjection (const ossimString &name) const
	This is the principal factory method. More...

virtual ossim_uint32	getCode (const ossimString &name)

virtual ossimProjection *	createProjection (const ossimKeywordlist &kwl, const char *prefix=0) const
	Looks for presence of "projection" keyword with the value in WKT format, for example "Anguilla_1957_British_West_Indies_Grid". More...

virtual ossimObject *	createObject (const ossimString &typeName) const

virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	This returns the type name of all objects in all factories. More...

Public Member Functions inherited from ossimProjectionFactoryBase
virtual ossimProjection *	createProjection (ossimImageHandler *handler) const

Public Member Functions inherited from ossimObjectFactory
virtual	~ossimObjectFactory ()

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Static Public Member Functions
static ossimWktProjectionFactory *	instance ()
	Implements singleton pattern. More...

Protected Member Functions
	ossimWktProjectionFactory ()
	Constructor loads the WKT CSV file specified in the ossim prefs with "wkt_database_file" keyword. More...

ossimProjection *	doTransverseMercator (const ossimKeywordlist &kwl) const

ossimProjection *	doMercator (const ossimKeywordlist &kwl) const

ossimProjection *	doLambertConformalConic (const ossimKeywordlist &kwl) const

ossimProjection *	doEquiDistCylindrical (const ossimKeywordlist &kwl) const

ossimProjection *	doEquiAreaCylindrical (const ossimKeywordlist &kwl) const

void	loadRecords () const
	Loads all SRS CSV files specified in the ossim prefs. More...

template<class T >
void	doMapCommon (const ossimKeywordlist &kwl, T proj) const

Protected Member Functions inherited from ossimProjectionFactoryBase
ossimProjection *	createProjectionFromGeometryFile (const ossimFilename &imageFile, ossim_uint32 entryIdx) const
	This method takes the filename and tries to find an external ".geom" file. More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::map< std::string, ossim_uint32 >	m_wktProjRecords

Static Protected Attributes
static ossimWktProjectionFactory *	m_instance = 0
	Singleton implementation. More...

Detailed Description

Projection Factory for coded projections defined in database.

These are projections that are fully defined in database files and specified via a projection coordinate system (PCS) code, such as EPSG codes.

Definition at line 27 of file ossimWktProjectionFactory.h.

Constructor & Destructor Documentation

◆ ossimWktProjectionFactory()

ossimWktProjectionFactory::ossimWktProjectionFactory ( )

inlineprotected

Constructor loads the WKT CSV file specified in the ossim prefs with "wkt_database_file" keyword.

Definition at line 61 of file ossimWktProjectionFactory.h.

Referenced by instance().

61 {}

Member Function Documentation

◆ createObject() [1/2]

ossimObject * ossimWktProjectionFactory::createObject ( const ossimString & typeName ) const

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 298 of file ossimWktProjectionFactory.cpp.

References createProjection().

 {
    return createProjection(typeName);
 }

◆ createObject() [2/2]

ossimObject * ossimWktProjectionFactory::createObject	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 304 of file ossimWktProjectionFactory.cpp.

References createProjection().

 {
    return createProjection(kwl, prefix);
 }

◆ createProjection() [1/3]

ossimProjection * ossimWktProjectionFactory::createProjection	(	const ossimFilename &	filename,
		ossim_uint32	entryIdx
	)		const

virtual

STUB. Not implemented.

Implements ossimProjectionFactoryBase.

Definition at line 313 of file ossimWktProjectionFactory.cpp.

Referenced by createObject(), createProjection(), and ossimPointCloudGeometry::ossimPointCloudGeometry().

 {
    return 0;
 }

◆ createProjection() [2/3]

ossimProjection * ossimWktProjectionFactory::createProjection ( const ossimString & name ) const

virtual

This is the principal factory method.

It accepts a WKT string, for example "Anguilla_1957_British_West_Indies_Grid"

Implements ossimProjectionFactoryBase.

Definition at line 286 of file ossimWktProjectionFactory.cpp.

References createProjection(), ossimWkt::getKwl(), and ossimWkt::parse().

 {
    ossimProjection* proj = 0;
    ossimWkt wkt;
    if (wkt.parse(spec))
    {
       proj = createProjection(wkt.getKwl());
    }
    return proj;
 }

◆ createProjection() [3/3]

ossimProjection * ossimWktProjectionFactory::createProjection	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Looks for presence of "projection" keyword with the value in WKT format, for example "Anguilla_1957_British_West_Indies_Grid".

From keywordlist (as generated typically by ossimWkt class)

Implements ossimProjectionFactoryBase.

Definition at line 206 of file ossimWktProjectionFactory.cpp.

References ossimString::contains(), doEquiAreaCylindrical(), doEquiDistCylindrical(), doLambertConformalConic(), doMercator(), doTransverseMercator(), ossimString::downcase(), ossimString::empty(), ossimKeywordlist::find(), ossimEpsgProjectionDatabase::findProjection(), ossimString::gsub(), ossimEpsgProjectionDatabase::instance(), loadRecords(), m_wktProjRecords, ossimString::string(), ossimKeywordlist::stripPrefixFromAll(), ossimString::toString(), ossimString::toUInt32(), and ossimString::trim().

 {
    // The WKT for the horizontal projection may be part of a compound coordinate system, as
    // indicated by the "COMPD_CS" prefix. Need to remove that prefix first.
    ossimString compd_cs ("COMPD_CS.");
    ossimKeywordlist temp_kwl (keywordList);
    temp_kwl.stripPrefixFromAll(compd_cs);
 
    ossimProjection* proj = 0;
    ossimString pcs_name = temp_kwl.find(prefix, "PROJCS.name");
    if (pcs_name.empty())
       return 0;
 
    if (m_wktProjRecords.empty())
       loadRecords();
 
    // Search the WKT DB for a mapping of projection name to EPSG code. This should take care of
    // majority of cases, like UTM:
    ossimString epsg_code;
    std::map<std::string, ossim_uint32>::const_iterator it = m_wktProjRecords.find(pcs_name.string());
    if (it != m_wktProjRecords.end())
    {
       // Found an entry by this name, fetch the EPSG code:
       epsg_code = ossimString::toString(it->second);
    }
    else
    {
       // The name specified in the WKT could not be found in our WKT->EPSG map.
       // Check for EPSG code in WKT itself:
       ossimString auth_name = temp_kwl.find(prefix, "PROJCS.AUTHORITY.name");
       if (auth_name == "EPSG")
          epsg_code = temp_kwl.find(prefix, "PROJCS.AUTHORITY.param0");
    }
 
    // Use EPSG if determined:
    if (!epsg_code.empty())
    {
       // Strip quotes if any:
       epsg_code.trim( ossimString("\"") );
 
       proj = ossimEpsgProjectionDatabase::instance()->findProjection(epsg_code.toUInt32());
       if (proj)
          return proj;
    }
 
    // Not EPSG, so check conventional proj spec in WKT:
    ossimString proj_name = temp_kwl.find(prefix, "PROJCS.PROJECTION.name");
    if (proj_name.empty())
       return 0;
    proj_name.downcase();
    proj_name.gsub(" ", "_", true);
 
    // Note that prefix is ignored. This KWL is assumed to come from ossimWkt that doesn't prefix:
    if (proj_name.contains("transverse_mercator"))
       proj = doTransverseMercator(temp_kwl);
    else if (proj_name.contains("mercator"))
       proj = doMercator(temp_kwl);
    else if (proj_name.contains("lambert"))
       proj = doLambertConformalConic(temp_kwl);
    else if (proj_name.contains("equirectangular"))
       proj = doEquiDistCylindrical(temp_kwl);
    else if (proj_name.contains("cylindrical_equal_area"))
       proj = doEquiAreaCylindrical(temp_kwl);
 
    return proj;
 }

◆ doEquiAreaCylindrical()

ossimProjection * ossimWktProjectionFactory::doEquiAreaCylindrical ( const ossimKeywordlist & kwl ) const

protected

Definition at line 432 of file ossimWktProjectionFactory.cpp.

Referenced by createProjection().

 {
    ossimCylEquAreaProjection* proj = new ossimCylEquAreaProjection();
    doMapCommon<ossimCylEquAreaProjection*>(kwl, proj);
 
    return proj;
 }

◆ doEquiDistCylindrical()

ossimProjection * ossimWktProjectionFactory::doEquiDistCylindrical ( const ossimKeywordlist & kwl ) const

protected

Definition at line 424 of file ossimWktProjectionFactory.cpp.

Referenced by createProjection().

 {
    ossimEquDistCylProjection* proj = new ossimEquDistCylProjection();
    doMapCommon<ossimEquDistCylProjection*>(kwl, proj);
 
    return proj;
 }

◆ doLambertConformalConic()

ossimProjection * ossimWktProjectionFactory::doLambertConformalConic ( const ossimKeywordlist & kwl ) const

protected

Definition at line 395 of file ossimWktProjectionFactory.cpp.

References ossimString::find(), ossimLambertConformalConicProjection::setStandardParallel1(), ossimLambertConformalConicProjection::setStandardParallel2(), ossimString::toDouble(), and ossimString::toString().

Referenced by createProjection().

 {
    ossimLambertConformalConicProjection* proj = new ossimLambertConformalConicProjection();
    doMapCommon<ossimLambertConformalConicProjection*>(kwl, proj);
 
    // Determine first the units:
    ossimString name_read;
    ossimString val_read;
 
    // Read projection parameters from WKT KWL:
    int param_idx = 0;
    do
    {
       ossimString param("PROJCS.PARAMETER");
       param += ossimString::toString(param_idx++);
       name_read = kwl.find(param + ".name");
       val_read = kwl.find(param + ".param0");
 
       if (name_read.contains("standard_parallel_1"))
          proj->setStandardParallel1(val_read.toDouble());
 
       else if (name_read.contains("standard_parallel_2"))
          proj->setStandardParallel2(val_read.toDouble());
 
    } while (!name_read.empty());
 
    return proj;
 }

◆ doMapCommon()

template<class T >

void ossimWktProjectionFactory::doMapCommon	(	const ossimKeywordlist &	kwl,
		T	proj
	)		const

protected

Definition at line 441 of file ossimWktProjectionFactory.cpp.

References ossimString::contains(), ossimEpsgDatumFactory::create(), ossimString::empty(), ossimKeywordlist::find(), ossimEpsgDatumFactory::instance(), ossimGpt::lat, ossimGpt::lon, MTRS_PER_FT, OSSIM_FEET, ossimString::toDouble(), ossimString::toString(), and ossimString::toUInt32().

 {
    ossimString name_read;
    ossimString val_read;
 
    const ossimDatum* datum = 0;
    name_read = kwl.find("PROJCS.GEOGCS.AUTHORITY.name");
    val_read = kwl.find("PROJCS.GEOGCS.AUTHORITY.param0");
    if ((name_read == "EPSG") && (!val_read.empty()))
    {
       datum = ossimEpsgDatumFactory::instance()->create(val_read.toUInt32());
       if (datum)
          proj->setDatum(datum);
       // TODO: HARN Datum not being handled
    }
 
    // Determine first the units:
    name_read = kwl.find("PROJCS.UNIT.name");
    double conv_factor = 1.0;
    if (name_read.contains("f")) // feet|foot
    {
       conv_factor = MTRS_PER_FT;
       proj->setProjectionUnits(OSSIM_FEET);
    }
 
    // Read projection parameters from WKT KWL:
    int param_idx = 0;
    ossimGpt origin(0, 0, 0, datum);
    do
    {
       ossimString param("PROJCS.PARAMETER");
       param += ossimString::toString(param_idx++);
       name_read = kwl.find(param + ".name");
       val_read = kwl.find(param + ".param0");
 
       if (name_read.contains("central_meridian"))
          origin.lon = val_read.toDouble();
 
       else if (name_read.contains("latitude_of_origin"))
          origin.lat = val_read.toDouble();
 
       else if (name_read.contains("false_easting"))
          proj->setFalseEasting(val_read.toDouble() * conv_factor);
 
       else if (name_read.contains("false_northing"))
          proj->setFalseNorthing(val_read.toDouble() * conv_factor);
 
    } while (!name_read.empty());
 
    proj->setOrigin(origin);
 }

◆ doMercator()

ossimProjection * ossimWktProjectionFactory::doMercator ( const ossimKeywordlist & kwl ) const

protected

Definition at line 366 of file ossimWktProjectionFactory.cpp.

References ossimString::find(), ossimMercatorProjection::setScaleFactor(), ossimString::toDouble(), and ossimString::toString().

Referenced by createProjection().

 {
    ossimMercatorProjection* proj = new ossimMercatorProjection();
    doMapCommon<ossimMercatorProjection*>(kwl, proj);
 
    // Determine first the units:
    ossimString name_read;
    ossimString val_read;
 
    // Read projection parameters from WKT KWL:
    int param_idx = 0;
    do
    {
       ossimString param("PROJCS.PARAMETER");
       param += ossimString::toString(param_idx++);
       name_read = kwl.find(param + ".name");
       val_read = kwl.find(param + ".param0");
 
       if (name_read.contains("scale_factor"))
       {
          proj->setScaleFactor(val_read.toDouble());
          break;
       }
 
    } while (!name_read.empty());
 
    return proj;
 }

◆ doTransverseMercator()

ossimProjection * ossimWktProjectionFactory::doTransverseMercator ( const ossimKeywordlist & kwl ) const

protected

Definition at line 337 of file ossimWktProjectionFactory.cpp.

References ossimString::find(), ossimTransMercatorProjection::setScaleFactor(), ossimString::toDouble(), and ossimString::toString().

Referenced by createProjection().

 {
    ossimTransMercatorProjection* proj = new ossimTransMercatorProjection();
    doMapCommon<ossimTransMercatorProjection*>(kwl, proj);
 
    // Determine first the units:
    ossimString name_read;
    ossimString val_read;
 
    // Read projection parameters from WKT KWL:
    int param_idx = 0;
    do
    {
       ossimString param("PROJCS.PARAMETER");
       param += ossimString::toString(param_idx++);
       name_read = kwl.find(param + ".name");
       val_read = kwl.find(param + ".param0");
 
       if (name_read.contains("scale_factor"))
       {
          proj->setScaleFactor(val_read.toDouble());
          break;
       }
 
    } while (!name_read.empty());
 
    return proj;
 }

◆ getCode()

ossim_uint32 ossimWktProjectionFactory::getCode ( const ossimString & name )

virtual

Definition at line 187 of file ossimWktProjectionFactory.cpp.

References loadRecords(), m_wktProjRecords, and ossimString::string().

 {
    if (m_wktProjRecords.empty())
       loadRecords();
 
    std::map<std::string, ossim_uint32>::const_iterator it = m_wktProjRecords.find(pcsName.string());
 
    if (it != m_wktProjRecords.end())
    {
       // Found an entry by this name, fetch the EPSG code:
       return it->second;
    }
    return 0;
 }

◆ getTypeNameList()

void ossimWktProjectionFactory::getTypeNameList ( std::vector< ossimString > & typeList ) const

virtual

This returns the type name of all objects in all factories.

This is the name used to construct the objects dynamically and this name must be unique.

Implements ossimObjectFactory.

Definition at line 323 of file ossimWktProjectionFactory.cpp.

References loadRecords(), and m_wktProjRecords.

 {
    if (m_wktProjRecords.empty())
       loadRecords();
 
    std::map<std::string, ossim_uint32>::iterator db_iter = m_wktProjRecords.begin();
    while (db_iter != m_wktProjRecords.end())
    {
       typeList.push_back(ossimString(db_iter->first));
       db_iter++;
    }
    return;
 }

◆ instance()

ossimWktProjectionFactory * ossimWktProjectionFactory::instance ( )

static

Implements singleton pattern.

METHOD: instance() Instantiates singleton instance of this class:

Definition at line 75 of file ossimWktProjectionFactory.cpp.

References m_instance, and ossimWktProjectionFactory().

Referenced by ossimProjectionFactoryRegistry::initializeDefaults(), and ossimPointCloudGeometry::ossimPointCloudGeometry().

 {
    if (!m_instance)
       m_instance = new ossimWktProjectionFactory;
    return m_instance;
 }

◆ loadRecords()

void ossimWktProjectionFactory::loadRecords ( ) const

protected

Loads all SRS CSV files specified in the ossim prefs.

Definition at line 85 of file ossimWktProjectionFactory.cpp.

References ossimString::chars(), ossimFilename::dirCat(), getline(), ossimPreferences::instance(), ossimFilename::isReadable(), ossimFilename::isRelative(), ossimPreferences::preferencesKWL(), ossimString::size(), ossimString::string(), and ossimString::trim().

Referenced by createProjection(), getCode(), and getTypeNameList().

 {
    // Fetch filename of WKT projection DB file specified in ossim_preferences:
 
    // Optional ossim share dir:
    ossimFilename share_dir = ossimPreferences::instance()->
       preferencesKWL().findKey( std::string( "ossim_share_directory" ) );
    
    ossimFilename db_name;
    
    ossimFilename wkt_path = ossimPreferences::instance()->preferencesKWL().
       findKey( std::string( "wkt_database_file" ) );
 
    if ( wkt_path.size() )
    {
       if ( !wkt_path.isRelative() )
       {
          //---
          // example:
          // wkt_database_file:/usr/share/ossim/projection/ossim_wkt_pcs.csv
          //---
          db_name = wkt_path;
       }
       else if ( share_dir.size() )
       {
          //---
          // example:
          // ossim_share_dir: /usr/share/ossim
          // wkt_database_file: projection/ossim_wkt_pcs.csv
          //---
          db_name = share_dir.dirCat( wkt_path );
          
          //---
          // This block is for backwards compatibility.
          // Try tacking "projection" onto share dir.
          //---
          if ( !db_name.isReadable() )
          {
             db_name = share_dir.dirCat( ossimFilename("projection") );
             db_name = db_name.dirCat( wkt_path);
 
             // Lastly: Try tacking "ossim/projection" onto share dir.
             if ( !db_name.isReadable() )
             {
                db_name = share_dir.dirCat( ossimFilename("ossim/projection") );
                db_name = db_name.dirCat( wkt_path);
             }
          }
       }
    }
       
    if (!db_name.isReadable())
       return;
 
    // Create only once outside the loop:
    ossimString format_id;
    ossimString line;
 
    // Open the DB file:
    std::ifstream db_stream(db_name.chars());
    bool good_file = false;
    if (db_stream.good())
    {
       // Format specification implied in file's magic number:
       std::getline(db_stream, format_id.string());
       format_id.trim();
       if (format_id == WKT_MAGIC)
          good_file = true;
    }
    if (!good_file)
    {
       ossimNotify(ossimNotifyLevel_WARN)
             << "ossimWktProjectionDatabase::loadRecords() -- Encountered bad WKT database file <"
             << db_name << ">. Skipping this file." << endl;
       db_stream.close();
       return;
    }
 
    // The file is good. Skip over the column descriptor line:
    std::getline(db_stream, line.string());
 
    // Loop to read all data records:
    while (!db_stream.eof())
    {
       std::getline(db_stream, line.string());
       std::vector<ossimString> csvRecord = line.explode(","); // ONLY CSV FILES CONSIDERED HERE
       if (csvRecord.size())
       {
          std::pair<std::string, ossim_uint32> projRecord;
          projRecord.first = csvRecord[1].string();
          projRecord.second = csvRecord[0].toUInt32();
          m_wktProjRecords.insert(projRecord);
       }
    }
 
 //   for ( std::map<ossimString, ossim_uint32>::const_iterator it = m_wktProjRecords.begin();
 //         it != m_wktProjRecords.end(); it++)
 //     cout << "[" << it->first << ", " << it->second << "]"<<endl;
 
    db_stream.close();
 }

Member Data Documentation

◆ m_instance

ossimWktProjectionFactory * ossimWktProjectionFactory::m_instance = 0

staticprotected

Singleton implementation.

Definition at line 73 of file ossimWktProjectionFactory.h.

Referenced by instance().

◆ m_wktProjRecords

std::map<std::string, ossim_uint32> ossimWktProjectionFactory::m_wktProjRecords

mutableprotected

Definition at line 74 of file ossimWktProjectionFactory.h.

Referenced by createProjection(), getCode(), and getTypeNameList().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossimWktProjectionFactory()

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ createProjection() [1/3]

◆ createProjection() [2/3]

◆ createProjection() [3/3]

◆ doEquiAreaCylindrical()

◆ doEquiDistCylindrical()

◆ doLambertConformalConic()

◆ doMapCommon()

◆ doMercator()

◆ doTransverseMercator()

◆ getCode()

◆ getTypeNameList()

◆ instance()

◆ loadRecords()

Member Data Documentation

◆ m_instance

◆ m_wktProjRecords