{"_id":"585162b2d8404c3900c75dab","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"parentDoc":null,"user":"56267741db1eda0d001c3dbb","project":"55faeacad0e22017005b8265","__v":0,"category":{"_id":"57e2bd9d1e7b7220000d7fa5","version":"55faeacad0e22017005b8268","__v":0,"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-09-21T17:04:29.273Z","from_sync":false,"order":14,"slug":"answerfactory-web-application","title":"AnswerFactory Application"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-14T15:18:10.713Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"This page explains the parts of AnswerFactory. If you are looking for a quick guide to creating and viewing a project, view the [AnswerFactory Web Project Course](doc:answerfactory-web-project-course).\n\n| Contents |\n| --- |\n| [Get Started](#section-get-started) |\n| [AnswerFactory Web Application Overview](#section-answerfactory-web-application-overview) |\n| [Open Project](#section-open-project-page) |\n| [View Project](#section-view-project-page) |\n| [Project Information](#section-project-information) |\n| [Answers List](#section-answers-list) |\n| [Create New Project Page ](#section-create-new-project-page) |\n| [Answer Types](#section-answer-types) |\n| [Recipe Builder](#section-recipe-builder) |\n\n#Get Started#\n##Supported Browsers##\nThe GBDX AnswerFactory web application is supported on Google Chrome. It is functional on Firefox but not actively tested. We do not support Microsoft Internet Explorer or Edge at this time.\n\n##Logging In##\n[Sign in to AnswerFactory](https://vector.geobigdata.io/answer-factory/login) using your GBDX credentials - your email address and the password you created for your account. If you do not have GBDX credentials, create an account with GBDX by going to the [GBDX home page](https://gbdx.geobigdata.io/login) and selecting the \"Sign Up\" option. Note that if your company already has an account, your account administrator will need to add you as a user to the account. If you are an account administrator, see the guide for [adding users to your account](doc:web-application-course#section-user-profile).\n\nOnce you have reached the login screen, you may check the release notes by clicking on the What's New button, check out our video overview by clicking the Tutorial button, or you may simply enter your GBDX credentials and continue into AnswerFactory.\n\n#AnswerFactory Web Application Overview#\nThere are two main components in the AnswerFactory web application.\n\n| Page Name | Description |\n| --- | --- |\n| Open Project | From the Open Project page, you can find previously created projects and view the answer results, download completed answer result vectors, or check on the progress of the answers being processed. Use filtering to search for specific projects or only see projects of your own creation. This is the page you will always start on when you log in to AnswerFactory. |\n| New Project | From the New Project page, you can target your area of interest, choose the types of answers you want results for in your aoi, and save the project to be recalled at a later date. |\n\nIn both components, you will see some universal tools.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1ad10f4-Base_screen1.PNG\",\n        \"Base_screen1.PNG\",\n        1679,\n        984,\n        \"#162523\"\n      ],\n      \"caption\": \"Universal Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Open Project | Click to switch to the Open Project page, where you can view existing projects. |\n| 2 | New Project | Click to switch to the New Project page, where you can create new projects. |\n| 3 | User Information | Shows the user currently logged in. Click to see the dropdown menu options available to the user. Currently available options are: View your **Account Usage** stats, change your vector **Settings** between default vector loading and vector tiling, or **Log Out** of AnswerFactory. *Note: Be aware that the vector tiling is experimental for a reason, and certain capabilities in AnswerFactory may be broken while vector tiling is toggled on. Also, note that vector tiling will default to \"off\" and does not save changes to the toggle between sessions.* |\n| 4 | Zoom In | Click to zoom in on the map, making an area appear larger with more detail. The mouse wheel can also be used to zoom. |\n| 5 | Zoom Out | Click to zoom out on the map, for a more distant view of an area. The mouse wheel can also be used to zoom. |\n| 6 | Layer Legend | Hover over icon to see the layer list. Layers may be toggled on and off, and basemap may be changed here. Current existing basemap options are: **DigitalGlobe Maps API: Vivid Imagery with Streets** (image basemap with vector detail enhancement), **DigitalGlobe Maps API: Vivid Imagery** (image basemap without vector detail enhancement), **toner-lite** (black-and-white vector detail enhanced basemap). |\n| 7 | Help | Click to reach the help pages. |\n\n#Open Project Page#\nUpon login, you will first be directed to the Open Project page. From the Open Project page, you will search out previously created projects and dig into them for more detailed views.\n\n*Note: We provide public demo projects to allow users to become acquainted with AnswerFactory. These demo projects cannot be altered by the user.*\n\nThese tools are specific to the Open Project page.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/56b6d12-Open_Project_v2.PNG\",\n        \"Open_Project_v2.PNG\",\n        361,\n        651,\n        \"#083054\"\n      ],\n      \"caption\": \"Open Project Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Minimize | Click to minimize the Project List window. Click again to bring the window back to full view. |\n| 2 | Filter Projects | Click to expand drop down selection of toggled filtering options. Click again to collapse toggled filtering options display. |\n| 3 | Refresh | Click to force refresh the project list manually. Project list automatically updates once a minute. |\n| 4 | Show Only My Projects | One of the available toggled filtering options in the drop down selection. Toggle on for viewing solely projects you have created, or leave toggled off to view all projects created in your group account. Leaving toggle off will also allow user to see all publicly available demo projects. |\n| 5 | Show Only Projects in Current Viewport | One of the available toggled filtering options in the drop down selection. Toggle on for viewing solely projects within the bounds of the current view of the basemap. Panning and zooming the map will change the displayed projects. Toggle off to display all projects, regardless of whether they are within the current map view. | \n| 6 | Search Bar | Type text to dynamically filter project list by project name. |\n| 7 | Project List Page Navigation | There are several ways to move through the pages of the list of projects in your account. Click on the arrows to jump forward or back through pages. Click on the visible numbers to jump to that page. Click on the dropdown to select any specific page to jump to. |\n\nTo get started, search the project list to find the project you would like to view and click on it in the project listing. This will drill down to the View Project level.\n\n##View Project Page##\nOnce you have drilled into your desired project, you will notice a change in the accessible functionality on the page. The map will automatically snap to the project aoi, and the IDAHO imagery that encompasses the aoi will be overlaid on top of the basemap. IDAHO imagery may be toggled off from the Legend. Note that, at this point, the IDAHO imagery being displayed is associated with the project as a whole, not with any specific answer.\n\nThere are now two panels to note: the Project Information panel, and the Answer List panel.\n\n###Project Information###\nThe Project Information window lists the information for the selected project under the project details section and the configured answers section. The project details section includes the project creator, date and time of creation, date and time of last update, project tags, project description, project notes, user-specified catalog ids associated with the project, user-specified date range to automatically search for catalog ids and the associated count of dates for comparison for change detection answers, toggle to make the project public within the GBDX community, and the toggle to have the project \"watch\" for new imagery that intersects its aoi(s) and run answers against the new imagery automatically. The configured answers section includes the answers that are currently associated with the project. You may add and remove answers from the project from this window.\n\nThese are the tools that will help you in this view.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2b23ea2-Project_Information_Panel_Tools.PNG\",\n        \"Project_Information_Panel_Tools.PNG\",\n        361,\n        690,\n        \"#134362\"\n      ],\n      \"caption\": \"Project Information Panel Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Return to Project List | Click to back out of the current project and return to the base Open Project page with the list of currently existing projects available in your group account. |\n| 2 | Edit Project Name | Click into field and change the project name if desired. *Note: You must click the Update button to update the project after altering it.* |\n| 3 | Minimize | Click to minimize the Project Information window. Click again to bring the window back to full view. |\n| 4 | Project Details | Click Project details to expand/collapse Details section. By default, this section is collapsed. More information on details section [here](#section-view-project-details). |\n| 5 | Configured Answers | Click Configured answers to expand/collapse Answers section. By default, this section is expanded. This area contains all of the answers that have been added to the project, including settings specific to individual answers. |\n| 6 | Remove Answer | This is within the Configured answers section. Click to remove an answer from the project. *Note: You must click the Update button to update the project after altering it.* |\n| 7 | Add Answer | Click to bring up a separate panel for selecting available answers to add to the project. More than one answer may be added to a single project. The separate panel works as both a dropdown list, and the user can type text to dynamically filter answer list by answer name. Answers added to the project will appear in the Project Information panel in the Configured Answers section. Once saved, these answers will also appear in the Answer List panel. *Note: You must click the Update button to update the project after altering it.* |\n| 8 | Delete Project | Click to delete the current project from AnswerFactory. *Note: You can delete any project associated with your group account, but you cannot delete projects that are made public from another group account.* |\n| 9 | Update Project | Click to save any changes made to the project. *Note: With exception of Delete Project, any changes made to the project must be saved via this icon.* |\n\n###View Project Details###\nThe Project Details section of viewing contains optional parameters for user input.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"When creating a project, Buffer size is available, however this field is not visible when viewing an existing project.\\nLikewise, the (user uneditable) fields of Owner, Created date, and Updated date are not present during initial project creation.\",\n  \"title\": \"View Project details section and Create Project details section are slightly mismatched\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c4215b5-View_Project_Details.PNG\",\n        \"View_Project_Details.PNG\",\n        343,\n        691,\n        \"#c8cacb\"\n      ],\n      \"caption\": \"Project Details in View Existing Project view\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Owner | The GBDX member who initially created the project. This is not user editable. |\n| 2 | Created | The date and time that the project was first saved. This is not user editable. |\n| 3 | Updated | The date and time that the project was last updated. Update events can be anything from changing the name of a project to adding project tags to adding or removing answers from the project. This is not user editable. |\n| 4 | Tags | Type project tags into this field. You can add any number of tags to your projects to help with sorting them in the future. |\n| 5 | Description | Use this field to describe your project for easy future reference as to what the project is about and what in particular you were searching for. |\n| 6 | Notes | Use this field to add miscellaneous information, reminders, etc. about this project. |\n| 7 | Catalog IDs | If you want to run your answers against specific, known acquisitions within the GBDX Catalog, add the catalog ids in this field, separated by commas. If this field is in use, only the specified catalog ids will be used in answer runs. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 8 | Start Date | Enter a date and time here to specify the earliest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the start date if there are no closer images that fit the filter criteria. Start date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 9 | End Date |  Enter a date and time here to specify the latest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the end date if there are no closer images that fit the filter criteria. End date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 10 | Comparison Count | *Specific to change detection answers* Enter a count for the number of comparisons for the answer(s). For example, a change detection answer count of 2 means that, within the specified date range, the project will search for 3 acquisitions - one as close to the start date as possible (acquisition A), one as close to the end date as possible (acquisition B), and one between the two dates (acquisition C). Comparisons will then be run between A and B, A and C, and B and C. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 11 | Public | Toggle this setting to make the project \"GBDX Public.\" Making a project GBDX Public does not make the project public to everyone. Projects with this toggle checked are visible to all users within the GBDX community. This means that users outside of the creator's account may view the project and it's results, but they cannot change the project itself. |\n| 12 | Automatically Update Answers | Toggle this setting to have the project \"watch\" for new imagery that intersects its aoi(s) and automatically kick off new answer runs against this new imagery. |\n\n###Answers List###\nThis is a panel that can be found to the right of the screen, labeled \"Answers.\" It contains the list of answers associated with the current project. To help users understand the current state of their answers, next to each answer is a status bar.\n\nThe status bar can display in the following pattern:\n\n| Bar Color | Description |\n| --- | --- |\n| Gray | State is Pending. Workflows have yet to be kicked off. If acquisitions need to be ordered first, the status bar will be gray. |\n| Green and Gray | State is In Progress. Workflows have been submitted and are running. Some workflows may be complete and have vectors available for viewing. |\n| Yellow | State is Complete with Failures. Workflows have completed and there are vectors available for viewing. Some workflows have failed. |\n| Yellow and Gray | State is In Progress with Failures. Workflows have been submitted and are running. Some workflows have successfully processed, but some workflows have failed. |\n| Blue | State is Completed Successfully. Workflows have completed and there are vectors available for viewing. |\n| Blue and Gray | State is Completed Successfully with Pending. All available acquisitions have been processed and the current results are available; there is nothing left to process at the moment. However, there are still pending workflows, most likely due to acquisitions needing to be ordered. Once pending workflows are kicked off, bar will transition back to In Progress state. |\n| Red | State is Failed. All workflows have failed. There are no vectors available for viewing. |\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Vector Viewing\",\n  \"body\": \"If an answer has \\\"Currently running\\\" in front of the answer name, vectors can not be view at this time. There are no vectors if \\\"failed\\\" is after the answer name. If an answer is displaying as just the answer name, vectors can be viewed at this time.\"\n}\n[/block]\nAnswerFactory includes several icons to further assist the user in quickly understanding answer states.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c43ed40-Answer_List.PNG\",\n        \"Answer_List.PNG\",\n        345,\n        189,\n        \"#0e3e64\"\n      ],\n      \"caption\": \"Answers List Icons\"\n    }\n  ]\n}\n[/block]\nIcons display next to the answers in the answer list to help clarify their status:\n\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Processing | AnswerFactory is processing your request. This icon appears when the answer is still running through algorithms, or when the user clicks on a completed answer and the information is being queued up. |\n| 2 | Empty Set | This icon appears when an answer is complete, but no results were found within the project parameters. |\n| 3 | Error | AnswerFactory encountered an error working with this answer. This icon appears when the workflows received an error while processing, or there was miscommunication between the front and back end when the completed answer is clicked on and the information is being queued up. In the former case, the answer in question has not processed completely and therefore cannot be displayed. In the latter case, clicking on the answer again should fix the issue. |\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"The Answers List also marks which answer is being viewed by a check mark\",\n  \"body\": \"The check mark will appear following the processing icon, after the answer is loaded. If the loaded answer contains no results, the check mark will be replaced by the empty set icon.\"\n}\n[/block]\nTo view a completed answer, click on it. A table will appear coming up from the bottom of the screen to display the results. Each row represents an aoi. Columns represent the dates of the imagery strips used when processing the answers. If a column has two dates, that represents the two comparison dates in a change detection recipe. Within an individual cell, you will see values separated by commas; these are short breakdowns of available information pertaining to that particular aoi and processed image. The first value is always the number of vectors extracted. Additionally to the vector result number, there will also be information in each cell expressing how much of the aoi is covered by the result vectors (specific to polygon results, such as Water results), how many kilometers of result vectors there are (specific to linestring results, such as Roads results), and how much of the aoi is actually covered by the image acquisition used to extract these vector results. Note that, while all extraction results will have this additional information per cell, not all query results will, generally because the additional information does not apply (such as when querying OSM features). Clicking on a cell in the table will query the results to display on the map. You can hover over vectors on the map to view some basic metadata.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Column names\",\n  \"body\": \"Sometimes a column will not have a full **Year-Month-Day** name, but instead it will display as **Year** (such as 2017) or **Quarter Year** (such as Q4 2016). When a column reads as just a year, or as a specific quarter in a year, it means that there are different acquisitions being used depending on the aoi. Most often, year and quarter year column names end up in use when the aoi is large and spans across multiple satellite image strips.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/adfba81-Aggregation_Table_Tools.PNG\",\n        \"Aggregation_Table_Tools.PNG\",\n        1920,\n        477,\n        \"#c5cccc\"\n      ],\n      \"caption\": \"Aggregation Table Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Minimize | Click to minimize the Table window. Click again to bring the window back to full view. |\n| 2 | Item Types selection | When the results have different types, the various types display in the table. Click on a specific type to see only those results in the table, or click on total to see all of them. |\n| 3 | Column Visibility | Click on column visibility to display the column options, and click on the options to turn them on or off. |\n| 4 | Copy | Click to copy table row(s) to clipboard. |\n| 5 | Print | Click to print table. |\n| 6 | CSV | Click to save table in CSV format. |\n| 7 | PDF | Click to save table in PDF format. |\n| 8 | Table Entries Display option | Click the dropdown to select the number of rows visible in the table at a time. |\n| 9 | Table Filter | Type to dynamically search the table when looking for a specific aoi. |\n| 10 | Download All Results | Click to download all the result vectors for the given answer for the project over all of the aois. |\n| 11 | Table Page Navigation | Click on the arrows to move between pages, or click on a specific page number to jump to the page. |\n\nAdditionally, you can also right click on a cell for cell-specific options to **Download as GeoJson** or dig into the cell **Details**. The former downloads all of the result vectors, including metadata, in geojson format that can then be loaded in another program. The latter, along with double clicking on a cell, will dig down into that cell and bring up the details table.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9dece66-Vector_Cell_Details.PNG\",\n        \"Vector_Cell_Details.PNG\",\n        1919,\n        412,\n        \"#c5cbcd\"\n      ],\n      \"caption\": \"Vector Cell Details\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Column Visibility | Click on column visibility to display the column options, and click on the options to turn them on or off. |\n| 2 | Copy | Click to copy table row(s) to clipboard. |\n| 3 | Print | Click to print table. |\n| 4 | CSV | Click to save table in CSV format. |\n| 5 | PDF | Click to save table in PDF format. |\n| 6 | Table Entries Display option | Click the dropdown to select the number of rows visible in the table at a time. |\n| 7 | Table Filter | Type to dynamically search the table when looking for a specific aoi. |\n| 8 | Zoom To | Click to pan and zoom to the specific vector detailed on that row. |\n| 9 | Thumb Up/Down | Click on the relevant thumb to tag a vector as a thumb up (what you are looking for, otherwise known as a true positive) or a thumb down (not what you are looking for, otherwise known as a false positive). |\n| 10 | Table Page Navigation | Click on the arrows to move between pages, or click on a specific page number to jump to the page. |\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Thumbs Up/Thumbs Down\",\n  \"body\": \"Thumbs are helpful when sorting the result vectors in your project. However, they only apply to your project. Thumbs are not included in the base vector metadata, should you or someone else run a query that catches some of these result vectors.\"\n}\n[/block]\n#Create New Project Page#\nThese tools are specific to the Create New Project page.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9727942-New_Project_Tools.PNG\",\n        \"New_Project_Tools.PNG\",\n        361,\n        210,\n        \"#063665\"\n      ],\n      \"caption\": \"New Project Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Minimize | Click to minimize the window. Click again to bring the window back to full view. |\n| 2 | Draw | Click to activate draw capability. Single click on map to drop the vertices of your aoi, and double-click to complete an aoi. Draw remains active, and you may draw any number of aois. Once you have completed drawing aois, click Draw button again to deactivate continued drawing capability. Aoi(s) display in *pink*. |\n| 3 | Upload Shapefile | Click to open your computer directory to upload a **zipped** shapefile (including all necessary components of .dbf, .prj, .shp, and .shx); this shapefile will serve as your aoi, and the map will automatically snap to the shapefile once upload is complete. Aoi(s) display in *pink*. |\n\nOnce an aoi is added or created, more functionality is exposed.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fcab8bc-Aoi-expanded_New_Project_Tools.PNG\",\n        \"Aoi-expanded_New_Project_Tools.PNG\",\n        362,\n        660,\n        \"#093052\"\n      ],\n      \"caption\": \"Aoi-Expanded New Project Tools\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Aoi List | These fields *only appear with drawn aois*. Name each drawn aoi for easier reference later on. *Note: you cannot edit aoi names after save.* |\n| 2 | Feature Name | This dropdown field *only appears with uploaded aois*. Select the field that aois will be grouped by. |\n| 3 | Project Name | Text field to enter a name for your project. |\n| 4 | Project details | Click Project details to expand/collapse Details section. By default, this section is collapsed. More information on details section [here](#section-create-project-details). |\n| 5 | Add Answers | Click to open the modal with a dropdown of available answers. Answers may be searched by typing into the field above the dropdown. You may also request a new answer from here. Answers added to the project will appear on the right of the screen. |\n| 6 | Reset Project | Click to clear all layers and answers to start over from scratch. |\n| 7 | Create Project | Click to save the project once you have set all of your specifications. |\n\n##Create Project Details##\nThe Project Details section of creation contains optional parameters for user input.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"View Project details section and Create Project details section are slightly mismatched\",\n  \"body\": \"When creating a project, Buffer size is available, however this field is not visible when viewing an existing project.\\nLikewise, the (user uneditable) fields of Owner, Created date, and Updated date are not present during initial project creation.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f56f967-Create_Project_Details.PNG\",\n        \"Create_Project_Details.PNG\",\n        345,\n        678,\n        \"#c9cbcd\"\n      ],\n      \"caption\": \"Project Details in Create New Project view\"\n    }\n  ]\n}\n[/block]\n| Image Reference Number | Name | Description |\n| --- | --- | --- |\n| 1 | Buffer size | This adds a buffer around your aoi(s). Enter a numeric value in the first field and select from the dropdown field whether this value will be processed as meters, kilometers, or miles. The buffer value you give will be treated as a radius. *Note: Buffers are required if the aoi is a point or a linestring.* |\n| 2 | Tags | Type project tags into this field. You can add any number of tags to your projects to help with sorting them in the future. |\n| 3 | Description | Use this field to describe your project for easy future reference as to what the project is about and what in particular you were searching for. |\n| 4 | Notes | Use this field to add miscellaneous information, reminders, etc. about this project. |\n| 5 | Catalog IDs | If you want to run your answers against specific, known acquisitions within the GBDX Catalog, add the catalog ids in this field, separated by commas. If this field is in use, only the specified catalog ids will be used in answer runs. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 6 | Start Date | Enter a date and time here to specify the earliest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the start date if there are no closer images that fit the filter criteria. Start date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 7 | End Date |  Enter a date and time here to specify the latest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the end date if there are no closer images that fit the filter criteria. End date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 8 | Comparison Count | *Specific to change detection answers* Enter a count for the number of comparisons for the answer(s). For example, a change detection answer count of 2 means that, within the specified date range, the project will search for 3 acquisitions - one as close to the start date as possible (acquisition A), one as close to the end date as possible (acquisition B), and one between the two dates (acquisition C). Comparisons will then be run between A and B, A and C, and B and C. *Note: Catalog ID field trumps Custom Date Settings.* |\n| 9 | Public | Toggle this setting to make the project \"GBDX Public.\" Making a project GBDX Public does not make the project public to everyone. Projects with this toggle checked are visible to all users within the GBDX community. This means that users outside of the creator's account may view the project and it's results, but they cannot change the project itself. |\n| 10 | Automatically Update Answers | Toggle this setting to have the project \"watch\" for new imagery that intersects its aoi(s) and automatically kick off new answer runs against this new imagery. |\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Catalog ID vs Custom Date Settings\",\n  \"body\": \"If AnswerFactory detects Catalog IDs, the Start Date, End Date, and Comparison Count fields will be hidden. If Catalog IDs are removed, these fields will appear again.\"\n}\n[/block]\n##Answer Types##\nWhen creating a project, a user can add any number of answers to the project. There are two main classifications of answers that can be added to a project: extraction answers and query answers. An extraction answer will run GBDX workflows and produce new results over the project's aoi. A query answer will search the current vector database and return existing vectors that both match the query parameters and that intersect the project's aoi.\n\nCheck the [Answer Types](doc:answerfactory-answer-types) page to see the up-to-date list of answer types.\n\n##Recipe Builder##\nA user with some coding skills can also generate their own answers if they have access to the GBDX tasks and have generated a workflow (see: [GBDX Task and Workflow Documentation](doc:workflow-api-course)). Check the AnswerFactory video page for a tutorial on [how to build a new answer](doc:answerfactory-videos#section-how-to-build-a-new-answer).\n\nThe recipe builder may be accessed by clicking on the **Add Answers** button, and in the modal clicking **Or click here to create your own answer!**.  The new modal that appears will start with asking you to define what you are looking for by filling in the blanks of the sentence `I want ___ from ___ using ___`, after which the corresponding fields appear.\n\nCurrently, the only response for the first blank is \"Vectors.\" This means that the results will be in vector format.\n\nFor the second blank, you are specifying what you want your recipe to process against.\n\n| *From* Field | Description |\n| --- | --- |\n| Acquisitions | A single image acquisition per workflow. |\n| Acquisition Pairs | A pair of image acquisitions per workflow. |\n| Warmer Season Acquisitions | Best guess seasonal & regional used to select a single image acquisition per workflow. |\n| GBDX Vector Services | Elasticsearch vector based; no image acquisitions used. |\n\nFor the third blank, you are specifying how you want your recipe to process.\n\n| *Using* Field | Description |\n| --- | --- |\n| Parallelized GBDX Workflow | GBDX workflow that operates on chunks. |\n| GBDX Workflow | GBDX workflow. |\n| GBDX Vector Services Query | GBDX VectorServices query. |\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Once you select your option for one field, the options in the other field change to only those that work with your other selection.\",\n  \"title\": \"From and Using fields are dynamic!\"\n}\n[/block]\nRecipes can be built with the following combinations:\n\n| *From* | *Using* | Description |\n| --- | --- | --- |\n| Acquisitions | Parallelized GBDX Workflow | Executes a GBDX workflow that operates on chunks of a single image acquisition, and outputs vectors to GBDX VectorServices. |\n| Acquisitions | GBDX Workflow | Executes a GBDX workflow on a single image acquisition, and outputs vectors to GBDX VectorServices. |\n| Acquisition Pairs | GBDX Workflow | Executes a GBDX workflow on multiple image acquisitions, and outputs vectors to GBDX VectorServices. Note: This would be useful in comparisons, such as running change detections. |\n| Warmer Season Acquisitions | Parallelized GBDX Workflow | Provides best guess recommendations for seasonal & regional image acquisition parameters, executes a GBDX workflow that operates on chunks of a single image acquisition, and outputs vectors to GBDX VectorServices. |\n| Warmer Season Acquisitions | GBDX Workflow | Provides best guess recommendations for seasonal & regional image acquisition parameters, executes a GBDX workflow on a single image acquisition, and outputs vectors to GBDX VectorServices. |\n| GBDX Vector Services | GBDX Vector Services Query | Executes a GBDX VectorServices query. This generates a Query recipe, not an Extract recipe. |\n\nDepending on which combination of fields is chosen, different fields will become available for the user to populate.\n\n| Field Name | Description |\n| --- | --- |\n| Recipe Name | The text that identifies the recipe. This will be the name of the recipe as it appears in the UI, and what is translated into a Recipe ID for the API. (For example, naming the recipe Extract Cars will generate in the UI an *Extract Cars* recipe, and that recipe will be translated as *extract-cars* as the Recipe ID.) |\n| Workflow ID | The ID of the GBDX workflow used to build the recipe. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Acquisition Type | The type of acquisition the recipe should be run on (DigitalGlobe Acquisition, Landsat Acquisition, etc). Defaults to DigitalGlobe Acquisition. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Minimum Number of Bands | The minimum number of bands the input image is required to have. For instance, if the recipe requires only 1 band, or PAN, select 1. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Vector Type | The type of vectors to ingest into GBDX VectorServices. Vectors may be ingested as GeoJson, Shapefile, or VectorServices ItemJson. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Vector Item Type | The value of item_type each individual vector extracted using this recipe will be stored as in GBDX VectorServices. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Partition Size | The size, in kilometers squared, to partition the input acquisition into. Note: This field only appears when the *Using* field has Parallelized GBDX Workflow selected. |\n| Query Index | The Elasticsearch query index from which to retrieve the desired vectors from GBDX VectorServices. Searches of specified indicies are faster than queries that run through all indicies. Note: This field is only displayed for the Vector Service/Vector Service combination of *From* and *Using* fields. |\n| Query String | The Elasticsearch query string to retrieve the desired vectors from GBDX VectorServices. Note: This field is only displayed for the Vector Service/Vector Service combination of *From* and *Using* fields. See [Vector Query Syntax, Query Fields, and Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) for help with query construction. |\n\nAfter populating the necessary fields, clicking **Build** will display the recipe that has been built to the above specifications for user review. Users may tweak and change the recipe within the recipe window, or go back into any of the fields or even reset the dropdowns and change them, and click **Rebuild** to have updates translate into the recipe window.  Once satisfied, users click **Create**. The recipe will then be displayed in the regular answer list for use.\n\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If the user is creating a recipe based on a workflow that has already been partitioned, or broken into chunks for processing, **do not** set up the recipe as a parallelized recipe. At that point, you are chunking up chunks, which does not work.\",\n  \"title\": \"Parallelizing a parallelized workflow\"\n}\n[/block]","excerpt":"Welcome to DigitalGlobe's GBDX AnswerFactory Web Application","slug":"answerfactory-web-application-course","type":"basic","title":"AnswerFactory Web Application Course"}

AnswerFactory Web Application Course

Welcome to DigitalGlobe's GBDX AnswerFactory Web Application

This page explains the parts of AnswerFactory. If you are looking for a quick guide to creating and viewing a project, view the [AnswerFactory Web Project Course](doc:answerfactory-web-project-course). | Contents | | --- | | [Get Started](#section-get-started) | | [AnswerFactory Web Application Overview](#section-answerfactory-web-application-overview) | | [Open Project](#section-open-project-page) | | [View Project](#section-view-project-page) | | [Project Information](#section-project-information) | | [Answers List](#section-answers-list) | | [Create New Project Page ](#section-create-new-project-page) | | [Answer Types](#section-answer-types) | | [Recipe Builder](#section-recipe-builder) | #Get Started# ##Supported Browsers## The GBDX AnswerFactory web application is supported on Google Chrome. It is functional on Firefox but not actively tested. We do not support Microsoft Internet Explorer or Edge at this time. ##Logging In## [Sign in to AnswerFactory](https://vector.geobigdata.io/answer-factory/login) using your GBDX credentials - your email address and the password you created for your account. If you do not have GBDX credentials, create an account with GBDX by going to the [GBDX home page](https://gbdx.geobigdata.io/login) and selecting the "Sign Up" option. Note that if your company already has an account, your account administrator will need to add you as a user to the account. If you are an account administrator, see the guide for [adding users to your account](doc:web-application-course#section-user-profile). Once you have reached the login screen, you may check the release notes by clicking on the What's New button, check out our video overview by clicking the Tutorial button, or you may simply enter your GBDX credentials and continue into AnswerFactory. #AnswerFactory Web Application Overview# There are two main components in the AnswerFactory web application. | Page Name | Description | | --- | --- | | Open Project | From the Open Project page, you can find previously created projects and view the answer results, download completed answer result vectors, or check on the progress of the answers being processed. Use filtering to search for specific projects or only see projects of your own creation. This is the page you will always start on when you log in to AnswerFactory. | | New Project | From the New Project page, you can target your area of interest, choose the types of answers you want results for in your aoi, and save the project to be recalled at a later date. | In both components, you will see some universal tools. [block:image] { "images": [ { "image": [ "https://files.readme.io/1ad10f4-Base_screen1.PNG", "Base_screen1.PNG", 1679, 984, "#162523" ], "caption": "Universal Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Open Project | Click to switch to the Open Project page, where you can view existing projects. | | 2 | New Project | Click to switch to the New Project page, where you can create new projects. | | 3 | User Information | Shows the user currently logged in. Click to see the dropdown menu options available to the user. Currently available options are: View your **Account Usage** stats, change your vector **Settings** between default vector loading and vector tiling, or **Log Out** of AnswerFactory. *Note: Be aware that the vector tiling is experimental for a reason, and certain capabilities in AnswerFactory may be broken while vector tiling is toggled on. Also, note that vector tiling will default to "off" and does not save changes to the toggle between sessions.* | | 4 | Zoom In | Click to zoom in on the map, making an area appear larger with more detail. The mouse wheel can also be used to zoom. | | 5 | Zoom Out | Click to zoom out on the map, for a more distant view of an area. The mouse wheel can also be used to zoom. | | 6 | Layer Legend | Hover over icon to see the layer list. Layers may be toggled on and off, and basemap may be changed here. Current existing basemap options are: **DigitalGlobe Maps API: Vivid Imagery with Streets** (image basemap with vector detail enhancement), **DigitalGlobe Maps API: Vivid Imagery** (image basemap without vector detail enhancement), **toner-lite** (black-and-white vector detail enhanced basemap). | | 7 | Help | Click to reach the help pages. | #Open Project Page# Upon login, you will first be directed to the Open Project page. From the Open Project page, you will search out previously created projects and dig into them for more detailed views. *Note: We provide public demo projects to allow users to become acquainted with AnswerFactory. These demo projects cannot be altered by the user.* These tools are specific to the Open Project page. [block:image] { "images": [ { "image": [ "https://files.readme.io/56b6d12-Open_Project_v2.PNG", "Open_Project_v2.PNG", 361, 651, "#083054" ], "caption": "Open Project Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Minimize | Click to minimize the Project List window. Click again to bring the window back to full view. | | 2 | Filter Projects | Click to expand drop down selection of toggled filtering options. Click again to collapse toggled filtering options display. | | 3 | Refresh | Click to force refresh the project list manually. Project list automatically updates once a minute. | | 4 | Show Only My Projects | One of the available toggled filtering options in the drop down selection. Toggle on for viewing solely projects you have created, or leave toggled off to view all projects created in your group account. Leaving toggle off will also allow user to see all publicly available demo projects. | | 5 | Show Only Projects in Current Viewport | One of the available toggled filtering options in the drop down selection. Toggle on for viewing solely projects within the bounds of the current view of the basemap. Panning and zooming the map will change the displayed projects. Toggle off to display all projects, regardless of whether they are within the current map view. | | 6 | Search Bar | Type text to dynamically filter project list by project name. | | 7 | Project List Page Navigation | There are several ways to move through the pages of the list of projects in your account. Click on the arrows to jump forward or back through pages. Click on the visible numbers to jump to that page. Click on the dropdown to select any specific page to jump to. | To get started, search the project list to find the project you would like to view and click on it in the project listing. This will drill down to the View Project level. ##View Project Page## Once you have drilled into your desired project, you will notice a change in the accessible functionality on the page. The map will automatically snap to the project aoi, and the IDAHO imagery that encompasses the aoi will be overlaid on top of the basemap. IDAHO imagery may be toggled off from the Legend. Note that, at this point, the IDAHO imagery being displayed is associated with the project as a whole, not with any specific answer. There are now two panels to note: the Project Information panel, and the Answer List panel. ###Project Information### The Project Information window lists the information for the selected project under the project details section and the configured answers section. The project details section includes the project creator, date and time of creation, date and time of last update, project tags, project description, project notes, user-specified catalog ids associated with the project, user-specified date range to automatically search for catalog ids and the associated count of dates for comparison for change detection answers, toggle to make the project public within the GBDX community, and the toggle to have the project "watch" for new imagery that intersects its aoi(s) and run answers against the new imagery automatically. The configured answers section includes the answers that are currently associated with the project. You may add and remove answers from the project from this window. These are the tools that will help you in this view. [block:image] { "images": [ { "image": [ "https://files.readme.io/2b23ea2-Project_Information_Panel_Tools.PNG", "Project_Information_Panel_Tools.PNG", 361, 690, "#134362" ], "caption": "Project Information Panel Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Return to Project List | Click to back out of the current project and return to the base Open Project page with the list of currently existing projects available in your group account. | | 2 | Edit Project Name | Click into field and change the project name if desired. *Note: You must click the Update button to update the project after altering it.* | | 3 | Minimize | Click to minimize the Project Information window. Click again to bring the window back to full view. | | 4 | Project Details | Click Project details to expand/collapse Details section. By default, this section is collapsed. More information on details section [here](#section-view-project-details). | | 5 | Configured Answers | Click Configured answers to expand/collapse Answers section. By default, this section is expanded. This area contains all of the answers that have been added to the project, including settings specific to individual answers. | | 6 | Remove Answer | This is within the Configured answers section. Click to remove an answer from the project. *Note: You must click the Update button to update the project after altering it.* | | 7 | Add Answer | Click to bring up a separate panel for selecting available answers to add to the project. More than one answer may be added to a single project. The separate panel works as both a dropdown list, and the user can type text to dynamically filter answer list by answer name. Answers added to the project will appear in the Project Information panel in the Configured Answers section. Once saved, these answers will also appear in the Answer List panel. *Note: You must click the Update button to update the project after altering it.* | | 8 | Delete Project | Click to delete the current project from AnswerFactory. *Note: You can delete any project associated with your group account, but you cannot delete projects that are made public from another group account.* | | 9 | Update Project | Click to save any changes made to the project. *Note: With exception of Delete Project, any changes made to the project must be saved via this icon.* | ###View Project Details### The Project Details section of viewing contains optional parameters for user input. [block:callout] { "type": "info", "body": "When creating a project, Buffer size is available, however this field is not visible when viewing an existing project.\nLikewise, the (user uneditable) fields of Owner, Created date, and Updated date are not present during initial project creation.", "title": "View Project details section and Create Project details section are slightly mismatched" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/c4215b5-View_Project_Details.PNG", "View_Project_Details.PNG", 343, 691, "#c8cacb" ], "caption": "Project Details in View Existing Project view" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Owner | The GBDX member who initially created the project. This is not user editable. | | 2 | Created | The date and time that the project was first saved. This is not user editable. | | 3 | Updated | The date and time that the project was last updated. Update events can be anything from changing the name of a project to adding project tags to adding or removing answers from the project. This is not user editable. | | 4 | Tags | Type project tags into this field. You can add any number of tags to your projects to help with sorting them in the future. | | 5 | Description | Use this field to describe your project for easy future reference as to what the project is about and what in particular you were searching for. | | 6 | Notes | Use this field to add miscellaneous information, reminders, etc. about this project. | | 7 | Catalog IDs | If you want to run your answers against specific, known acquisitions within the GBDX Catalog, add the catalog ids in this field, separated by commas. If this field is in use, only the specified catalog ids will be used in answer runs. *Note: Catalog ID field trumps Custom Date Settings.* | | 8 | Start Date | Enter a date and time here to specify the earliest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the start date if there are no closer images that fit the filter criteria. Start date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* | | 9 | End Date | Enter a date and time here to specify the latest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the end date if there are no closer images that fit the filter criteria. End date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* | | 10 | Comparison Count | *Specific to change detection answers* Enter a count for the number of comparisons for the answer(s). For example, a change detection answer count of 2 means that, within the specified date range, the project will search for 3 acquisitions - one as close to the start date as possible (acquisition A), one as close to the end date as possible (acquisition B), and one between the two dates (acquisition C). Comparisons will then be run between A and B, A and C, and B and C. *Note: Catalog ID field trumps Custom Date Settings.* | | 11 | Public | Toggle this setting to make the project "GBDX Public." Making a project GBDX Public does not make the project public to everyone. Projects with this toggle checked are visible to all users within the GBDX community. This means that users outside of the creator's account may view the project and it's results, but they cannot change the project itself. | | 12 | Automatically Update Answers | Toggle this setting to have the project "watch" for new imagery that intersects its aoi(s) and automatically kick off new answer runs against this new imagery. | ###Answers List### This is a panel that can be found to the right of the screen, labeled "Answers." It contains the list of answers associated with the current project. To help users understand the current state of their answers, next to each answer is a status bar. The status bar can display in the following pattern: | Bar Color | Description | | --- | --- | | Gray | State is Pending. Workflows have yet to be kicked off. If acquisitions need to be ordered first, the status bar will be gray. | | Green and Gray | State is In Progress. Workflows have been submitted and are running. Some workflows may be complete and have vectors available for viewing. | | Yellow | State is Complete with Failures. Workflows have completed and there are vectors available for viewing. Some workflows have failed. | | Yellow and Gray | State is In Progress with Failures. Workflows have been submitted and are running. Some workflows have successfully processed, but some workflows have failed. | | Blue | State is Completed Successfully. Workflows have completed and there are vectors available for viewing. | | Blue and Gray | State is Completed Successfully with Pending. All available acquisitions have been processed and the current results are available; there is nothing left to process at the moment. However, there are still pending workflows, most likely due to acquisitions needing to be ordered. Once pending workflows are kicked off, bar will transition back to In Progress state. | | Red | State is Failed. All workflows have failed. There are no vectors available for viewing. | [block:callout] { "type": "info", "title": "Vector Viewing", "body": "If an answer has \"Currently running\" in front of the answer name, vectors can not be view at this time. There are no vectors if \"failed\" is after the answer name. If an answer is displaying as just the answer name, vectors can be viewed at this time." } [/block] AnswerFactory includes several icons to further assist the user in quickly understanding answer states. [block:image] { "images": [ { "image": [ "https://files.readme.io/c43ed40-Answer_List.PNG", "Answer_List.PNG", 345, 189, "#0e3e64" ], "caption": "Answers List Icons" } ] } [/block] Icons display next to the answers in the answer list to help clarify their status: | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Processing | AnswerFactory is processing your request. This icon appears when the answer is still running through algorithms, or when the user clicks on a completed answer and the information is being queued up. | | 2 | Empty Set | This icon appears when an answer is complete, but no results were found within the project parameters. | | 3 | Error | AnswerFactory encountered an error working with this answer. This icon appears when the workflows received an error while processing, or there was miscommunication between the front and back end when the completed answer is clicked on and the information is being queued up. In the former case, the answer in question has not processed completely and therefore cannot be displayed. In the latter case, clicking on the answer again should fix the issue. | [block:callout] { "type": "info", "title": "The Answers List also marks which answer is being viewed by a check mark", "body": "The check mark will appear following the processing icon, after the answer is loaded. If the loaded answer contains no results, the check mark will be replaced by the empty set icon." } [/block] To view a completed answer, click on it. A table will appear coming up from the bottom of the screen to display the results. Each row represents an aoi. Columns represent the dates of the imagery strips used when processing the answers. If a column has two dates, that represents the two comparison dates in a change detection recipe. Within an individual cell, you will see values separated by commas; these are short breakdowns of available information pertaining to that particular aoi and processed image. The first value is always the number of vectors extracted. Additionally to the vector result number, there will also be information in each cell expressing how much of the aoi is covered by the result vectors (specific to polygon results, such as Water results), how many kilometers of result vectors there are (specific to linestring results, such as Roads results), and how much of the aoi is actually covered by the image acquisition used to extract these vector results. Note that, while all extraction results will have this additional information per cell, not all query results will, generally because the additional information does not apply (such as when querying OSM features). Clicking on a cell in the table will query the results to display on the map. You can hover over vectors on the map to view some basic metadata. [block:callout] { "type": "info", "title": "Column names", "body": "Sometimes a column will not have a full **Year-Month-Day** name, but instead it will display as **Year** (such as 2017) or **Quarter Year** (such as Q4 2016). When a column reads as just a year, or as a specific quarter in a year, it means that there are different acquisitions being used depending on the aoi. Most often, year and quarter year column names end up in use when the aoi is large and spans across multiple satellite image strips." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/adfba81-Aggregation_Table_Tools.PNG", "Aggregation_Table_Tools.PNG", 1920, 477, "#c5cccc" ], "caption": "Aggregation Table Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Minimize | Click to minimize the Table window. Click again to bring the window back to full view. | | 2 | Item Types selection | When the results have different types, the various types display in the table. Click on a specific type to see only those results in the table, or click on total to see all of them. | | 3 | Column Visibility | Click on column visibility to display the column options, and click on the options to turn them on or off. | | 4 | Copy | Click to copy table row(s) to clipboard. | | 5 | Print | Click to print table. | | 6 | CSV | Click to save table in CSV format. | | 7 | PDF | Click to save table in PDF format. | | 8 | Table Entries Display option | Click the dropdown to select the number of rows visible in the table at a time. | | 9 | Table Filter | Type to dynamically search the table when looking for a specific aoi. | | 10 | Download All Results | Click to download all the result vectors for the given answer for the project over all of the aois. | | 11 | Table Page Navigation | Click on the arrows to move between pages, or click on a specific page number to jump to the page. | Additionally, you can also right click on a cell for cell-specific options to **Download as GeoJson** or dig into the cell **Details**. The former downloads all of the result vectors, including metadata, in geojson format that can then be loaded in another program. The latter, along with double clicking on a cell, will dig down into that cell and bring up the details table. [block:image] { "images": [ { "image": [ "https://files.readme.io/9dece66-Vector_Cell_Details.PNG", "Vector_Cell_Details.PNG", 1919, 412, "#c5cbcd" ], "caption": "Vector Cell Details" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Column Visibility | Click on column visibility to display the column options, and click on the options to turn them on or off. | | 2 | Copy | Click to copy table row(s) to clipboard. | | 3 | Print | Click to print table. | | 4 | CSV | Click to save table in CSV format. | | 5 | PDF | Click to save table in PDF format. | | 6 | Table Entries Display option | Click the dropdown to select the number of rows visible in the table at a time. | | 7 | Table Filter | Type to dynamically search the table when looking for a specific aoi. | | 8 | Zoom To | Click to pan and zoom to the specific vector detailed on that row. | | 9 | Thumb Up/Down | Click on the relevant thumb to tag a vector as a thumb up (what you are looking for, otherwise known as a true positive) or a thumb down (not what you are looking for, otherwise known as a false positive). | | 10 | Table Page Navigation | Click on the arrows to move between pages, or click on a specific page number to jump to the page. | [block:callout] { "type": "info", "title": "Thumbs Up/Thumbs Down", "body": "Thumbs are helpful when sorting the result vectors in your project. However, they only apply to your project. Thumbs are not included in the base vector metadata, should you or someone else run a query that catches some of these result vectors." } [/block] #Create New Project Page# These tools are specific to the Create New Project page. [block:image] { "images": [ { "image": [ "https://files.readme.io/9727942-New_Project_Tools.PNG", "New_Project_Tools.PNG", 361, 210, "#063665" ], "caption": "New Project Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Minimize | Click to minimize the window. Click again to bring the window back to full view. | | 2 | Draw | Click to activate draw capability. Single click on map to drop the vertices of your aoi, and double-click to complete an aoi. Draw remains active, and you may draw any number of aois. Once you have completed drawing aois, click Draw button again to deactivate continued drawing capability. Aoi(s) display in *pink*. | | 3 | Upload Shapefile | Click to open your computer directory to upload a **zipped** shapefile (including all necessary components of .dbf, .prj, .shp, and .shx); this shapefile will serve as your aoi, and the map will automatically snap to the shapefile once upload is complete. Aoi(s) display in *pink*. | Once an aoi is added or created, more functionality is exposed. [block:image] { "images": [ { "image": [ "https://files.readme.io/fcab8bc-Aoi-expanded_New_Project_Tools.PNG", "Aoi-expanded_New_Project_Tools.PNG", 362, 660, "#093052" ], "caption": "Aoi-Expanded New Project Tools" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Aoi List | These fields *only appear with drawn aois*. Name each drawn aoi for easier reference later on. *Note: you cannot edit aoi names after save.* | | 2 | Feature Name | This dropdown field *only appears with uploaded aois*. Select the field that aois will be grouped by. | | 3 | Project Name | Text field to enter a name for your project. | | 4 | Project details | Click Project details to expand/collapse Details section. By default, this section is collapsed. More information on details section [here](#section-create-project-details). | | 5 | Add Answers | Click to open the modal with a dropdown of available answers. Answers may be searched by typing into the field above the dropdown. You may also request a new answer from here. Answers added to the project will appear on the right of the screen. | | 6 | Reset Project | Click to clear all layers and answers to start over from scratch. | | 7 | Create Project | Click to save the project once you have set all of your specifications. | ##Create Project Details## The Project Details section of creation contains optional parameters for user input. [block:callout] { "type": "info", "title": "View Project details section and Create Project details section are slightly mismatched", "body": "When creating a project, Buffer size is available, however this field is not visible when viewing an existing project.\nLikewise, the (user uneditable) fields of Owner, Created date, and Updated date are not present during initial project creation." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/f56f967-Create_Project_Details.PNG", "Create_Project_Details.PNG", 345, 678, "#c9cbcd" ], "caption": "Project Details in Create New Project view" } ] } [/block] | Image Reference Number | Name | Description | | --- | --- | --- | | 1 | Buffer size | This adds a buffer around your aoi(s). Enter a numeric value in the first field and select from the dropdown field whether this value will be processed as meters, kilometers, or miles. The buffer value you give will be treated as a radius. *Note: Buffers are required if the aoi is a point or a linestring.* | | 2 | Tags | Type project tags into this field. You can add any number of tags to your projects to help with sorting them in the future. | | 3 | Description | Use this field to describe your project for easy future reference as to what the project is about and what in particular you were searching for. | | 4 | Notes | Use this field to add miscellaneous information, reminders, etc. about this project. | | 5 | Catalog IDs | If you want to run your answers against specific, known acquisitions within the GBDX Catalog, add the catalog ids in this field, separated by commas. If this field is in use, only the specified catalog ids will be used in answer runs. *Note: Catalog ID field trumps Custom Date Settings.* | | 6 | Start Date | Enter a date and time here to specify the earliest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the start date if there are no closer images that fit the filter criteria. Start date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* | | 7 | End Date | Enter a date and time here to specify the latest date that the project answer(s) should attempt to run against. Images selected may be within a few months to either side of the end date if there are no closer images that fit the filter criteria. End date works with both change detection and non change detection answers. *Note: Catalog ID field trumps Custom Date Settings.* | | 8 | Comparison Count | *Specific to change detection answers* Enter a count for the number of comparisons for the answer(s). For example, a change detection answer count of 2 means that, within the specified date range, the project will search for 3 acquisitions - one as close to the start date as possible (acquisition A), one as close to the end date as possible (acquisition B), and one between the two dates (acquisition C). Comparisons will then be run between A and B, A and C, and B and C. *Note: Catalog ID field trumps Custom Date Settings.* | | 9 | Public | Toggle this setting to make the project "GBDX Public." Making a project GBDX Public does not make the project public to everyone. Projects with this toggle checked are visible to all users within the GBDX community. This means that users outside of the creator's account may view the project and it's results, but they cannot change the project itself. | | 10 | Automatically Update Answers | Toggle this setting to have the project "watch" for new imagery that intersects its aoi(s) and automatically kick off new answer runs against this new imagery. | [block:callout] { "type": "info", "title": "Catalog ID vs Custom Date Settings", "body": "If AnswerFactory detects Catalog IDs, the Start Date, End Date, and Comparison Count fields will be hidden. If Catalog IDs are removed, these fields will appear again." } [/block] ##Answer Types## When creating a project, a user can add any number of answers to the project. There are two main classifications of answers that can be added to a project: extraction answers and query answers. An extraction answer will run GBDX workflows and produce new results over the project's aoi. A query answer will search the current vector database and return existing vectors that both match the query parameters and that intersect the project's aoi. Check the [Answer Types](doc:answerfactory-answer-types) page to see the up-to-date list of answer types. ##Recipe Builder## A user with some coding skills can also generate their own answers if they have access to the GBDX tasks and have generated a workflow (see: [GBDX Task and Workflow Documentation](doc:workflow-api-course)). Check the AnswerFactory video page for a tutorial on [how to build a new answer](doc:answerfactory-videos#section-how-to-build-a-new-answer). The recipe builder may be accessed by clicking on the **Add Answers** button, and in the modal clicking **Or click here to create your own answer!**. The new modal that appears will start with asking you to define what you are looking for by filling in the blanks of the sentence `I want ___ from ___ using ___`, after which the corresponding fields appear. Currently, the only response for the first blank is "Vectors." This means that the results will be in vector format. For the second blank, you are specifying what you want your recipe to process against. | *From* Field | Description | | --- | --- | | Acquisitions | A single image acquisition per workflow. | | Acquisition Pairs | A pair of image acquisitions per workflow. | | Warmer Season Acquisitions | Best guess seasonal & regional used to select a single image acquisition per workflow. | | GBDX Vector Services | Elasticsearch vector based; no image acquisitions used. | For the third blank, you are specifying how you want your recipe to process. | *Using* Field | Description | | --- | --- | | Parallelized GBDX Workflow | GBDX workflow that operates on chunks. | | GBDX Workflow | GBDX workflow. | | GBDX Vector Services Query | GBDX VectorServices query. | [block:callout] { "type": "info", "body": "Once you select your option for one field, the options in the other field change to only those that work with your other selection.", "title": "From and Using fields are dynamic!" } [/block] Recipes can be built with the following combinations: | *From* | *Using* | Description | | --- | --- | --- | | Acquisitions | Parallelized GBDX Workflow | Executes a GBDX workflow that operates on chunks of a single image acquisition, and outputs vectors to GBDX VectorServices. | | Acquisitions | GBDX Workflow | Executes a GBDX workflow on a single image acquisition, and outputs vectors to GBDX VectorServices. | | Acquisition Pairs | GBDX Workflow | Executes a GBDX workflow on multiple image acquisitions, and outputs vectors to GBDX VectorServices. Note: This would be useful in comparisons, such as running change detections. | | Warmer Season Acquisitions | Parallelized GBDX Workflow | Provides best guess recommendations for seasonal & regional image acquisition parameters, executes a GBDX workflow that operates on chunks of a single image acquisition, and outputs vectors to GBDX VectorServices. | | Warmer Season Acquisitions | GBDX Workflow | Provides best guess recommendations for seasonal & regional image acquisition parameters, executes a GBDX workflow on a single image acquisition, and outputs vectors to GBDX VectorServices. | | GBDX Vector Services | GBDX Vector Services Query | Executes a GBDX VectorServices query. This generates a Query recipe, not an Extract recipe. | Depending on which combination of fields is chosen, different fields will become available for the user to populate. | Field Name | Description | | --- | --- | | Recipe Name | The text that identifies the recipe. This will be the name of the recipe as it appears in the UI, and what is translated into a Recipe ID for the API. (For example, naming the recipe Extract Cars will generate in the UI an *Extract Cars* recipe, and that recipe will be translated as *extract-cars* as the Recipe ID.) | | Workflow ID | The ID of the GBDX workflow used to build the recipe. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Acquisition Type | The type of acquisition the recipe should be run on (DigitalGlobe Acquisition, Landsat Acquisition, etc). Defaults to DigitalGlobe Acquisition. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Minimum Number of Bands | The minimum number of bands the input image is required to have. For instance, if the recipe requires only 1 band, or PAN, select 1. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Vector Type | The type of vectors to ingest into GBDX VectorServices. Vectors may be ingested as GeoJson, Shapefile, or VectorServices ItemJson. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Vector Item Type | The value of item_type each individual vector extracted using this recipe will be stored as in GBDX VectorServices. Note: This field is not available for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Partition Size | The size, in kilometers squared, to partition the input acquisition into. Note: This field only appears when the *Using* field has Parallelized GBDX Workflow selected. | | Query Index | The Elasticsearch query index from which to retrieve the desired vectors from GBDX VectorServices. Searches of specified indicies are faster than queries that run through all indicies. Note: This field is only displayed for the Vector Service/Vector Service combination of *From* and *Using* fields. | | Query String | The Elasticsearch query string to retrieve the desired vectors from GBDX VectorServices. Note: This field is only displayed for the Vector Service/Vector Service combination of *From* and *Using* fields. See [Vector Query Syntax, Query Fields, and Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) for help with query construction. | After populating the necessary fields, clicking **Build** will display the recipe that has been built to the above specifications for user review. Users may tweak and change the recipe within the recipe window, or go back into any of the fields or even reset the dropdowns and change them, and click **Rebuild** to have updates translate into the recipe window. Once satisfied, users click **Create**. The recipe will then be displayed in the regular answer list for use. [block:callout] { "type": "warning", "body": "If the user is creating a recipe based on a workflow that has already been partitioned, or broken into chunks for processing, **do not** set up the recipe as a parallelized recipe. At that point, you are chunking up chunks, which does not work.", "title": "Parallelizing a parallelized workflow" } [/block]