user documentation on sqw_op and sqw_op_bin_pixels
#1891
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…op` description
…onal comments to PageOp_sqw(op) family of classes
# Conflicts: # horace_core/sqw/page_operations/PageOp_sqw_binning.m
…it tests for it but found out that it is not ready for deployments
…ine` option
…except sample script.
…race into 1844_sqw_op_and_bin_doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is part of the ticket #1844 which provides initial user documentation for 3 algorithms used to modify
sqwobject.This does not close the ticket as developer documentation is due and some polishing of the code is also necessary so ticket remains open.
Despite this, this is more or less completed piece of user documentation which worth considering separately.
The polishing here includes the beginning of the future work related to accessing pixels by page number only. Different size pages should be implemented by setting up internal pixels cache. The work is necessary for a) future mexing of the access to pixels using separate thread + simple user interface to
PageOpobjects as currently these objects use mixture of common and special interfaces for differentPageOpoperations so the meaning of an operation is not entirely clear if you just glance the page code.There are some preliminary steps done in direction of making pixel data accessible by variable pages + attempt to generalize user interface.
The compiled version of the documentation is available at
https://abuts.github.io/Horace/v4.1.0/manual/Generic_Transformation.html#generic-transformations