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

'TheoryDeepPixels.rst' first pass converson from latex #1104

Merged

Conversation

peterhillman
Copy link
Contributor

This needs another proofread. The equation numbers and references didn't get converted properly so they had to be recreated by hand. Some LaTeX math didn't render as expected so was changed.

Signed-off-by: Peter Hillman peterh@wetafx.co.nz

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>
@@ -0,0 +1,491 @@
======================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This renders properly so it's probably fine, but the other .rst sections are formatted with underlined #:

Theory of Deep Samples
####################

======================


This document derives the techniques for splitting and combining two non-solid samples of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make a reference to the Interpreting doc: Interpreting OpenEXR Deep Pixels_.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other cross-document links don't seem to work for me (e.g. the link from OpenEXRFileLayout to TechnicalIntroduction didn't work) but using :doc: seems OK

===========

- ratio of length of original sample to a subsample:
:math: 0\le r \le 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this isn't rendered properly, the ":math" appears in the output.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! The whole list hadn't converted from tex properly (it was missing the symbols that were being defined), so I switched everything to a table.

Subscripts :math:`_a` and :math:`_b` refer to the input samples;
subscript :math:`_c` refers to the combined output sample

Sample model
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be an Americanism, but the style used in the other docs is to capitalize all works in the section headers: "Sample Model".

@cary-ilm
Copy link
Member

This looks great, barring the few nits noted above. Also, the section title is "Theory of Deep Samples", but the file is called TheoryDeepPixels.rst. Probably better to make the names consistent. Thanks!

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>
@cary-ilm cary-ilm merged commit dfd319c into AcademySoftwareFoundation:master Jul 26, 2021
cary-ilm pushed a commit to cary-ilm/openexr that referenced this pull request Sep 23, 2021
…reFoundation#1104)

* 'TheoryDeepPixels.rst' first pass converson from latex

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>

* formatting and typo fixes in TheoryDeepPixels.rst

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>
cary-ilm pushed a commit that referenced this pull request Sep 29, 2021
* 'TheoryDeepPixels.rst' first pass converson from latex

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>

* formatting and typo fixes in TheoryDeepPixels.rst

Signed-off-by: Peter Hillman <peterh@wetafx.co.nz>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants