Skip to content

Commit 6c5b3b7

Browse files
committed
Address review feedback on documentation
- Remove Python bindings references (WIP, not fully functional) - Fix rawtoaces_core.rst: remove non-existent classes (CameraDatabase, IlluminantDatabase, database_paths), add actual functions - Elaborate on data path: mention CMAKE_INSTALL_PREFIX, Windows limitation - Add --data-dir command line parameter to environment setup - Fix illuminant docs: blackbody temperatures must be below 4000K Signed-off-by: pmady <[email protected]>
1 parent 7b21a08 commit 6c5b3b7

File tree

4 files changed

+17
-50
lines changed

4 files changed

+17
-50
lines changed

docs/api/rawtoaces_core.rst

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Overview
1414
The core library (``rawtoaces_core``) contains:
1515

1616
- Spectral solver for calculating IDT matrices from camera spectral sensitivities
17-
- Database management for camera data, illuminants, and training spectra
18-
- Color science utilities
17+
- Functions for calculating illuminant spectral power distributions
18+
- Color science utilities and matrices
1919

2020
SpectralSolver Class
2121
--------------------
@@ -25,24 +25,9 @@ SpectralSolver Class
2525
:protected-members:
2626
:undoc-members:
2727

28-
Database Classes
29-
----------------
30-
31-
CameraDatabase
32-
^^^^^^^^^^^^^^
33-
34-
.. doxygenclass:: rta::core::CameraDatabase
35-
:members:
36-
:undoc-members:
37-
38-
IlluminantDatabase
39-
^^^^^^^^^^^^^^^^^^
40-
41-
.. doxygenclass:: rta::core::IlluminantDatabase
42-
:members:
43-
:undoc-members:
44-
4528
Utility Functions
4629
-----------------
4730

48-
.. doxygenfunction:: rta::core::database_paths
31+
.. doxygenfunction:: rta::core::calculate_daylight_SPD
32+
33+
.. doxygenfunction:: rta::core::calculate_blackbody_SPD

docs/getting_started.rst

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,27 +27,23 @@ Build steps:
2727
make
2828
make install
2929
30-
Python Bindings
31-
^^^^^^^^^^^^^^^
32-
33-
If you want to use the Python bindings, ensure Python development headers are installed
34-
and enable the bindings during configuration:
35-
36-
.. code-block:: bash
37-
38-
cmake -DRTA_BUILD_PYTHON_BINDINGS=ON ..
39-
4030
Environment Setup
4131
-----------------
4232

4333
RAWtoACES needs access to camera spectral sensitivity data and other reference data.
4434
The data is automatically fetched during the build process and installed to
45-
``share/rawtoaces/data``.
35+
``<CMAKE_INSTALL_PREFIX>/share/rawtoaces/data`` on macOS and Linux.
36+
37+
.. note::
38+
39+
On Windows, the data files are not installed automatically. You will need to
40+
manually specify the data location.
4641

47-
You can override the data location using environment variables:
42+
You can override the data location using:
4843

49-
- ``RAWTOACES_DATA_PATH``: Primary path to search for data files
50-
- ``AMPAS_DATA_PATH``: Alternative path (for compatibility)
44+
- The ``--data-dir`` command line parameter
45+
- ``RAWTOACES_DATA_PATH`` environment variable: Primary path to search for data files
46+
- ``AMPAS_DATA_PATH`` environment variable: Alternative path (for compatibility)
5147

5248
Basic Usage
5349
-----------

docs/index.rst

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ RAWtoACES Documentation
22
=======================
33

44
RAWtoACES is a tool for converting RAW camera images to ACES (Academy Color Encoding System) format.
5-
It provides both a command-line utility and C++/Python libraries for integration into other applications.
5+
It provides both a command-line utility and a C++ library for integration into other applications.
66

77
.. toctree::
88
:maxdepth: 2
@@ -20,7 +20,6 @@ Features
2020
- Multiple white balance methods: metadata, illuminant, box averaging, or custom
2121
- Multiple matrix methods: spectral (using camera sensitivity data), metadata, Adobe, or custom
2222
- Flexible cropping options
23-
- Python bindings for scripting and integration
2423
- Batch processing support
2524

2625
Quick Start
@@ -53,19 +52,6 @@ Library Usage (C++)
5352
5453
bool success = converter.process_image("input.dng");
5554
56-
Library Usage (Python)
57-
^^^^^^^^^^^^^^^^^^^^^^
58-
59-
.. code-block:: python
60-
61-
import rawtoaces
62-
63-
converter = rawtoaces.ImageConverter()
64-
converter.settings.WB_method = rawtoaces.WBMethod.Metadata
65-
converter.settings.matrix_method = rawtoaces.MatrixMethod.Auto
66-
67-
success = converter.process_image("input.dng")
68-
6955
Indices and tables
7056
==================
7157

docs/user_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ White Balance Options
2828
``--illuminant <name>``
2929
Specify the illuminant for white balancing. Can be:
3030

31-
- A color temperature (e.g., ``3200K``, ``5600K``)
31+
- A blackbody color temperature below 4000K (e.g., ``2800K``, ``3200K``)
3232
- A D-series illuminant (e.g., ``D50``, ``D55``, ``D65``)
3333
- Any illuminant name present in the data folder
3434

0 commit comments

Comments
 (0)