[Insight-users] problems running and incoherent documentation in Chan-Vese segmentation examples

[Juan Cardelino]

By the format I mean that I would like to see an example page like as follows:

*title: example of blah blah
*description: more blah blah saying what the example does
*code:
**link to download the code or directly pasted on the page
***example of use of the code (command line args, etc)
*input images:
*results:

you can see an example of this here:
http://iie.fing.edu.uy/rs/wiki/ContributedCode:ITKChanVese#Example_03:_Example_images_provides_in_the_IJ_submission_3



On Wed, May 11, 2011 at 11:36 AM, Bill Lorensen <bill.lorensen at gmail.com> wrote:
> The wiki examples are scrapped and checked into the git repo.
>
> As for the format, I'm not sure what you mean. The wiki examples are usually
> short illustrating a single concept. But longer examples are OK if they
> follow the same formatting.
>
> On Wed, May 11, 2011 at 7:57 AM, Juan Cardelino <juan.cardelino at gmail.com>
> wrote:
>>
>> Thanks for the answer guys. I know it takes work, but I think examples
>> of the quality of those in the software guide (or the IJ) are a
>> valuable resource for learning. And I feel it is a pity that they are
>> somehow frozen. In particular, I will I could take the Chan Vese
>> submission, get the source (easily) and update it or re-submit it. You
>> can't rely on the original authors for that, because as we all do,
>> they are probably working in other stuff at the moment and don't have
>> time to update their code.
>> The wiki format could make the update easier, but I think the
>> presentation quality will be lower than the papers on the IJ. At least
>> that's what my experiments with mediawiki show.
>> I have a few questions still open:
>> * whats the link between the gitorious examples and the wiki? if one
>> updates git it reflects on wiki or the other way round?
>> *do you guys want to have the wiki examples in the current format? I
>> mean, plain code pasted in a page? Do you see room for examples like
>> those I made? If there is, where should they go?
>> Thanks again for the great work, ITK is great!
>> Best regards,
>>                 Juan
>>
>> On Tue, May 10, 2011 at 5:08 PM, robert tamburo
>> <robert.tamburo at gmail.com> wrote:
>> > Fair enough. Understandable. I think it's also understandable that a ~6
>> > year
>> > old reference document might frustrate/deter new/old
>> > users/developers. Perhaps the guide is an antiquated form of
>> > documentation
>> > (without dedicated resources for updates) and should be abandoned, or
>> > the
>> > model for updating the Software Guide should be revisited. I recall the
>> > Software Guide being 'doxygenated'. Should the downloadable PDF be
>> > updated
>> > to at least reflect changes in functions, variables, code snippets,
>> > comments, etc?
>> > On Tue, May 10, 2011 at 1:37 PM, Bill Lorensen <bill.lorensen at gmail.com>
>> > wrote:
>> >>
>> >> It is the same response. It takes a lot of work to update the book.
>> >> Especially with a changing toolkit.
>> >>
>> >> On Tue, May 10, 2011 at 12:34 PM, robert tamburo
>> >> <robert.tamburo at gmail.com> wrote:
>> >>>
>> >>> I think Juan was referring to the downloadable Software Guide.
>> >>>
>> >>> On Tue, May 10, 2011 at 12:06 PM, Bill Lorensen
>> >>> <bill.lorensen at gmail.com>
>> >>> wrote:
>> >>>>
>> >>>> Juan,
>> >>>>
>> >>>> In general, we don't want to duplicate examples in the ITK
>> >>>> distribution
>> >>>> and the ITK wiki. Wiki examples are intended to be simple examples
>> >>>> that
>> >>>> illustrate a single concept. Also, the user community can contribute
>> >>>> wiki
>> >>>> examples with minimal effort. There have been exceptions I guess.
>> >>>>
>> >>>> As for the book, my guess is that it takes a lot of work to update
>> >>>> the
>> >>>> book and that's why it has not been updated for a while. I don't
>> >>>> think it
>> >>>> has to do with book sales.
>> >>>>
>> >>>> Bill
>> >>>>
>> >>>>
>> >>>> _____________________________________
>> >>>> Powered by www.kitware.com
>> >>>>
>> >>>> Visit other Kitware open-source projects at
>> >>>> http://www.kitware.com/opensource/opensource.html
>> >>>>
>> >>>> Kitware offers ITK Training Courses, for more information visit:
>> >>>> http://www.kitware.com/products/protraining.html
>> >>>>
>> >>>> Please keep messages on-topic and check the ITK FAQ at:
>> >>>> http://www.itk.org/Wiki/ITK_FAQ
>> >>>>
>> >>>> Follow this link to subscribe/unsubscribe:
>> >>>> http://www.itk.org/mailman/listinfo/insight-users
>> >>>>
>> >>>
>> >>
>> >
>> >
>> _____________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Kitware offers ITK Training Courses, for more information visit:
>> http://www.kitware.com/products/protraining.html
>>
>> Please keep messages on-topic and check the ITK FAQ at:
>> http://www.itk.org/Wiki/ITK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.itk.org/mailman/listinfo/insight-users
>
>