Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
interimage:brec_operators_documentation [2013/10/29 11:19]
rsilva
interimage:brec_operators_documentation [2014/03/13 07:18] (current)
rsilva
Line 5: Line 5:
  
 InterIMAGE is a multi-platform framework, written in C++, currently with implementations for LINUX and Windows operational systems. Moreover, InterIMAGE provides support for the integration of image processing operators in the interpretation process and, as such operators are treated as external programs by its control mechanism, they can be coded in any computer language, and even in proprietary programs. The InterIMAGE framework offers, nonetheless,​ a repository of operators, called **TerraAIDA** ([[http://​www.dpi.inpe.br/​terraaida]]),​ assembled with software classes and functions supplied by the [[http://​www.terralib.org/​|TerraLib]] library and another repository, called **BREC**, with routines supplied by the [[http://​tolomeofp7.unipv.it/​SoftwareTools/​BREC/​|BREC]] library. InterIMAGE is a multi-platform framework, written in C++, currently with implementations for LINUX and Windows operational systems. Moreover, InterIMAGE provides support for the integration of image processing operators in the interpretation process and, as such operators are treated as external programs by its control mechanism, they can be coded in any computer language, and even in proprietary programs. The InterIMAGE framework offers, nonetheless,​ a repository of operators, called **TerraAIDA** ([[http://​www.dpi.inpe.br/​terraaida]]),​ assembled with software classes and functions supplied by the [[http://​www.terralib.org/​|TerraLib]] library and another repository, called **BREC**, with routines supplied by the [[http://​tolomeofp7.unipv.it/​SoftwareTools/​BREC/​|BREC]] library.
 +
  
  
Line 49: Line 50:
 | Input Image       | TIFF | Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. | | Input Image       | TIFF | Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. |
 | Low-Pass Filter Kernel ​  | Real Number ​  | Filter Kernel (in meters). | Positive real numbers greater than three times the resolution. | Average moving kernel. Must be an exact multiple of the resolution. If not, it will be automatically rounded. | | Low-Pass Filter Kernel ​  | Real Number ​  | Filter Kernel (in meters). | Positive real numbers greater than three times the resolution. | Average moving kernel. Must be an exact multiple of the resolution. If not, it will be automatically rounded. |
-| Threshold ​    | Real Number | Threshold applied to the Build-Up presence Index. ​ | Positive real numbers. |  | +| Threshold ​    | Real Number | Threshold applied to the Build-Up presence Index. | Positive real numbers. |  | 
-| Label Image Resolution ​    | Real Number | The output label image resolution. ​ | Positive real numbers ​or zero for automatic Choose a value good enough matching the resolution of the best used image. Leave blank and the system will automatically choose the resolution. The automatic method can be used only if the operator is not in the semantic network node right below the “scene” node.  |+| Label Image Resolution ​    | Real Number | The output label image resolution. | Positive real numbers. |  |
 | Reliability ​    | Real Number | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  | | Reliability ​    | Real Number | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |
  
Line 138: Line 139:
 | Building Classes ​  | String | Comma-separated list of the building class names. | The classes must be children nodes of the node the BU operator will be run on.  |  | | Building Classes ​  | String | Comma-separated list of the building class names. | The classes must be children nodes of the node the BU operator will be run on.  |  |
 | Reliability ​    | Real Number | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  | | Reliability ​    | Real Number | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |
 +
 +
 +
 +
  
  
Line 182: Line 187:
    
 ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​   ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​  
-| Latitude ​      ​| ​Floating point ?     ​|  | +| Latitude ​      ​| ​Real Number ​  |  | 
-| Longitude ​      ​| ​Floating point  ​| ​?     ​|  | +| Longitude ​      ​| ​Real Number ​ ​| ​  |  | 
-| Day       | Integer ​ | Day of image acquisition. ​  ​| ​  ​|  | +| Day       | Integer ​ | Day of image acquisition. ​  ​| ​[1,​31] ​|  | 
-| Month       | Integer ​ | Month of image acquisition. ​  ​| ​  ​|  | +| Month       | Integer ​ | Month of image acquisition. ​  ​| ​[1,​12] ​|  | 
-| Year       | Integer ​ | Year of image acquisition. ​ |  |  | +| Year       | Integer ​ | Year of image acquisition. ​ | 4-digit years e.g. 2009. |  | 
-| Hour       | Integer ​ | Hour of image acquisition. ​  ​| ​  ​|  | +| Hour       | Integer ​ | Hour of image acquisition. ​  ​| ​[0,​23] ​|  | 
-| Label Image Resolution ​    ​Floating point | The output label image resolution. ​ | Positive real numbers or zero for automatic. ​ | Choose a value good enough matching the resolution of the best used image. Leave blank and the system will automatically choose the resolution. The automatic method can be used only if the operator is not in the semantic network node right above the “scene” node.  | +| Label Image Resolution | Real Number ​| The output label image resolution. ​ | Positive real numbers or zero for automatic. ​ | Choose a value good enough matching the resolution of the best used image. Leave blank and the system will automatically choose the resolution. The automatic method can be used only if the operator is not in the semantic network node right below the “scene” node.  | 
-| Max. Building-Shadow Gap      Integer  ​| Maximum distance between building and shadow. ​  ​| ​?  ​|  | +| Max. Building-Shadow Gap | Real Number ​| Maximum distance between building and shadow ​(in meters).   ​| ​Positive real numbers. ​Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Max. Shadow Length ​      ​| ​Integer  ​| Maximum shadow length. ​  ​| ​?  ​|  | +| Max. Shadow Length ​      ​| ​Real Number ​| Maximum shadow length ​(in meters).   ​| ​Positive real numbers. ​Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Min. Percentage Shadow Sample ​     | Integer ​ | Minimum building edge (percentage) generating shadow. ​  ​| ​|  |+| Min. Percentage Shadow Sample ​     | Integer ​ | Minimum building edge (percentage) generating shadow. ​  ​| ​Positive real numbers. ​|  |
 | Max. Percentage Deviation Sample ​     | Integer ​ | Mean square error for the building heights. ​  | [10,​30] ​ |  | | Max. Percentage Deviation Sample ​     | Integer ​ | Mean square error for the building heights. ​  | [10,​30] ​ |  |
-| Shadow Class       | String ​ | The shadow class name.   | The class must be a children ​node of the node the BU operator will be run on.  |  |+| Shadow Class       | String ​ | The shadow class name.   | The class must be a child node of the node the BU operator will be run on.  |  |
 | Building Classes ​  | String | Comma-separated list of the building class names. | The classes must be children nodes of the node the BU operator will be run on.  |  | | Building Classes ​  | String | Comma-separated list of the building class names. | The classes must be children nodes of the node the BU operator will be run on.  |  |
 | Attribute Name  | String | The name of the attribute that will hold the mean height value of each polygon an will be available in the corresponding BU decision rule. | The name must not match the default attribute names. ​ |  | | Attribute Name  | String | The name of the attribute that will hold the mean height value of each polygon an will be available in the corresponding BU decision rule. | The name must not match the default attribute names. ​ |  |
-| Reliability ​    ​| ​Floating point | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |+| Reliability ​    ​| ​Real Number ​| The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  | 
 + 
  
  
Line 238: Line 245:
    
 ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​   ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​  
-| Input Image      | * .tif  ​| Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. | +| Input Image      | TIFF | Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. | 
-| Minimun Radius ​  ​| ​Integer ​| Minimun size (in pixels) of the radius of the circle around to scanning the radiance | [0, 50] |  | +| Minimun Radius ​  ​| ​Real Number ​| Minimun size (in meters) of the radius of the circle around to scanning the radiance| [0, 50*res] | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Maximum Radius ​  ​| ​Integer ​| Maximum size (in pixels) of the radius of the circle around to scanning the radiance | [5, x] |  | +| Maximum Radius ​  ​| ​Real Number ​| Maximum size (in meters) of the radius of the circle around to scanning the radiance| [5*res, x] | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Step Radius ​  ​| ​Integer ​| Step increment (in pixels) of the radius of the circle around to scanning the radiance | [1, x]  |  | +| Step Radius ​  ​| ​Real Number ​| Step increment (in meters) of the radius of the circle around to scanning the radiance| [1*res, x]  | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Reliability ​    ​| ​Floating point | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |+| Reliability ​    ​| ​Real Number ​| The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  | 
 + 
 + 
 + 
 + 
 + 
  
  
Line 282: Line 295:
    
 ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​   ^ Parameter Name  ^ Type            ^ Description ​              ​^ ​  Valid Values ​     ^   ​Note ​  ​^ ​  
-| Input Image      | * .tif  ​| Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. | +| Input Image      | TIFF | Input image. ​  | Valid image file name.  | The image type must be supported by TerraLib. | 
-| Minimun Radius ​  ​| ​Integer ​| Minimun size (in pixels) of the radius of the circle around to scanning the radiance | [0, 50] |  | +| Minimun Radius ​  ​| ​Real Number ​| Minimun size (in meters) of the radius of the circle around to scanning the radiance| [0, 50*res] | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Maximum Radius ​  ​| ​Integer ​| Maximum size (in pixels) of the radius of the circle around to scanning the radiance | [5, x] |  | +| Maximum Radius ​  ​| ​Real Number ​| Maximum size (in meters) of the radius of the circle around to scanning the radiance| [5*res, x] | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Step Radius ​  ​| ​Integer ​| Step increment (in pixels) of the radius of the circle around to scanning the radiance | [1, x]  |  | +| Step Radius ​  ​| ​Real Number ​| Step increment (in meters) of the radius of the circle around to scanning the radiance| [1*res, x]  | Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​ | 
-| Junction Tipology ​  | Enumeration | The junction type | [L, T, X, Y, M, all]  | M stands for multiple-line crossings. | +| Junction Tipology ​  | Enumeration | The junction type| [L, T, X, Y, M, all]  | M stands for multiple-line crossings. | 
-| Angle Threshold ​  | Integer | Sets a minimum angle between two streets for them to be differentiated and not to be considered as a single street bending in the hypothesised junction point. | (0, x]  ​| ​ | +| Angle Threshold ​  | Integer | Sets a minimum angle between two streets for them to be differentiated and not to be considered as a single street bending in the hypothesised junction point. | Positive number. ​ ​| ​ | 
-| Max Stem   ​| ​Integer ​| The maximum distance between the intersection point and the extreme of one street crossing the junction. | [0, x]  ​| ​ +| MaxStem   ​| ​Real Number ​| The maximum distance between the intersection point and the extreme of one street crossing the junction. | Positive real number. ​ ​| ​Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​
-| Max Gap   ​| ​Integer ​| It is the maximum distance between the extreme of one road (external, non-crossing) and the junction. | [0, x]  ​| ​ +| MaxGap   ​| ​Real Number ​| It is the maximum distance between the extreme of one road (external, non-crossing) and the junction. | Positive real number. ​ ​| ​Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​
-| Min. Junction Distance ​  ​| ​Integer ​| Minimum distance between two junctions for them to be differentiated and not considered as a single junction. | [0, x]  ​| ​ +| Min. Junction Distance ​  ​| ​Real Number ​| Minimum distance between two junctions for them to be differentiated and not considered as a single junction. | Positive real number. ​ ​| ​Must be an exact multiple of the resolution. If not, it will be automatically rounded. ​
-| Angle Tolerance ​  | Integer | Minimum angle between non-coincident streets. ​ | [0, x]  ​| ​ | +| Angle Tolerance ​  | Integer | Minimum angle between non-coincident streets. ​ | Positive number. ​ ​| ​ | 
-| Max. Number of roads   | Integer | Maximum number of roads springing from a junction. ​ | [0, x]  ​| ​ | +| Max. Number of roads   | Integer | Maximum number of roads springing from a junction. ​ | Positive number. ​ ​|  ​
-| Reliability ​    ​| ​Floating point | The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |+| Road Network shapefile ​  | *.shp | Shapefile with a road network. ​ |  | If not given, the operator will extract the roads automatically before computing the crossings. ​
 +| Reliability ​    ​| ​Real Number ​| The reliability (higher priority will be given to nodes with higher weights in cases where there are geographic overlays). ​ | [0.0, 1.0] |  |

Navigation