Georeference Class Reference

Interface specific to georeference plug-ins. More...

#include <Georeference.h>

Inheritance diagram for Georeference:

Inheritance graph

List of all members.

Public Member Functions

virtual LocationType pixelToGeo (LocationType pixel, bool *pAccurate=NULL) const =0
virtual LocationType pixelToGeoQuick (LocationType pixel, bool *pAccurate=NULL) const =0
virtual LocationType geoToPixel (LocationType geo, bool *pAccurate=NULL) const =0
virtual LocationType geoToPixelQuick (LocationType geo, bool *pAccurate=NULL) const =0
virtual QWidget * getGui (RasterElement *pRaster)=0
virtual bool validateGuiInput () const =0
virtual bool canHandleRasterElement (RasterElement *pRaster) const =0

Static Public Member Functions

static bool getSettingAutoGeoreference ()
static bool hasSettingAutoGeoreference ()
static void setSettingAutoGeoreference (bool newValue, bool setIfSame=false)
static std::string getSettingAutoGeoreferenceKey ()
static bool getSettingImporterGeoreferencePlugIn ()
static bool hasSettingImporterGeoreferencePlugIn ()
static void setSettingImporterGeoreferencePlugIn (bool newValue, bool setIfSame=false)
static std::string getSettingImporterGeoreferencePlugInKey ()
static std::vector< std::string > getSettingGeoreferencePlugIns ()
static bool hasSettingGeoreferencePlugIns ()
static void setSettingGeoreferencePlugIns (std::vector< std::string > newValue, bool setIfSame=false)
static std::string getSettingGeoreferencePlugInsKey ()
static bool getSettingCreateLatLonLayer ()
static bool hasSettingCreateLatLonLayer ()
static void setSettingCreateLatLonLayer (bool newValue, bool setIfSame=false)
static std::string getSettingCreateLatLonLayerKey ()
static bool getSettingDisplayLatLonLayer ()
static bool hasSettingDisplayLatLonLayer ()
static void setSettingDisplayLatLonLayer (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayLatLonLayerKey ()
static GeocoordType getSettingGeocoordType ()
static bool hasSettingGeocoordType ()
static void setSettingGeocoordType (GeocoordType newValue, bool setIfSame=false)
static std::string getSettingGeocoordTypeKey ()
static DmsFormatType getSettingLatLonFormat ()
static bool hasSettingLatLonFormat ()
static void setSettingLatLonFormat (DmsFormatType newValue, bool setIfSame=false)
static std::string getSettingLatLonFormatKey ()
static std::string GcpListArg ()

Protected Member Functions

virtual ~Georeference ()

Detailed Description

Interface specific to georeference plug-ins.

Defines the georeference specific interface to all algorithm plug-ins. This interface contains all georeference specific operations.

For Georeference plug-ins to properly serialize and deserialize as part of a session, they need to implement SessionItem::serialize and SessionItem::deserialize.

Definition at line 32 of file Georeference.h.

Constructor & Destructor Documentation

virtual Georeference::~Georeference (  )  [protected, virtual]

Since the Georeference interface is usually used in conjunction with the PlugIn and Executable interfaces, this should be destroyed by casting to the PlugIn interface and calling PlugInManagerServices::destroyPlugIn().

Definition at line 449 of file Georeference.h.

Member Function Documentation

static bool Georeference::getSettingAutoGeoreference (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 45 of file Georeference.h.

static bool Georeference::hasSettingAutoGeoreference (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 52 of file Georeference.h.

static void Georeference::setSettingAutoGeoreference ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 68 of file Georeference.h.

static std::string Georeference::getSettingAutoGeoreferenceKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 76 of file Georeference.h.

static bool Georeference::getSettingImporterGeoreferencePlugIn (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 87 of file Georeference.h.

static bool Georeference::hasSettingImporterGeoreferencePlugIn (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 94 of file Georeference.h.

static void Georeference::setSettingImporterGeoreferencePlugIn ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 110 of file Georeference.h.

static std::string Georeference::getSettingImporterGeoreferencePlugInKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 118 of file Georeference.h.

static std::vector<std::string> Georeference::getSettingGeoreferencePlugIns (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 129 of file Georeference.h.

static bool Georeference::hasSettingGeoreferencePlugIns (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 136 of file Georeference.h.

static void Georeference::setSettingGeoreferencePlugIns ( std::vector< std::string >  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 152 of file Georeference.h.

static std::string Georeference::getSettingGeoreferencePlugInsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 160 of file Georeference.h.

static bool Georeference::getSettingCreateLatLonLayer (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 171 of file Georeference.h.

static bool Georeference::hasSettingCreateLatLonLayer (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 178 of file Georeference.h.

static void Georeference::setSettingCreateLatLonLayer ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 194 of file Georeference.h.

static std::string Georeference::getSettingCreateLatLonLayerKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 202 of file Georeference.h.

static bool Georeference::getSettingDisplayLatLonLayer (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 213 of file Georeference.h.

static bool Georeference::hasSettingDisplayLatLonLayer (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 220 of file Georeference.h.

static void Georeference::setSettingDisplayLatLonLayer ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 236 of file Georeference.h.

static std::string Georeference::getSettingDisplayLatLonLayerKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 244 of file Georeference.h.

static GeocoordType Georeference::getSettingGeocoordType (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 255 of file Georeference.h.

static bool Georeference::hasSettingGeocoordType (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 262 of file Georeference.h.

static void Georeference::setSettingGeocoordType ( GeocoordType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 278 of file Georeference.h.

static std::string Georeference::getSettingGeocoordTypeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 286 of file Georeference.h.

static DmsFormatType Georeference::getSettingLatLonFormat (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 297 of file Georeference.h.

static bool Georeference::hasSettingLatLonFormat (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 304 of file Georeference.h.

static void Georeference::setSettingLatLonFormat ( DmsFormatType  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 320 of file Georeference.h.

static std::string Georeference::getSettingLatLonFormatKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 328 of file Georeference.h.

static std::string Georeference::GcpListArg (  )  [static]

The name for a GcpList argument.

Input arguments with this name will be automatically populated with a GcpList pointer when the plug-in is executed as part of the auto-georeferencing capability of RasterElementImporterShell. Arguments with this name should be of the type GcpList.

Definition at line 338 of file Georeference.h.

virtual LocationType Georeference::pixelToGeo ( LocationType  pixel,
bool *  pAccurate = NULL 
) const [pure virtual]

Takes a scene pixel coordinate and returns the corresponding geocoordinate value.

Parameters:
pixel The scene pixel location as a LocationType
pAccurate Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when pixel is outside the extents of the reference points. When NULL, no accuracy check is performed.
Returns:
The corresponding geocoordinate as a LocationType.

virtual LocationType Georeference::pixelToGeoQuick ( LocationType  pixel,
bool *  pAccurate = NULL 
) const [pure virtual]

Takes a scene pixel coordinate and returns the approximate corresponding geocoordinate value.

This function will accomplish the goal faster than pixelToGeo() if possible.

Parameters:
pixel The scene pixel location as a LocationType
pAccurate Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when pixel is outside the extents of the reference points. When NULL, no accuracy check is performed.
Returns:
The corresponding geocoordinate as a LocationType.

Implemented in GeoreferenceShell.

virtual LocationType Georeference::geoToPixel ( LocationType  geo,
bool *  pAccurate = NULL 
) const [pure virtual]

Takes a geocoordinate and returns the corresponding pixel coordinate value.

Parameters:
geo The geocoordinate as a LocationType
pAccurate Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when geo is outside the extents of the reference points. When NULL, no accuracy check is performed.
Returns:
The corresponding pixel as a LocationType.

virtual LocationType Georeference::geoToPixelQuick ( LocationType  geo,
bool *  pAccurate = NULL 
) const [pure virtual]

Takes a and returns the approximate corresponding geocoordinate scene pixel coordinate value.

This function will accomplish the goal faster than pixelToGeo() if possible.

Parameters:
geo The geocoordinate location as a LocationType
pAccurate Output indicator of conversion accuracy. Georeference plug-ins that can not accurately extrapolate should return false when geo is outside the extents of the reference points. When NULL, no accuracy check is performed.
Returns:
The corresponding pixel as a LocationType.

Implemented in GeoreferenceShell.

virtual QWidget* Georeference::getGui ( RasterElement *  pRaster  )  [pure virtual]

Gets a QWidget to set all parameters needed by the georeferencing algorithm.

The calling method takes ownership of the returned widget. The returned widget may be destroyed at any time after calling Executable::execute() on the plug-in.

Parameters:
pRaster The RasterElement to create the GUI for.
Returns:
The widget with any appropriate controls, or NULL if interactive mode is not supported or no controls are needed.

Implemented in GeoreferenceShell.

virtual bool Georeference::validateGuiInput (  )  const [pure virtual]

Determines if the user input through the GUI is valid.

Returns:
Returns true if the input is valid, otherwise returns false.
See also:
getGui()

Implemented in GeoreferenceShell.

virtual bool Georeference::canHandleRasterElement ( RasterElement *  pRaster  )  const [pure virtual]

Determine if this georeferencing algorithm can be used for the given RasterElement.

Parameters:
pRaster The RasterElement to test.
Returns:
true if the plugin can handle the RasterElement, false otherwise

Software Development Kit - Opticks 4.9.0 Build 16218