# Introduction

<span class="rvts6">A Voxel Farm project is a collection of entities. Each entity is a collection of key-value pairs. Both key and value are strings. These pairs will be called “properties” in this document.</span>

<span class="rvts6">Each entity will have a special property “ID” which uniquely identifies the entity. This ID is often used in REST calls to identify the entity.</span>

<span class="rvts6">Entities also have a “name” property. This is a readable name that will be used in the UI for users to identify the entity.</span>

<span class="rvts6">Another special property, “type” describes the type of entity. The entity type can be one of these:</span>

<span class="rvts6">  
</span>

<div class="rvps2" id="bkmrk-%E2%80%9Cproject%E2%80%9D-specifies-"><table border="1" cellpadding="7" cellspacing="-1"><tbody><tr valign="top"><td valign="top" width="81"><span class="rvts6">“PROJECT”</span>

</td><td valign="top" width="542"><span class="rvts6">Specifies the entity is a Voxel Farm project. A project entity can contain other entities.</span>

</td></tr><tr valign="top"><td valign="top" width="81"><span class="rvts6">“FILE”</span>

</td><td valign="top" width="542"><span class="rvts6">An entity that contains data, either data that was imported into the system or that was produced by the system</span>

</td></tr><tr valign="top"><td valign="top" width="81"><span class="rvts6">“REGION”</span>

</td><td valign="top" width="542"><span class="rvts6">A special type of entity that describes a 3D scope</span>

</td></tr></tbody></table>

</div><span class="rvts6"> </span><span class="rvts6">File entities can be placed inside Folder entities. The “file\_folder” in the File entity property specifies the ID of the Folder that contains it.</span>

<span class="rvts6">Most entities in a project will be of “FILE” type, as these are the ones holding the source data and processed results. To differentiate them, the “file\_type” property is used. These are the different file types that can appear in Voxel Farm projects:</span>

<span class="rvts6">  
</span>

<div class="rvps2" id="bkmrk-%E2%80%9Cfolder%E2%80%9D-a-special-t"><table border="1" cellpadding="7" cellspacing="-1"><tbody><tr valign="top"><td valign="top" width="136"><span class="rvts6">“FOLDER”</span>

</td><td valign="top" width="485"><span class="rvts6">A special type of file entity inside a project that can contain other file entities.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“RAWPC”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw point could, that is, a point cloud that has been uploaded by users and remains in an unprocessed format.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“IDXPC”</span>

</td><td valign="top" width="485"><span class="rvts6">A point cloud that has been processed by the system and inserted into a spatial index.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VOXSURF”</span>

</td><td valign="top" width="485"><span class="rvts6">A Voxel Terrain entity, usually derived from a heightmap or raw point cloud.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“RAWHM”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw raster set defining heights, also known as a heightmap.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“RAWBM”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw Block Model, typically stores a CVS file and column metadata for the block model</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“RAWMESH”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw mesh object.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“IDXMESH”</span>

</td><td valign="top" width="485"><span class="rvts6">A mesh that has been processed and indexed into the project.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"VOXMESH"</span>

</td><td valign="top" width="485"><span class="rvts6">A voxelized mesh set with attributes</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VOXBM”</span>

</td><td valign="top" width="485"><span class="rvts6">A voxelized Block Model. This is the output of processing a “RAWBM” entity.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“RAWDH”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw drill hole dataset.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"IDXDH"</span>

</td><td valign="top" width="485"><span class="rvts6">An indexed drill hole dataset.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“ORTHO”</span>

</td><td valign="top" width="485"><span class="rvts6">A raw imagery raster set, typically used to apply ortho imagery to terrains. Includes images and world registration files.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"IDXORTHO"</span>

</td><td valign="top" width="485"><span class="rvts6">An indexed imagery set. A single imagery set can supply different formats for the image, depending on what the clients can read.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“PROGRAM”</span>

</td><td valign="top" width="485"><span class="rvts6">An entity that stores a Python program for a custom report, view or spatial object.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VOXGEN”</span>

</td><td valign="top" width="485"><span class="rvts6">An entity that generates volumetric content on-the-fly using a Python program that runs on the servers.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VOXOP”</span>

</td><td valign="top" width="485"><span class="rvts6">A real-time terrain operation layer.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VIEW”</span>

</td><td valign="top" width="485"><span class="rvts6">Describes a view in the project. A view is a mashup of different entities and viewing options used for rendering</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“REPORT”</span>

</td><td valign="top" width="485"><span class="rvts6">An entity that describes a report</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“EXPORT”</span>

</td><td valign="top" width="485"><span class="rvts6">An entity that holds data that can be downloaded out of the system.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“UNITY”</span>

</td><td valign="top" width="485"><span class="rvts6">An entity that contains a Unity project already preconfigured for this Voxel Farm project</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">“VOXMT”</span>

</td><td valign="top" width="485"><span class="rvts6">A Material Tracking Layer. See the [Material Tracking API](https://help.mystart.com/books/developer-manual/chapter/material-tracking-api "Material Tracking API")</span><span class="rvts6"> for additional REST calls available for this entity type.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"VOXPC"</span>

</td><td valign="top" width="485"><span class="rvts6">A voxelized point cloud. This entity produces a volumetric model out of a set of spherical point cloud capture sets.</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"RAWGEOCHEM"</span>

</td><td valign="top" width="485"><span class="rvts6">A raw Geo-chemical samples dataset</span>

</td></tr><tr valign="top"><td valign="top" width="136"><span class="rvts6">"GEOCHEM"</span>

</td><td valign="top" width="485"><span class="rvts6">A processed Geo-chemical samples dataset.</span>

</td></tr></tbody></table>

</div>