Search Results

This call deletes a list of entities from the project. If the entity has any data associated to it, it will be deleted as well. Method POST URL <server>/entity.ashx  Parameters id Unique identifier for the entity project Uniq...

Some entities may have raw files associated to them. This is the case of raw point clouds and unprocessed block models. Some other entities may have files that are the result of processing spatial data, like a CSV report file, or datasets that have been export...

Some entities may have raw files associated to them. This is the case of raw point clouds and unprocessed block models. Some other entities may have files that are the result of processing spatial data, like a CSV report file, or datasets that have been export...

In occasions, file sizes can be prohibitively large for uploading using the REST interface, as some services have file limits of 2GB or 4GB for a single file size. In these cases, there are alternatives to consider: If the files have not been compressed, c...

This call retrieves the processing log for an entity. Method GET URL <server>/file.ashx Parameters id Unique identifier for the entity project Project identifier org Organization identifier, use 2343243456678890...

The process of triggering a new version for a Workflow Product involves the following general steps: Upload all required files in the designated drop-zone blob container Once all required files have successfully uploaded, upload one additional file named...

A typical project will require to process raw files into spatially indexed datasets. This process takes one or more raw data entities and produces a new type of entity. In other cases, the system will use information already stored in the spatial storage to cr...

Reports, like some other entities, require to be processed in order to have their data ready for use. The processing of a report is triggered in the same fashion as any other processed entity, which is the subject of the previous section. Before processing a ...

Export entities allow to extract information from Voxel Farm Servers into a standard format. Currently, data can be exported in the following formats: An .OBJ file containing a mesh One or more image tiles in TIF/TFW format A CVS file containing a point c...

This REST call can be used to request the input metadata for a custom program in the system. The metadata contains a list of the inputs the program expects. Method GET URL <server>/entity.ashx   Parameters id Unique identifier for the pro...

This REST call can be used to validate a view, report or generator program. The program’s code must be in Python and use the Voxel Farm Python API. Method POST URL <server>/entity.ashx Parameters program Must be set to “validate” ...

Views are special entities which can be visualized in the 3D viewer. A view will typically involve one or more spatial entities, which will be used in the visualization. The view also captures a number of parameters that will determine how the objects should b...

The REST interface enforces a simple security model. In this model, a single user may be associated with multiple projects, and each project will have multiple users associated with it. In every case, these associations will have one of two access levels: ...

This examples shows how to create a new instance of the Voxel Farm client Python API. # Import the Voxel Farm Client Library from voxelfarm import voxelfarmclient # The URL for the Voxel Space API # https://vf-api.voxelspace.com vf_api_url = os.gete...

This example shows how to provide credentials for API authentication. # Set credentials vf_token = os.getenv('VF_USER_TOKEN') if (vf_token!=None): vf.token=vf_token You can copy the token from your profile in the Developer tab, as shown below:

This example shows how to specify an HTTP proxy to be used in all HTTP calls made by the API. # Use a proxy to debug HTTP requests using Fiddler or similar proxies = {   "http": os.getenv('YOUR_PROXY_URL'), } # Set the proxy to debug HTTP calls ...

This example shows how to retrieve the project's CRS (Coordinate Reference System). # Get the coordinate system given project ID result = vf.get_project_crs(project) if not result.success:     print(result.error_info)     exit() crs = result.cr...

A spatial entity will go through several stages in its lifetime. It is possible to provide custom logic for some of these stages. This version of the Voxel Farm platform allows running custom Python programs to produce volumetric spatial output. This type of p...

Reports are special entities that contain tabular results, like a CSV table. These results are obtained by running a custom program over the spatial datasets available in the project. It is up to the report program to select which datasets should be used, and ...

A View entity defines a way to visualize several datasets together. In order to decide which datasets should be used, which information should be filtered, and how the results should be visualized, the user can supply a View Program, which will run a custom lo...