Changeset 4162 for trunk/psLib/src/image/psImageConvolve.h

Timestamp:

Jun 8, 2005, 1:40:46 PM (21 years ago)

Author:

desonia

Message:

added comments on the end of #endif and #else

File:

• trunk/psLib/src/image/psImageConvolve.h (modified) (5 diffs)

trunk/psLib/src/image/psImageConvolve.h

@@ -7 +7 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-02-17 19:26:24 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-08 23:40:45 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -41 +41 @@
 /** Allocates a convolution kernel of the given range
  *
- *  In order to perform a convolution, we need to define the convolution 
- *  kernel. We need a more general object than a psImage so that we can 
- *  incorporate the offset from the (0, 0) pixel to the (0, 0) value of the 
- *  kernel. It might be convenient to allow both positive and negative 
- *  indices to convey the positive and negative shifts. One might consider 
- *  setting the x0 and y0 members of a psImage to the appropriate offsets, 
- *  but this is not the purpose of these members, and doing so may affect the 
+ *  In order to perform a convolution, we need to define the convolution
+ *  kernel. We need a more general object than a psImage so that we can
+ *  incorporate the offset from the (0, 0) pixel to the (0, 0) value of the
+ *  kernel. It might be convenient to allow both positive and negative
+ *  indices to convey the positive and negative shifts. One might consider
+ *  setting the x0 and y0 members of a psImage to the appropriate offsets,
+ *  but this is not the purpose of these members, and doing so may affect the
  *  behavior of other psImage operations.
  *
- *  This construction allows the kernel member to use negative indices, while 
+ *  This construction allows the kernel member to use negative indices, while
  *  preserving the location of psMemBlocks relative to allocated memory.
  *
- *  The maximum extent of the kernel shifts shall be defined by the xMin, 
- *  xMax, yMin and yMax members. Note that xMin and yMin, under normal 
- *  circumstances, should be negative numbers. That is, 
- *  myKernel->kernel[-3][-2] may be defined if yMin and xMin are equal to or 
+ *  The maximum extent of the kernel shifts shall be defined by the xMin,
+ *  xMax, yMin and yMax members. Note that xMin and yMin, under normal
+ *  circumstances, should be negative numbers. That is,
+ *  myKernel->kernel[-3][-2] may be defined if yMin and xMin are equal to or
  *  more negative than -3 and -2, respectively.
  *
- *  In the event that one of the minimum values is greater than the 
- *  corresponding maximum value, the function shall generate a warning, and 
+ *  In the event that one of the minimum values is greater than the
+ *  corresponding maximum value, the function shall generate a warning, and
  *  the offending values shall be exchanged.
  *
@@ -74 +74 @@
 /** Generates a kernel given a list of shift values
  *
- *  Given a list of values (e.g., shifts made in the course of OT guiding), 
- *  psKernelGenerate shall return the appropriate kernel.  The vectors xShifts 
- *  and yShifts, which are a list of shifts relative to some starting point, 
- *  will be supplied by the user. The elements of the vectors should be of an 
- *  integer type; otherwise the values shall be truncated to integers. The 
- *  output kernel shall be normalized such that the sum over the kernel is 
- *  unity. 
+ *  Given a list of values (e.g., shifts made in the course of OT guiding),
+ *  psKernelGenerate shall return the appropriate kernel.  The vectors xShifts
+ *  and yShifts, which are a list of shifts relative to some starting point,
+ *  will be supplied by the user. The elements of the vectors should be of an
+ *  integer type; otherwise the values shall be truncated to integers. The
+ *  output kernel shall be normalized such that the sum over the kernel is
+ *  unity.
  *
- *  If the vectors are not of the same number of elements, then the function 
- *  shall generate a warning shall be generated, following which, the longer 
+ *  If the vectors are not of the same number of elements, then the function
+ *  shall generate a warning shall be generated, following which, the longer
  *  vector trimmed to the length of the shorter, and the function shall continue.
  *
@@ -97 +97 @@
 /** convolve an image with a kernel
  *
- *  Given an input image and the convolution kernel, psImageConvolve shall 
- *  convolve the input image, in, with the kernel, kernel and return the 
+ *  Given an input image and the convolution kernel, psImageConvolve shall
+ *  convolve the input image, in, with the kernel, kernel and return the
  *  convolved image, out.
- * 
- *  Two methods shall be available for the convolution: if direct is true, 
- *  then the convolution shall be performed in real space (appropriate for 
- *  small kernels); otherwise, the convolution shall be performed using Fast 
- *  Fourier Transforms (FFTs; appropriate for larger kernels). The latter 
- *  option involves padding the input image, copying the kernel into an image 
- *  of the same size as the padded input image, performing an FFT on each, 
- *  multiplying the FFTs, and performing an inverse FFT before trimming the 
+ *
+ *  Two methods shall be available for the convolution: if direct is true,
+ *  then the convolution shall be performed in real space (appropriate for
+ *  small kernels); otherwise, the convolution shall be performed using Fast
+ *  Fourier Transforms (FFTs; appropriate for larger kernels). The latter
+ *  option involves padding the input image, copying the kernel into an image
+ *  of the same size as the padded input image, performing an FFT on each,
+ *  multiplying the FFTs, and performing an inverse FFT before trimming the
  *  image back to the original size.
  *
- *  @return psImage*  resulting image 
+ *  @return psImage*  resulting image
  */
 psImage* psImageConvolve(
@@ -119 +119 @@
 );
 
-#endif
+#endif // #ifndef PS_IMAGE_CONVOLVE_H