VTK - Revision history

Yingzhu: Yingzhu moved page Creating VTK Classes to VTK

2021-01-21T18:06:41Z

Yingzhu moved page Creating VTK Classes to VTK

← Older revision	Revision as of 18:06, 21 January 2021
(No difference)

Yingzhu: /* Tips */

2021-01-21T18:06:30Z

Tips

← Older revision		Revision as of 18:06, 21 January 2021
Line 1:		Line 1:
	==~~Tips~~==		==Creating VTK Classes==

	===Generic C++ Tips===		===Generic C++ Tips===

Enodwell: /* Comments moved to header file */

2010-05-11T20:09:10Z

Comments moved to header file

← Older revision		Revision as of 20:09, 11 May 2010
Line 65:		Line 65:
	====Comments moved to header file====		====Comments moved to header file====

	The comments at the top of the file about what it does and who wrote it and why, get moved from the .cxx file to the .h file (see [[C++Development#Put_comments_in_the_appropriate_place]]). (By the way, some of these comments used Doxygen style markers. But Doxygen parses only header files.)		The comments at the top of the file about what it does and who wrote it and why, get moved from the .cxx file to the .h file (see [[C++ Development#Put_comments_in_the_appropriate_place]]). (By the way, some of these comments used Doxygen style markers. But Doxygen parses only header files.)

	====Added Doxygen style comments to all methods====		====Added Doxygen style comments to all methods====

Enodwell: /* =Manually parsing command line parameters replaced with boost::program_options */

2010-05-11T17:29:49Z

=Manually parsing command line parameters replaced with boost::program_options

← Older revision		Revision as of 17:29, 11 May 2010
Line 107:		Line 107:
	vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.		vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.

	====Manually parsing command line parameters replaced with boost::program_options===		====Manually parsing command line parameters replaced with boost::program_options====

	Parsing command line options is a standard wheel that should not be reinvented. It is much more robust and concise to use boost::program_options instead of writing a huge switch/case statement. (This doesn't apply to the class AIMSimilarityRegistration itself, but to the program SimilarityRegistration which uses it.)		Parsing command line options is a standard wheel that should not be reinvented. It is much more robust and concise to use boost::program_options instead of writing a huge switch/case statement. (This doesn't apply to the class AIMSimilarityRegistration itself, but to the program SimilarityRegistration which uses it.)

Enodwell: /* Example: Improving SimilarityRegistration */

2010-05-11T17:29:41Z

Example: Improving SimilarityRegistration

← Older revision		Revision as of 17:29, 11 May 2010
Line 106:		Line 106:

	vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.		vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.

			====Manually parsing command line parameters replaced with boost::program_options===

			Parsing command line options is a standard wheel that should not be reinvented. It is much more robust and concise to use boost::program_options instead of writing a huge switch/case statement. (This doesn't apply to the class AIMSimilarityRegistration itself, but to the program SimilarityRegistration which uses it.)

	====Minor changes====		====Minor changes====

Enodwell: /* Example: SimilarityRegistration */

2010-05-11T17:25:17Z

Example: SimilarityRegistration

← Older revision		Revision as of 17:25, 11 May 2010
Line 51:		Line 51:
	to write		to write

	===Example: SimilarityRegistration===		===Example: Improving SimilarityRegistration===

	SimilarityTransform is a class that I modified heavily to improve the code. Here are some of the changes:		SimilarityTransform is a class that I modified heavily to improve the code. Here are some of the changes:

Enodwell: /* vtkFileParser replaced with boost:property_tree */

2010-05-11T17:24:59Z

vtkFileParser replaced with boost:property_tree

← Older revision		Revision as of 17:24, 11 May 2010
Line 103:		Line 103:
	It's much easier to maintain a single version of the function than to try to keep two nearly identical versions in sync.		It's much easier to maintain a single version of the function than to try to keep two nearly identical versions in sync.

	====vtkFileParser replaced with boost:property_tree====		====vtkFileParser replaced with boost::property_tree====

	vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.		vtkFileParser is gone, since it's a reinvention of a standard wheel. Replaced with boost::property_tree. The user can either pass in a set of configuration parameters (SetConfiguration), or specify a file name from which to read the parameters (ReadConfigFile). There is a method VerifyConfiguration that will check that all required parameters are present and possibly provide default values.

Enodwell: /* Near-identical classes replaced with single templated class */

2010-05-11T17:24:37Z

Near-identical classes replaced with single templated class

← Older revision		Revision as of 17:24, 11 May 2010
Line 95:		Line 95:
	Error and warning messages should be to std:cerr, not to std::cout. In most cases this will make no difference, but it gives the user a chance to direct the error messages somewhere different than the regular output. (I often do this for long-running jobs - I want to examine the whole output after it's done, but I want to see errors and warnings immediately.)		Error and warning messages should be to std:cerr, not to std::cout. In most cases this will make no difference, but it gives the user a chance to direct the error messages somewhere different than the regular output. (I often do this for long-running jobs - I want to examine the whole output after it's done, but I want to see errors and warnings immediately.)

	====Near-identical ~~classes~~ replaced with single templated ~~class~~====		====Near-identical methods replaced with single templated method====

	TransformImage previously had two versions, one for char data and one for short data. Replaced with a single templated version. Now called like this for example:		TransformImage previously had two versions, one for char data and one for short data. Replaced with a single templated version. Now called like this for example:

Enodwell: /* Minor changes */

2010-05-11T17:22:37Z

Minor changes

← Older revision		Revision as of 17:22, 11 May 2010
Line 111:		Line 111:
	PrintSampleConfigFile now takes a stream as an argument, so it can be used to send the example to Config file to cout, or to a file, or anywhere.		PrintSampleConfigFile now takes a stream as an argument, so it can be used to send the example to Config file to cout, or to a file, or anywhere.

	For C+ file streams, the following is redundant, because leaving the scope where fout is defined will call its destructor and close it automatically::		For file streams, the following is redundant, because leaving the scope where fout is defined will call its destructor and close it automatically:
	if (fout.is_open())		if (fout.is_open())
	{		{

Enodwell: /* Error handling done with C++ exceptions */

2010-05-11T17:22:15Z

Error handling done with C++ exceptions

← Older revision		Revision as of 17:22, 11 May 2010
Line 89:		Line 89:
	====Error handling done with C++ exceptions====		====Error handling done with C++ exceptions====

	Error handling: done with C++ exceptions. Note that in comparison VTK typically uses return values to indicate error status. Either approach can work, but C++ exceptions more often do ~~the expected~~ thing with less work. (e.g If the caller does not explicitly handle a return value indicating an error, it continues executing as normal, which is bad, whereas if the caller does not explicitly handle an exception, the program terminates, which is good.)		Error handling: done with C++ exceptions. Note that in comparison VTK typically uses return values to indicate error status (ITK uses exceptions). Either approach can work, but C++ exceptions more often do correct thing with less work. (e.g If the caller does not explicitly handle a return value indicating an error, it continues executing as normal, which is bad, whereas if the caller does not explicitly handle an exception, the program terminates, which is good.)

	====Errors and warnings to cerr====		====Errors and warnings to cerr====