TubeTK/Developers FAQ: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
Line 1: Line 1:
= How do I enter equations in the Wiki? =


= Use Compression =
* [http://en.wikipedia.org/wiki/Math_markup Math formula editing in Wiki]
* [http://en.wikipedia.org/wiki/Wikipedia:FAQ/Editing General Wiki Editing FAQ]
 
= How do I do coverage and profiling on linux? =
 
* Coverage Measurement and Profiling
** http://www.linuxjournal.com/node/6758/print
 
= How do I write compressed images? =


ITK, regretfully, doesn't write compressed images by default.  You must add one line to your code, to write compressed images:
ITK, regretfully, doesn't write compressed images by default.  You must add one line to your code, to write compressed images:


    typename ImageWriterType::Pointer writer = ImageWriterType::New();
<code>
    writer->SetFileName( outputVolume.c_str() );
typename ImageWriterType::Pointer writer = ImageWriterType::New();
    writer->SetInput( cropFilter.GetOutput() );
writer->SetFileName( outputVolume.c_str() );
    writer->SetUseCompression( true );                            // ADD THIS LINE
writer->SetInput( cropFilter.GetOutput() );
writer->SetUseCompression( true );                            // ADD THIS LINE
</code>


= Use Compression 2 =
= What should I know about storing testing data? =


Please store images in TubeTK/Data in a compressed format.
== Input Images ==


= Baseline images =
* Store input images in TubeTK/Data
* Store all images in a compressed format.
* Don't put baseline images in TubeTK/Data.


Baseline images should be stored with their tests.  We'd like to keep TubeTK's modules as portable and self-contained as possible.  We'll share input data by placing it in TubeTK/Data, but data specific to a particular test (e.g., baseline images) should be stored with the test.  We've decided on the filesystem hierarchy
== Test Baseline Images ==
 
* Baseline images should be stored with their tests.  We'd like to keep TubeTK's modules as portable and self-contained as possible.  We'll share input data by placing it in TubeTK/Data, but data specific to a particular test (e.g., baseline images) should be stored with the test.  We've decided on the filesystem hierarchy
  TubeTK/Applications/CLI/<myprogram>/Testing/Baselines  
  TubeTK/Applications/CLI/<myprogram>/Testing/Baselines  
for storing the baseline images for the tests for myprogram.
for storing the baseline images for the tests for myprogram.
 
* Don't put baseline images in TubeTK/Data.
In particular, don't put baseline images in TubeTK/Data.

Revision as of 20:06, 7 November 2010

How do I enter equations in the Wiki?

How do I do coverage and profiling on linux?

How do I write compressed images?

ITK, regretfully, doesn't write compressed images by default. You must add one line to your code, to write compressed images:

typename ImageWriterType::Pointer writer = ImageWriterType::New(); writer->SetFileName( outputVolume.c_str() ); writer->SetInput( cropFilter.GetOutput() ); writer->SetUseCompression( true ); // ADD THIS LINE

What should I know about storing testing data?

Input Images

  • Store input images in TubeTK/Data
  • Store all images in a compressed format.
  • Don't put baseline images in TubeTK/Data.

Test Baseline Images

  • Baseline images should be stored with their tests. We'd like to keep TubeTK's modules as portable and self-contained as possible. We'll share input data by placing it in TubeTK/Data, but data specific to a particular test (e.g., baseline images) should be stored with the test. We've decided on the filesystem hierarchy
TubeTK/Applications/CLI/<myprogram>/Testing/Baselines 

for storing the baseline images for the tests for myprogram.

  • Don't put baseline images in TubeTK/Data.