bugGNU Octave - Bugs: bug #56451, [octave forge] (image) imsmooth,...

 
 

bug #56451: [octave forge] (image) imsmooth, Gaussian third parameter

Submitted by:  PIERRE LABRECHE <pierre5018>
Submitted on:  Thu 06 Jun 2019 04:56:53 PM UTC  
 
Category:  Octave Forge Package Severity:  2 - Minor
Priority:  3 - Low Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  pierre5018 Open/Closed:  Closed
Release:  dev Operating System:  Any

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Fri 02 Aug 2019 07:04:26 PM UTC, comment #9: 

I have now pushed the proposed change to the stable branch. Thank you all for the report and improvement.

On the topic of commit messages, for commits that address the documentation only, the commit message should start with 'doc: '

Closing as fixed

Carnë Draug <carandraug>
Project Member
Thu 18 Jul 2019 11:16:24 AM UTC, comment #8: 

Thanks for this patch, Avinoam.

I had a closer look at your patch from comment #7. To me it looks totally FINE. It makes the doc string of imsmooth more logical and readable. I think this should fully solve the original request. The (single) test in imsmooth.m also still passes.

Maybe you could improve the formatting of the changeset's commit message to something like "imsmooth.m: slight improvement of the documentation (bug #56451)"

I would suggest to commit this patch, then. Even to the stable branch, since it only improves a doc string.

Hartmut <hardy>
Sat 13 Jul 2019 04:50:38 PM UTC, comment #7: 

Please review the attached changeset

(file #47210)

Avinoam Kalma <avinoam>
Project Member
Mon 01 Jul 2019 03:50:45 AM UTC, comment #6: 

Adding package maintainers

Avinoam Kalma <avinoam>
Project Member
Thu 06 Jun 2019 08:39:09 PM UTC, comment #5: 

Thanks. It looks to me like you're suggesting that the headings for the full documentation sections should use the same names as the option strings. If you would like to help the image package maintainers, the best way forward would be to provide a patch that makes the changes that you think would help.

Mike Miller <mtmiller>
Project Administrator
Thu 06 Jun 2019 07:53:35 PM UTC, comment #4: 

Yes it clarifies.  I was confused by the double nomenclature "Gaussian" and "Isotropic Gaussian smoothing " ; at first sight, they appeared like different things.

I suggest the documentation keeps the same nomenclature as the option.

PIERRE LABRECHE <pierre5018>
Thu 06 Jun 2019 07:39:57 PM UTC, comment #3: 

Further down in the documentation is the following

Isotropic Gaussian smoothing

>  The image is convolved with a Gaussian filter with spread sigma. By default sigma is 0.5, but this can be changed. If the third input argument is a scalar it is used as the filter spread.

>  The image is extrapolated symmetrically before the convolution operation.


Does that description take care of this? Can you suggest further improvements to the function doc string?

Mike Miller <mtmiller>
Project Administrator
Thu 06 Jun 2019 07:24:41 PM UTC, comment #2: 

There is no description of the third parameter in the documentation.

https://octave.sourceforge.io/image/function/imsmooth.html

Function File: J = imsmooth(I, name, options)
Smooth the given image using several different algorithms.

The first input argument I is the image to be smoothed. If it is an RGB image, each color plane is treated separately. The variable name must be a string that determines which algorithm will be used in the smoothing. It can be any of the following strings

"Gaussian"
Isotropic Gaussian smoothing. This is the default.

PIERRE LABRECHE <pierre5018>
Thu 06 Jun 2019 06:40:42 PM UTC, comment #1: 

Thank you for your bug report. Can you describe more clearly what the bug is that you are describing? Is it that the documentation is not clear enough? Is there a specific example you can give that does not work?

Mike Miller <mtmiller>
Project Administrator
Thu 06 Jun 2019 04:56:53 PM UTC, original submission:  

missing function for third parameter
"third input argument must be a positive scalar when performing Gaussian smoothing"
what is the purpose of the third parameter ?

PIERRE LABRECHE <pierre5018>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

Attached Files
file #47210:  imsmooth.cs added by avinoam (3KiB - text/plain)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by hardy (Posted a comment)
  • -email is unavailable- added by avinoam (Posted a comment)
  • -email is unavailable- added by avinoam
  • -email is unavailable- added by avinoam
  • -email is unavailable- added by pierre5018 (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 13 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-08-02 carandraug Open/ClosedOpen => Closed
    2019-08-02 carandraug StatusPatch Submitted => Fixed
    2019-07-13 avinoam Attached File- => Added imsmooth.cs, #47210
        StatusNeed Info => Patch Submitted
    2019-07-01 avinoam Carbon-Copy- => Added carandraug
        Carbon-Copy- => Added hardy
    2019-06-06 mtmiller Severity3 - Normal => 2 - Minor
        Priority5 - Normal => 3 - Low
        Release4.4.1 => dev
        Operating SystemMicrosoft Windows => Any
    2019-06-06 mtmiller CategoryOctave Function => Octave Forge Package
        StatusNone => Need Info
        Summaryimsmooth, Gaussian third parameter => [octave forge] (image) imsmooth, Gaussian third parameter

    Back to the top


    Powered by Savane 3.5