Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log file with each acquisition. #179

Open
iandobbie opened this issue Jan 15, 2016 · 6 comments
Open

Log file with each acquisition. #179

iandobbie opened this issue Jan 15, 2016 · 6 comments
Labels
enhancement New feature request including performance improvements.

Comments

@iandobbie
Copy link
Collaborator

We should dump a text logfile detailing information about each acquired image file. Softworx does this and it is extremely useful. Filename should be as the image file but with .log extension.

@iandobbie iandobbie added the enhancement New feature request including performance improvements. label Jan 15, 2016
@carandraug
Copy link
Collaborator

Instead of just a log file that is difficult to parse automatically, a more interesting solution would be to dump a ome xml file. This would also solve the limits we have on the standard mrc base header.

An even more interesting approach, is to store such ome xml file in the extended header.

@iandobbie
Copy link
Collaborator Author

Carnë Draug notifications@github.com writes:

Instead of just a log file that is difficult to parse automatically, a
more interesting solution would be to dump a ome xml file. This would
also solve the limits we have on the standard mrc base header.

The log is for humans, software should read the image file metadata. I
hate XML log type files because they are so awkward for a human to
parse.

An even more interesting approach, is to store such ome xml file in
the extended header.

Good idea, this solves the software version but it is also nice to have
a readable log with descriptive data.

Ian

@carandraug
Copy link
Collaborator

Ian Dobbie notifications@github.com writes:

Carnë Draug notifications@github.com writes:

Instead of just a log file that is difficult to parse automatically, a
more interesting solution would be to dump a ome xml file. This would
also solve the limits we have on the standard mrc base header.

The log is for humans, software should read the image file metadata. I
hate XML log type files because they are so awkward for a human to
parse.

That's because a human shouldn't be parsing it. An application should
be reading and displaying it in a human readable form. For example,
html. You can read it on a pager but you probably should be using a
web browser. Same for a svg file which is actually a xml.

Just like you can get details from a png or jpeg, you don't need a separate
log in a text file, we should be able to do the same for mrc files. Our
needs a bit more scientific than the information in a typical jpeg. Still,
there is bioformats command line tools showinf which prints the metadata
to stdout (but that also opens a quick display of the image).

I think having to use something specific to get that information instead
of just a pager beats having to keep a pair of files together all the time.

An even more interesting approach, is to store such ome xml file in
the extended header.

Good idea, this solves the software version but it is also nice to have
a readable log with descriptive data.

@juliomateoslangerak
Copy link
Contributor

Hi,

I do agree with Ian on the practical side of the log file. On my experience, on the OMX I find users and my self reading the log file very often. The usual scenario is you find your good image, open the corresponding log file and check settings, to compare, apply, etc.

We use OMERO to store the images, and it does not show all the necessary acquisition parameters. We just click in companion file and view. Boom. You get all relevant information.

I do agree that all this information should be stored in a structured way in the image file, but I do not see the conflict in duplicating thsi info in a xml header AND in a log file…

Cheers, Julio

@carandraug
Copy link
Collaborator

I do agree that all this information should be stored in a structured way in the image file, but I do not see the conflict in duplicating thsi info in a xml header AND in a log file…

Because if you have the data duplicated, then you need to worry about keeping
them in sync. You can't automate keeping them in sync because the log files
are not machine readable. And if you accept that it's ok to have them out
of sync, because you know which one will always be right, then you don't need
the other in the first place.

@iandobbie
Copy link
Collaborator Author

Also needs to store laser powers and camera acquisition parameters, Pointed out by Cvic and Sebastian today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature request including performance improvements.
Projects
None yet
Development

No branches or pull requests

3 participants