Save "cube summary" as a binary catalogue

[MatthewWhiting]

We currently write the detections out as scans to the end of the log file. It would be better to write these to a separate file, and perhaps in a binary format for better disk use.

This would also make the reading/writing of catalogues more transparent and easy to maintain - the reading part of it at the moment is a bit of a dogs breakfast!

Putting in 1.3 for the moment - will evaluate as we get closer to release.

[MatthewWhiting]

[1144] has the first part of this. The Object3D class now has functions to read and write to/from a binary file. The information that is written is the set of scans for each channel map, the z-value of the channel, as well as sizes of both the channel map list and each scan list.

This can now be adopted by the cube summary function, and then by the reading in as well.

[MatthewWhiting]

The cube summary function currently has the following:

• dimensions of cube
• threshold | middle | spread | robust
• each detection's scan list

What would be better would be to write out the entire parameter set, or at least those parameters that affect the actual set of detected pixels & objects. This way we can see all the correct flags, and read the stats in the appropriate fashion.

The parameters written need only be a subset of the full set - only those that have some bearing on which pixels are detected and how they are arranged into objects. The parameters written with the Param::getVOParams() function are a start, but we can lose a few: pixelCentre & restFrequency (only affect reporting of positions). I initially thought the beam info could be dropped, but this is needed for the FDR case. Perhaps only include if flagFDR=true.

One to be added is flagMW (with minMW/maxMW if necessary).

We would then write:

• Parameters
• Dimensions (possibly redundant if we give the subsection, but will included nonetheless)
• Stats: threshold OR snrCut | middle | spread GIVEN flagUserThreshold
• number of objects
• catalogue

[MatthewWhiting]

Actually, given that the threshold or snrCut are provided in the Param set, it will look like this:

• Parameters
• Dimensions (possibly redundant if we give the subsection, but will included nonetheless)
• Stats: middle & spread ONLY IF !flagUserThreshold
• number of objects
• catalogue

[MatthewWhiting]

This is largely done in [1146]. There are new functions for Cube to handle the reading and writing to/from the binary catalogue, and I've added the same for the Statistics class so that we just copy everything - this was simpler than trying to write out individual parameters.

Reading still controlled by the usePrevious parameter, but there are new parameters to switch on the writing, and to define the binary catalogue file.

All appears to work, but would like a little bit more testing to be confident. Documentation also needs updating.

[insumndrara]

<a href=></a>. . . <a href=></a>

[smalpassirL]

<a href=></a>. . . <a href=></a>

[MatthewWhiting]

[1157] adds the version number to the binary catalogue.

This is looking pretty good now, so closing this ticket.

[XRumerTest]

Hello. And Bye.