/specs desciption #7
Description
update 29dfebe
| Name | Description | Ways to interact | Reason | Example |
|---|---|---|---|---|
| /fps | float. number, reflects the overall fps (after potential downsampling on the way). Mostly for convenience. Sort-of bad that when downsampling two variables should be changed | Set automatically when the movie is converted to .h5 to and averaged fps during the recording (from timestaps), to get the value use specs.getFps() , it will also account for timebinning property | To be sure what is the absolute timing for the recording in the current file | 100.4 |
| /timebinnig | int(?). Temporal downsampling (relative to camera recording) | To add binning use specs.AddBinningTime(n) . | Combined with /timeorigin provides a way to track the time position if the part of the recording in the current file relative to original recording | 1 |
| /timeorigin | int. First frame number (in the raw camera recording frames numbering) of the part of the movie in the current file | Set automatically to the first converted frame when the movie is converted to .h5. To add delay use specs.AddFrameDelay(nframes) . | Combined with /timebinnig provides a way to track the time position if the part of the recording in the current file relative to original recording | 3000 |
| /pixsize | float. Size of current pixel in mm. | Set automatically to 8/2048 = 0.0039 mm (BFM FOV size over the full camera resolution) when the movie is converted to .h5 , to get the value use specs.getPixSize() , it will also account for binning property | Knowledge of the absolute spatial scale | 0.0039 |
| /binning | float(?). Spatial downsampling (relative to raw camera recording). | Set automatically to (software binning) x (hardware binning) during the conversion to .h5, can be changed using specs.AddBinning(n) . | Combined with /spaceorigin provides a way to track the position of the part of the FOV in the current file relative to original recording; likely be useful for brain region alignment. | 8,8 |
| /spaceorigin | [int, int]. Origin (up-left corner) of the part of the FOV in the current file in the raw camera recording pixel coordinates. | To add cropping use specs.AddSpatialCropping(p) . To get values appropriate for the current binning, use specs.getSpaceOrigin() . | Combined with /spacebinning provides a way to track the position of the part of the FOV in the current file relative to original recording; likely useful for brain region alignment. | 0,0 |
| /sourcePath | char array. Path to the original .dcimg recording | Set automatically when the movie is converted to .h5 | To know where the data comes from | 'Q:\GEVI_Wave\Raw\Anesthesia\m11\20201013\meas02\m11_d201013_s02_--fps118-cG.dcimg' |
| /history | Char array; string with a fixed separator (;) that lists major processing steps that happened the file | To add processing step, use specs.AddToHistory(new_entry) | Makes the processing steps tractable for every file, no need for complicated, unclear and inconsistent file naming | 'convertRaw2Preproc1;regMovies;mocoMovies' |
| /history_params | Char array; json-formatted string where every /history step has a corresponding entry with all the parameters of the high-level (file) function call. | Added together with a processing step specs.AddToHistory(new_entry, params) (or specs.AddToHistory(struct('functionname', params)) ) For back compatibility, if the field is absent in the file read, it will be added with params_not_saved = true and no parameters listed. It is convenient to use functionCallStruct(…) to generate struct to pass. | To be able to recover all the processing steps | '[{"001:convertRaw2Preproc1":{}}, {"002:regMovies":{}}]' |
| /extra_specs | ||||
| /extra_specs/allenMapEdgeOutline | ||||
| /extra_specs/mask | ||||
| /extra_specs/timestamps_table | ||||
| /extra_specs/frange_valid |