RFC: Renaming of SlicerSegmentEditorExtraEffects extension

segmentation

(Jean Christophe Fillion Robin) #1

Sharing here a suggestion from @hherhold:

Segment Editor Extra Effects could probably be renamed Segment Editor Essential Effects

See https://github.com/lassoan/SlicerSegmentEditorExtraEffects


(Andras Lasso) #2

Essential effects are bundled with Slicer. These are experimental effects - not fully tested or optimized. So, if we changed the name then it should reflect that. Also, a new name must be much better than the previous name to justify all the complications the renaming causes (people cannot find extensions, instructions on Slicer forum becomes obsolete that refer to the old name, extension dependencies break, etc.).


(Csaba Pinter) #3

Exactly. The extension contains very useful but supplementary (and not as tested) effects. I don’t even understand how “essential” would be a good descriptor for those effects. Do you know Jc what is the idea behind it?


(Hollister Herhold) #4

It just came from a blog post I’m writing up on the use of Slicer in entomology. I use the Editor Extra Effects, and just as an aside commented that they’re really more “Essential” than extra - I didn’t mean to open up a can of worms!


(Jean Christophe Fillion Robin) #5

I didn’t mean to open up a can of worms!

Ooop. I take the blame on opening the can then :smile:

Anyway I think the comments of @lassoan are general and will be useful in the future.


(Csaba Pinter) #6

In this sense I agree with you - that some of them are really necessary. I always install it. Maybe instead of renaming it we should move some of them to core?

Not at all.


(Andras Lasso) #7

Yes extra effects that prove to be widely useful and become stable enough should get into the core. The advantage of having work-in-progress effects in an extension is that it is easier to deliver fixes and improvements, even to the stable version of Slicer.


(Andrey Fedorov) #8

@jcfr @hherhold maybe the original request should instead be reformulated into something like “RFC: move effects X Y and Z from SegmentEditorExtraEffects to the core”.


(Murat Maga) #9

I find these ‘extra’ effects very useful too. My suggestion is to include them as part of the core segment editor, and have a little button that reads 'Enable experimental effects" with additional acknowledgement that they are not as stable as the core effects. And gradually move them into ‘core’ functionality as they become more mature…


(Andras Lasso) #10

There are some open issues with each of these effects that would need to be addressed before moving. Once an effect is in the Slicer core, it is harder to fix and improve (especially in stable builds).

Some of them are close to be ready, for example Mask volume effect could be moved after the issues listed here are resolved: https://github.com/lassoan/SlicerSegmentEditorExtraEffects/issues/10. As always, contributions are welcome: if someone can implement these and send a pull request then it could get into the Slicer core within a few days.


(Steve Pieper) #11

Yes, or leave them as an extension but make them easy to install (and update) from within the Segment Editor.


(James Butler) #12

I agree there still needs to be an extension to install experimental effects to quickly fix issues.

It’s seems like part of the root issue is that the visibility of the extensions manager isn’t clear enough for users and users think segment editor effects are missing. So then they want these effects in core instead.

I don’t think installing extensions is an inconvenience and is a good way to prevent bloat in core. At least preview builds have the ability to quickly reinstall extensions from a previous install.

Ideas:

  • Package SegmentEditorExtraEffects as an already installed extension for Slicer preview builds.
  • Add a button within the Segment Editor widget to “install experimental effects” which would install the extension without going through the extensions manager.