[ng] Exchange format definition

README.md

@@ -12,3 +12,91 @@ https://eic.github.io/firebird/
 
 Run `ng serve` in `firebird-ng` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
 
+# Firebird Data Exchange format
+
+Data exchange is both JSON and Javascript object compatible.
+
+It starts with version, any custom origin info and a list of entries.
+In HENP physics `entry` may correspond to `event` data.
+
+```json
+{    
+        "version": "0.01",
+        "origin": {any custom origin info here"},
+        "entries": [
+          entry1, entry2, ...
+        ]
+}
+```
+
+- **version** - is JSON schema version
+- **origin** - designed for any general custom info such as original file name, 
+  timestamp, simulation software version, etc.
+- **entries** - list of entries/events. The format is below.
+
+## Entry format
+
+Entry is an object with `id` and `components` properties.
+By design components represent different hits, tracks, vertices, collections, etc. 
+While can be any arbitary data, that will be further rendered by the frontend.
+
+```json
+{
+  "id": "entry number or unique string",
+  "components": [
+
+   ...
+
+  ]
+}
+```
+
+requrired fields are `id` and `components`.
+
+
+## Component format
+
+- "name": unique string id 
+- "type": string with type (depends on what component will be used in the frontend to render it)
+- "originType": optional string with type of origin, e.g. "edm4eic::TrackerHitData",
+- all other fields are depend on "type"
+
+So far example of exchange format looks like (only required fields are used here):
+
+```json
+{
+  "version": "0.01",
+  "entries": [
+    {
+      "id": "event 0",
+      "components": [
+        {
+          "name": "BarrelVertexHits",
+          "type": "HitBox",
+           ...,
+        },
+        ...
+      ]
+    },
+    ...
+  ]
+}
+```
+
+## HitBox component
+
+```json
+{
+  "pos": [1, 2, 3],
+  "dim": [10, 10, 1],
+  "t": [4, 1],
+  "ed": [0.001, 0.0001]
+}
+```
+Hit has
+
+- "pos": position [mm]  (x, y, z),
+- "dim": box dimensions [mm] (dx, dy, dz),
+- "t": time information [ns] (time, err_time),
+- "ed": energy deposit with error [GeV] (edep, err_edep)
+

firebird-ng/src/app/app.config.ts

@@ -2,7 +2,7 @@ import {APP_INITIALIZER, ApplicationConfig, importProvidersFrom} from '@angular/
 import { provideRouter } from '@angular/router';
 import { routes } from './app.routes';
 import {provideAnimations} from "@angular/platform-browser/animations";
-import {FirebirdConfigService} from "./firebird-config.service";
+import {ServerConfigService} from "./server-config.service";
 import {provideHttpClient, withFetch} from "@angular/common/http";
 
 export const appConfig: ApplicationConfig = {
@@ -13,12 +13,12 @@ export const appConfig: ApplicationConfig = {
     {
       provide: APP_INITIALIZER,
       useFactory: configInitializer,
-      deps: [FirebirdConfigService],
+      deps: [ServerConfigService],
       multi: true
     }
   ]
 };
 
-export function configInitializer(configService: FirebirdConfigService): () => Promise<any> {
+export function configInitializer(configService: ServerConfigService): () => Promise<any> {
   return () => configService.loadConfig();
 }

firebird-ng/src/app/input-config/input-config.component.ts

@@ -14,7 +14,7 @@ import {MatAutocomplete, MatAutocompleteTrigger, MatOption} from "@angular/mater
 import {AsyncPipe, NgForOf} from "@angular/common";
 import {MatTooltip} from "@angular/material/tooltip";
 import {ResourceSelectComponent} from "../resource-select/resource-select.component";
-import {defaultFirebirdConfig, FirebirdConfig, FirebirdConfigService} from "../firebird-config.service";
+import {defaultFirebirdConfig, ServerConfig, ServerConfigService} from "../server-config.service";
 import {MatAccordion, MatExpansionPanel, MatExpansionPanelTitle, MatExpansionPanelHeader} from "@angular/material/expansion";
 
 
@@ -34,7 +34,7 @@ export class InputConfigComponent implements OnInit, AfterViewInit {
   serverUseApi: FormControl<boolean | null> = new FormControl(false);
   serverApiHost = new FormControl('localhost');
   serverApiPort: FormControl<number | null> = new FormControl(5454);
-  firebirdConfig: FirebirdConfig = defaultFirebirdConfig;
+  firebirdConfig: ServerConfig = defaultFirebirdConfig;
 
 
   @ViewChild('geometrySelect')
@@ -107,7 +107,7 @@ export class InputConfigComponent implements OnInit, AfterViewInit {
 
 
   constructor(private userConfigService: UserConfigService,
-              private firebirdConfigService: FirebirdConfigService) {
+              private firebirdConfigService: ServerConfigService) {
   }
 
 

firebird-ng/src/app/main-display/main-display.component.html

@@ -117,4 +117,4 @@
   <div style="color: darkgray">{{currentGeometry}}</div>
 </div>
 
-<div id="eventDisplay"></div>
+<div id="eventDisplay" ></div>

firebird-ng/src/app/main-display/main-display.component.scss

@@ -5,3 +5,7 @@
   padding-left: 13px;
   padding-right: 0;
 }
+
+#eventDisplay {
+  height: auto;
+}

firebird-ng/src/app/model/data-exchange.ts

@@ -0,0 +1,32 @@
+
+import {Entry} from "./entry";
+
+export class DataExchange  {
+
+  version: string = "0.01"
+  origin: any = {}
+  entries: Entry[] = []
+
+
+  toObj() {
+    let objEntries:any[] = [];
+    for(const entry of this.entries) {
+      objEntries.push(entry.toObj());
+    }
+    return {
+      version: this.version,
+      origin: this.origin,
+      entries: objEntries
+    }
+  }
+
+  static fromFirebirdEventObj(obj: any): DataExchange {
+    let result = new DataExchange();
+    result.version = obj["version"];
+    result.origin = obj["origin"];
+    for(const objEntry of obj["entries"]) {
+      result.entries.push(Entry.fromFirebirdEventObj(objEntry));
+    }
+    return result;
+  }
+}

firebird-ng/src/app/model/entry-component.ts

@@ -0,0 +1,16 @@
+export abstract class EntryComponent {
+
+  name: string;
+  type: string;
+  originType?: string;
+
+  constructor(name: string, type: string, originType?: string) {
+    this.name = name;
+    this.type = type;
+    this.originType = originType;
+  }
+
+  // Instance method to serialize the object
+  abstract toSpecialObject(): any;
+
+}

firebird-ng/src/app/model/entry.ts

@@ -0,0 +1,13 @@
+export class Entry
+{
+  id: string = "";
+  components: Component = [];
+
+  toObj() {
+    return {}
+  }
+
+  static fromFirebirdEventObj(obj: any): void {
+    throw new Error("Method not implemented.");
+  }
+}

firebird-ng/src/app/model/object-serializable.interface.ts

@@ -0,0 +1,14 @@
+
+export interface ToFirebirdObject {
+  /** Serialize to Firebird event object */
+  toObj():any;
+}
+
+export interface
+
+export function from(
+  ctor: IObjectSerializable,
+  data: any
+): ClockInterface {
+  return new ctor(hour, minute);
+}

firebird-ng/src/app/firebird-config.service.spec.ts → firebird-ng/src/app/server-config.service.spec.ts

@@ -1,18 +1,18 @@
 import { TestBed } from '@angular/core/testing';
 import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
-import { FirebirdConfigService } from './firebird-config.service';
+import { ServerConfigService } from './server-config.service';
 import * as jsoncParser from 'jsonc-parser';
 
 describe('FirebirdConfigService', () => {
-  let service: FirebirdConfigService;
+  let service: ServerConfigService;
   let httpMock: HttpTestingController;
 
   beforeEach(() => {
     TestBed.configureTestingModule({
       imports: [HttpClientTestingModule],
-      providers: [FirebirdConfigService]
+      providers: [ServerConfigService]
     });
-    service = TestBed.inject(FirebirdConfigService);
+    service = TestBed.inject(ServerConfigService);
     httpMock = TestBed.inject(HttpTestingController);
   });
 
@@ -50,14 +50,14 @@ describe('FirebirdConfigService', () => {
 
 // import { TestBed } from '@angular/core/testing';
 //
-// import { FirebirdConfigService } from './firebird-config.service';
+// import { ServerConfigService } from './firebird-config.service';
 //
-// describe('FirebirdConfigService', () => {
-//   let service: FirebirdConfigService;
+// describe('ServerConfigService', () => {
+//   let service: ServerConfigService;
 //
 //   beforeEach(() => {
 //     TestBed.configureTestingModule({});
-//     service = TestBed.inject(FirebirdConfigService);
+//     service = TestBed.inject(ServerConfigService);
 //   });
 //
 //   it('should be created', () => {

firebird-ng/src/app/firebird-config.service.ts → firebird-ng/src/app/server-config.service.ts

@@ -5,7 +5,7 @@ import {deepCopy} from "./utils/deep-copy";
 import {BehaviorSubject, Observable, catchError, map, of, firstValueFrom} from "rxjs";
 
 
-export interface FirebirdConfig {
+export interface ServerConfig {
   serverPort: number;
   serverHost: string;
   servedByPyrobird: boolean;
@@ -14,7 +14,7 @@ export interface FirebirdConfig {
   logLevel: string;
 }
 
-export const defaultFirebirdConfig: FirebirdConfig = {
+export const defaultFirebirdConfig: ServerConfig = {
   serverPort: 5454,
   serverHost: "localhost",
   apiAvailable: false,
@@ -27,15 +27,15 @@ export const defaultFirebirdConfig: FirebirdConfig = {
 @Injectable({
   providedIn: 'root'
 })
-export class FirebirdConfigService {
+export class ServerConfigService {
   private configUrl = 'assets/config.jsonc'; // URL to the JSONC config file
   private _config = deepCopy(defaultFirebirdConfig);
 
   private triedLoading = false;
 
   constructor(private http: HttpClient) {}
 
-  get config(): FirebirdConfig {
+  get config(): ServerConfig {
     if (!this.triedLoading) {
       this.triedLoading = true;
       console.error("Client called config while config is not loaded.")
@@ -61,7 +61,7 @@ export class FirebirdConfigService {
     }
   }
 
-  private parseConfig(jsoncData: string): Partial<FirebirdConfig> {
+  private parseConfig(jsoncData: string): Partial<ServerConfig> {
     try {
       return jsoncParser.parse(jsoncData);
     } catch (parseError) {
@@ -74,7 +74,7 @@ export class FirebirdConfigService {
    * Sets the configuration - intended for use in unit tests only.
    * This method is safeguarded to be operational only in non-production environments.
    */
-  public setUnitTestConfig(value: Partial<FirebirdConfig>) {
+  public setUnitTestConfig(value: Partial<ServerConfig>) {
     this.triedLoading = true;
     this._config = {...defaultFirebirdConfig, ...value};
   }

firebird-ng/src/app/url.service.spec.ts

@@ -2,13 +2,13 @@ import { TestBed } from '@angular/core/testing';
 
 import {resolveProtocolAlias, UrlService} from './url.service';
 import { UserConfigService } from './user-config.service';
-import { FirebirdConfigService } from './firebird-config.service';
+import { ServerConfigService } from './server-config.service';
 import {BehaviorSubject} from "rxjs";
 
 xdescribe('UrlService', () => {
   let service: UrlService;
   let userConfigService: jasmine.SpyObj<UserConfigService>;
-  let firebirdConfigService: jasmine.SpyObj<FirebirdConfigService>;
+  let firebirdConfigService: jasmine.SpyObj<ServerConfigService>;
 
   beforeEach(() => {
     const userConfigSpy = jasmine.createSpyObj('UserConfigService', ['localServerHost', 'localServerPort', 'localServerUseApi']);
@@ -22,12 +22,12 @@ xdescribe('UrlService', () => {
       providers: [
         UrlService,
         { provide: UserConfigService, useValue: userConfigSpy },
-        { provide: FirebirdConfigService, useValue: firebirdConfigSpy }
+        { provide: ServerConfigService, useValue: firebirdConfigSpy }
       ]
     });
 
     userConfigService = TestBed.inject(UserConfigService) as any;
-    firebirdConfigService = TestBed.inject(FirebirdConfigService) as any;
+    firebirdConfigService = TestBed.inject(ServerConfigService) as any;
     service = TestBed.inject(UrlService);
   });
 

firebird-ng/src/app/url.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
 import {UserConfigService} from "./user-config.service";
-import {FirebirdConfigService} from "./firebird-config.service";
+import {ServerConfigService} from "./server-config.service";
 
 let defaultProtocolAliases = [
   {"local://": "http://localhost/" },
@@ -60,7 +60,7 @@ export class UrlService {
 
 
   constructor(private userConfigService: UserConfigService,
-              private firebirdConfigService: FirebirdConfigService) {
+              private firebirdConfigService: ServerConfigService) {
 
     // Track user config changes
     this.userConfigService.localServerHost.subject.subscribe((value)=>{this.userConfigHost = value});

firebird-ng/src/app/user-config.service.ts

@@ -22,6 +22,5 @@ export class UserConfigService {
     this.localServerUseApi = new ConfigProperty("server.useApi", false);
     this.localServerHost = new ConfigProperty("server.host", "localhost");
     this.localServerPort = new ConfigProperty("server.port", 5454);
-
   }
 }

pyrobird/src/pyrobird/edm4eic.py

@@ -193,5 +193,5 @@ def edm4eic_to_dict(tree, entry_ids, origin_info=None):
         "origin": origin_info,
         "entries": entries_data
     }
-
+    
     return result