Add Box Seeding Documentation to Segmentation Parameter Docs

[freemansw1]

Resolves #399 and adds box seeding to our documentation for segmentation parameters.

Worked on with @RBhupi during the tobathon 2024

• Have you followed our guidelines in CONTRIBUTING.md?
• Have you self-reviewed your code and corrected any misspellings?
• Have you written documentation that is easy to understand?
• Have you written descriptive commit messages?
• Have you added NumPy docstrings for newly added functions?
• Have you formatted your code using black?
• If you have introduced a new functionality, have you added adequate unit tests?
• Have all tests passed in your local clone?
• If you have introduced a new functionality, have you added an example notebook?
• Have you kept your pull request small and limited so that it is easy to review?
• Have the newest changes from this branch been merged?

[freemansw1]

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

[github-actions]

Linting results by Pylint:

Your code has been rated at 8.72/10 (previous run: 8.72/10, +0.00)
_{The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the tobathon branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ed4c4bf) 56.91% compared to head (333778b) 56.91%.

Additional details and impacted files

@@            Coverage Diff            @@
##           tobathon     #406   +/-   ##
=========================================
  Coverage     56.91%   56.91%           
=========================================
  Files            20       20           
  Lines          3440     3440           
=========================================
  Hits           1958     1958           
  Misses         1482     1482           

Flag	Coverage Δ
unittests	56.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[harrietgilmour]

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

Yes no problem. I can do it next week

[freemansw1]

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

Yes no problem. I can do it next week

Thanks! Trying to be more deliberate with our review requests.

[harrietgilmour]

All looks good - clear and concise. Just added a comment to add in a missing "an" but this is very minor.

[w-k-jones]

Looks good, we might want to consider reorganising this a bit in future to add more examples and stop the article from getting too text heavy, but I think it's better to get it published as is

[w-k-jones]

Also the docstring are wrongly formatted for seed_3D_flag in segmentation.py which is causing the API reference to render incorrectly. I can fix that quickly and add it to this PR

[freemansw1]

Thanks @w-k-jones @harrietgilmour !

@w-k-jones what is our policy on documentation-only PRs? We can merge these right into main, right?

[w-k-jones]

Thanks @w-k-jones @harrietgilmour !

@w-k-jones what is our policy on documentation-only PRs? We can merge these right into main, right?

Yes, looks like there's no issues with merging into main so I'm happy for you to do that directly