Update the grid.json according to the version 2.1.0

[agrignard]

@vaap1997 we are working on a standard format that any reader/writer of a grid can use.

The specification is here
https://github.com/CityScope/CS_CityIO_Backend/wiki/Data-Format

and you can find an example of a table that is compatible with this here:
https://cityio.media.mit.edu/api/table/virtual_table

it would be great if this file https://github.com/CityScope/CSL_Lima/blob/master/projects/LegoReader/data/grid.json is following the patterns.

You are not that far actually what is missing is

• the header
  https://github.com/CityScope/CS_CityIO_Backend/wiki/Data-Format#header-dictionary

• the meta (ideally you shouldn't worry to much as later it will be filled by the cityIO server)
  https://github.com/CityScope/CS_CityIO_Backend/wiki/Data-Format#meta

• the grid information is here https://github.com/CityScope/CS_CityIO_Backend/wiki/Data-Format#grid2d-list
  you just need to store the grid value in this format for each cell you just have to send the rot and the id (the color pattern is not usefull in this case). and then for the grid the format is slightly different (we don't store anymore the x and y we just store all the cell as a list where the first element of the grid is cell 0,0, the second cell 0,1 etc..

So in your case we will have

"block":["type","rotation"]

and a list of cell value with the id and the rotation

e.g [180,1],[90,1],[270,3], etc

[vaap1997]

Arnaud, I just change the grid format

[agrignard]

@vaap1997 this is getting there. In the grid you are now sending mor eor less what we need (even if the color pattern are useless I think)

In order to be really compatible with 2.10 you will need also to add the header.

I will provide you an example soon the header is bascially a kind of templat that is suppose to put the information relative to the table.

[agrignard]

This is how your header could look (for sure this will depend on the table that is scanning) but let's imagine you have a table in LIMA the header might look like this:

"header":{"name":"cityscope_lima","spatial":{"nrows":16,"ncols":16,"physical_longitude":-77,"physical_latitude":12,"longitude":-77,"latitude":12,"cellSize":10,"rotation":0},"owner":{"name":"Vanessa","title":"Researcher,"institute":"univeristy of Lima"},"block":["type","height","rotation"],"mapping":{"type":{"0":"RL","1":"RM","2":"RS","3":"OL","4":"OM","5":"OS","6":"ROAD"}}}

Note that in the case of your generic tools the mapping is maybe optional as it here to say in some case that id 1 correspond to a certain type "RL" in our. But at least it might be something like

{"0":"0","1":"1",....,"n":"n"}

where n is number of type of block

[vaap1997]

I think is done! Tell me if you have any comments

[agrignard]

@vaap1997 Maybe the wiki for the data format is not clear enough.

But the version you commited is not compatible.

What you are missing is the grid list where you basically send all the grid value as a list

for the mapping I don't understand what you put in your version.

The mapping block is just a way to give the possibility to the user to map the id to a specific function

Imagine if you want to say that id:0 is for office and id:1 is for building then the mapping will look like this:
{"0":"office";"1":"building"}

In our case we don't yet the mapping so by default you can just put something like this
{"0":"0","1":"1",....,"n":"n"} where n is the number of type of block (e.g if you have 6 different type of block).

Then we can think about an interface that gives the possibility to the user to explicitly do the maping.

[agrignard]

@JesusGarcia98 we use to have a feature that enables to export the grid in a grid.json format in order to be compatible with cityIO. In the master branch it's the method called exportGrid however it has disappear from the dev branche, any reason why? Would it be possible to put it back in the dev branch?

Here is the method in the master branch that needs to be integrated in the dev (it cannot be integrated as it is due to some structural change in the dev branch)

  /**
   *Export a JSONfile with pattern and cells color name
  **/
  public void exportGrid(ArrayList<patternBlock> patternBlocks, Patterns patterns) {
    JSONObject mesh = new JSONObject();
    JSONObject meta = new JSONObject();
    meta.setString("id", "AOpifOF");
    meta.setFloat("timestamp", millis());
    meta.setString("apiv", "2.1.0");
    JSONObject header = new JSONObject();
    header.setString("name", "cityscope_lima");
    JSONObject spatial = new JSONObject();
    spatial.setInt("nrows", this.nblocks);
    spatial.setInt("ncols", this.nblocks);
    spatial.setFloat("physical_longitude", -77);
    spatial.setFloat("physical_latitude", 12);
    spatial.setInt("longitude", -77);
    spatial.setInt("latitude", 12);
    spatial.setInt("cellSize", patterns.blockSize);
    spatial.setInt("rotation", 0);
    header.setJSONObject("spatial", spatial);
    JSONObject owner = new JSONObject();
    owner.setString("name", "Vanesa and Jesús");
    owner.setString("title", "Researcher");
    owner.setString("institute", "Pacific´s University");
    header.setJSONObject("owner", owner);
    JSONArray block = new JSONArray();
    block.setString(1, "type");
    block.setString(0, "rotation");
    header.setJSONArray("block", block);
    JSONObject type = new JSONObject();
    JSONObject mapping = new JSONObject();
    int j = 0;
    for (int i = 0; i < config.patterns.size(); i++) {
      type.setFloat(str(i), j);
      j++;
    }
    mapping.setJSONObject("type", type);
    header.setJSONObject("mapping", mapping);
    int k = 0;
    JSONArray grid = new JSONArray();
    for (int w = 0; w < patternBlocks.size(); w++) {
      JSONObject arrayValue = new JSONObject();
      arrayValue.setFloat("type", patternBlocks.get(w).indexPattern);
      arrayValue.setFloat("rotation", 0);
      grid.setJSONObject(k, arrayValue);
      k++;
    }
    header.setJSONArray("grid", grid);
    mesh.setJSONObject("meta", meta);
    mesh.setJSONObject("header", header);
    saveJSONObject(mesh, "data/grid.json");
    println("Grid exported.");
  }

[JesusGarcia98]

I thought the exportGridUDP() method was the replacement of the method you mentioned, which is why I did not include it. I now have included it again in the dev branch, along with an update in the README.