Skip to content

Fixes tutorial broken by refactors #41

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.

Sign up for GitHub

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

Merged
alexhroom merged 4 commits into from
Apr 2, 2025
Merged

Fixes tutorial broken by refactors #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
04f023c
changed background display method
alexhroom Mar 27, 2025
711425a
not a typo
alexhroom Mar 27, 2025
8c7180b
fix `displayResolutionsObject`
alexhroom Mar 31, 2025
374be38
comment out target functions
alexhroom Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 26 additions & 24 deletions source/reference/matlab/targetFunctions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,39 @@
================================
Target Functions (Low Level API)
================================
.. default-domain:: mat
.. automodule:: targetFunctions
:members:

.. _CommonFunctions:
..
.. default-domain:: mat
.. automodule:: targetFunctions
:members:

Common Functions
----------------
.. automodule:: targetFunctions.common
:members:
.. _CommonFunctions:

.. automodule:: targetFunctions.common.costFunctions
:members:
Common Functions
----------------
.. automodule:: targetFunctions.common
:members:

.. automodule:: targetFunctions.common.groupLayers
:members:
.. automodule:: targetFunctions.common.costFunctions
:members:

.. _normalTF:
.. automodule:: targetFunctions.common.groupLayers
:members:

Normal Target Functions (normalTF)
.. _normalTF:

.. automodule:: targetFunctions.+normalTF.+customLayers
:members:
Normal Target Functions (normalTF)

.. automodule:: targetFunctions.+normalTF.+customXY
:members:
.. automodule:: targetFunctions.+normalTF.+customLayers
:members:

Domains Target Functions (domainsTF)
------------------------------------
.. automodule:: targetFunctions.+domainsTF.+customLayers
:members:
.. automodule:: targetFunctions.+normalTF.+customXY
:members:

.. automodule:: targetFunctions.+domainsTF.+customXY
:members:
Domains Target Functions (domainsTF)
------------------------------------
.. automodule:: targetFunctions.+domainsTF.+customLayers
:members:

.. automodule:: targetFunctions.+domainsTF.+customXY
:members:
12 changes: 6 additions & 6 deletions source/tutorial/project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ The ``backgrounds`` block is used to define the type of background applied to ea

.. output:: Matlab

problem.background.displayBackgroundsObject()
problem.background.displayTable()

.. tab-item:: Python
:sync: Python
Expand All @@ -695,7 +695,7 @@ The backgrounds can be one of three types: ``"constant"``, ``"function"`` or ``"
.. code-block:: Python

problem.background_parameters.append(name='My New BackPar', min=1e-8, value=1e-7, max=1e-6, fit=True)
problem.backgrounds.append(name='My New Background', type='constant', source='My New BackPar')
problem.background.append(name='My New Background', type='constant', source='My New BackPar')


With this code snippet we've made a new background, with the value taken from the (fittable) parameter called 'My New BackPar':
Expand All @@ -711,7 +711,7 @@ With this code snippet we've made a new background, with the value taken from th

problem.addBackgroundParam('My New BackPar', 1e-8, 1e-7, 1e-6, true);
problem.addBackground('My New Background','constant','My New BackPar');
problem.background.displayBackgroundsObject()
problem.background.displayTable()

.. tab-item:: Python
:sync: Python
Expand Down Expand Up @@ -747,7 +747,7 @@ This is then available to be used by any of our contrasts (see later).
.. .. output:: Matlab

.. problem.addBackground('Data Background 1', 'data', 'My Background Data')
.. problem.background.displayBackgroundsObject()
.. problem.background.displayTable()

.. .. tab-item:: Python
.. :sync: Python
Expand Down Expand Up @@ -797,7 +797,7 @@ To define a resolution parameter, we use the following methods:

.. output:: Matlab

problem.resolution.displayResolutionsObject()
problem.resolution.displayTable()

.. tab-item:: Python
:sync: Python
Expand Down Expand Up @@ -833,7 +833,7 @@ Then, we make the actual resolution referring to whichever one of the resolution
problem.addResolutionParam('My Resolution Param', 0.02, 0.05, 0.08, true);
problem.addResolution('My new resolution','constant','My Resolution Param');
problem.addResolution('My Data Resolution','data');
problem.resolution.displayResolutionsObject()
problem.resolution.displayTable()

.. tab-item:: Python
:sync: Python
Expand Down