syntax = "proto2";

/* Properties can be extended by the user to define the properties of the detected objects. For example properties of
 * objects might include their size, intensity, orientation, or more complex self-computed heuristics. Since this is
 * realized using protobuf extensions, the IDs have to be 100 and bigger. // TODO see example.
 */
message Properties { // TODO cant it be 1-max?
  extensions 100 to max;
}

// TODO doc
message VoxelData {
  repeated uint32 index = 1;
  optional float value = 2;
}

// TODO doc
message VertexData {
  repeated float position = 1;
  optional float value = 2;
}

// TODO doc
message FaceData {
  repeated uint32 vertices = 1; // reference to vertex_list
  optional float value = 2;
}

// TODO doc
message VoxelRepresentation {

  optional string desc = 1;
  repeated VoxelData voxel_data = 2;
  // ...

}

// TODO doc
message LineRepresentation {

  optional string desc = 1;
  repeated VertexData vertex_data = 2;
  // ...

}

// TODO doc
message BoundaryRepresentation {

  optional string desc = 1;
  repeated VertexData vertex_data = 2;
  repeated FaceData face_data = 3;
  // ...

}


/* A Connection represents an edge in the tracking graph. They reference objects by ID and an edge exists iff they are
   from consecutive time stamps in the same time series and the tracking algorithm identifies a correspondance.
 */
message Connection {
  required int32 id_1 = 1;
  required int32 id_2 = 2;
}

/* Object represents one detected object in the dataset for one single point in time with its current properties.
 * It also can contain a form of data representation, like volume (list of voxels), lines or boundaries.
 */
message Object {
        required int32 id = 1;
        repeated LineRepresentation line_rep = 2;
        optional VoxelRepresentation voxel_rep = 3;
        repeated BoundaryRepresentation boundary_rep = 4;
        optional Properties properties = 5;
}

/* TimeLine represents the state of the data for one single point in time within one time series. It is defined by its
 * valid time and contains a list of objects detected at this point in time.
 */
message Timeline { // TODO this is not a timeline, only one step! rename stuff
      required string valid_time = 1;
      repeated Object objects = 2;
}

/* TrackableSet represents one trackable set (one time series) in the dataset. It is defined by some meta data (member,
 * initialization time of reforecast, ...). It contains the timeline list, where each entry represents a (re)forecast
 * point in time in the time series. It also contains the connections between objects in the time series if the tracking
 * is executed. Connections connect pairwise object IDs in the series to represent that these are the same according
 * to the used algorithm.
 */
message TrackableSet {
    optional string init_time = 1;
    optional float member = 2;

    repeated Timeline timeline = 3;
    repeated Connection connections = 4;
}

/* DatasetDescription represents the description of the entire dataset Besides some meta data it contains a list of
 * trackable set. A trackable set is a series of timestamps of one single (re)forecast, e.g. one member. The tracking
 * makes use of the fact, that objects in each set (e.g. each member) can be tracked in parallel.
 */
message DatasetDescription {
  required string name = 1;
  required string file = 2;
  required string run_time = 3;

  repeated TrackableSet sets = 4;


}