IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jun 8, 2005, 1:40:46 PM (21 years ago)
Author:
desonia
Message:

added comments on the end of #endif and #else

Location:
trunk/psLib/src/imageops
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/imageops/psImageConvolve.h

    r3264 r4162  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-02-17 19:26:24 $
     9 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-06-08 23:40:45 $
    1111 *
    1212 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    4141/** Allocates a convolution kernel of the given range
    4242 *
    43  *  In order to perform a convolution, we need to define the convolution 
    44  *  kernel. We need a more general object than a psImage so that we can 
    45  *  incorporate the offset from the (0, 0) pixel to the (0, 0) value of the 
    46  *  kernel. It might be convenient to allow both positive and negative 
    47  *  indices to convey the positive and negative shifts. One might consider 
    48  *  setting the x0 and y0 members of a psImage to the appropriate offsets, 
    49  *  but this is not the purpose of these members, and doing so may affect the 
     43 *  In order to perform a convolution, we need to define the convolution
     44 *  kernel. We need a more general object than a psImage so that we can
     45 *  incorporate the offset from the (0, 0) pixel to the (0, 0) value of the
     46 *  kernel. It might be convenient to allow both positive and negative
     47 *  indices to convey the positive and negative shifts. One might consider
     48 *  setting the x0 and y0 members of a psImage to the appropriate offsets,
     49 *  but this is not the purpose of these members, and doing so may affect the
    5050 *  behavior of other psImage operations.
    5151 *
    52  *  This construction allows the kernel member to use negative indices, while 
     52 *  This construction allows the kernel member to use negative indices, while
    5353 *  preserving the location of psMemBlocks relative to allocated memory.
    5454 *
    55  *  The maximum extent of the kernel shifts shall be defined by the xMin, 
    56  *  xMax, yMin and yMax members. Note that xMin and yMin, under normal 
    57  *  circumstances, should be negative numbers. That is, 
    58  *  myKernel->kernel[-3][-2] may be defined if yMin and xMin are equal to or 
     55 *  The maximum extent of the kernel shifts shall be defined by the xMin,
     56 *  xMax, yMin and yMax members. Note that xMin and yMin, under normal
     57 *  circumstances, should be negative numbers. That is,
     58 *  myKernel->kernel[-3][-2] may be defined if yMin and xMin are equal to or
    5959 *  more negative than -3 and -2, respectively.
    6060 *
    61  *  In the event that one of the minimum values is greater than the 
    62  *  corresponding maximum value, the function shall generate a warning, and 
     61 *  In the event that one of the minimum values is greater than the
     62 *  corresponding maximum value, the function shall generate a warning, and
    6363 *  the offending values shall be exchanged.
    6464 *
    … …  
    7474/** Generates a kernel given a list of shift values
    7575 *
    76  *  Given a list of values (e.g., shifts made in the course of OT guiding), 
    77  *  psKernelGenerate shall return the appropriate kernel.  The vectors xShifts 
    78  *  and yShifts, which are a list of shifts relative to some starting point, 
    79  *  will be supplied by the user. The elements of the vectors should be of an 
    80  *  integer type; otherwise the values shall be truncated to integers. The 
    81  *  output kernel shall be normalized such that the sum over the kernel is 
    82  *  unity. 
     76 *  Given a list of values (e.g., shifts made in the course of OT guiding),
     77 *  psKernelGenerate shall return the appropriate kernel.  The vectors xShifts
     78 *  and yShifts, which are a list of shifts relative to some starting point,
     79 *  will be supplied by the user. The elements of the vectors should be of an
     80 *  integer type; otherwise the values shall be truncated to integers. The
     81 *  output kernel shall be normalized such that the sum over the kernel is
     82 *  unity.
    8383 *
    84  *  If the vectors are not of the same number of elements, then the function 
    85  *  shall generate a warning shall be generated, following which, the longer 
     84 *  If the vectors are not of the same number of elements, then the function
     85 *  shall generate a warning shall be generated, following which, the longer
    8686 *  vector trimmed to the length of the shorter, and the function shall continue.
    8787 *
    … …  
    9797/** convolve an image with a kernel
    9898 *
    99  *  Given an input image and the convolution kernel, psImageConvolve shall 
    100  *  convolve the input image, in, with the kernel, kernel and return the 
     99 *  Given an input image and the convolution kernel, psImageConvolve shall
     100 *  convolve the input image, in, with the kernel, kernel and return the
    101101 *  convolved image, out.
    102  * 
    103  *  Two methods shall be available for the convolution: if direct is true, 
    104  *  then the convolution shall be performed in real space (appropriate for 
    105  *  small kernels); otherwise, the convolution shall be performed using Fast 
    106  *  Fourier Transforms (FFTs; appropriate for larger kernels). The latter 
    107  *  option involves padding the input image, copying the kernel into an image 
    108  *  of the same size as the padded input image, performing an FFT on each, 
    109  *  multiplying the FFTs, and performing an inverse FFT before trimming the 
     102 *
     103 *  Two methods shall be available for the convolution: if direct is true,
     104 *  then the convolution shall be performed in real space (appropriate for
     105 *  small kernels); otherwise, the convolution shall be performed using Fast
     106 *  Fourier Transforms (FFTs; appropriate for larger kernels). The latter
     107 *  option involves padding the input image, copying the kernel into an image
     108 *  of the same size as the padded input image, performing an FFT on each,
     109 *  multiplying the FFTs, and performing an inverse FFT before trimming the
    110110 *  image back to the original size.
    111111 *
    112  *  @return psImage*  resulting image 
     112 *  @return psImage*  resulting image
    113113 */
    114114psImage* psImageConvolve(
    … …  
    119119);
    120120
    121 #endif
     121#endif // #ifndef PS_IMAGE_CONVOLVE_H

  • trunk/psLib/src/imageops/psImageGeomManip.h

    r3968 r4162  
    88 *  @author Robert DeSonia, MHPCC
    99 *
    10  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-05-19 02:08:21 $
     10 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-08 23:40:45 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    155155);
    156156
    157 #endif
     157#endif // #ifndef PS_IMAGE_GEOM_MANIP_H

  • trunk/psLib/src/imageops/psImagePixelExtract.h

    r3968 r4162  
    88*  @author Robert DeSonia, MHPCC
    99*
    10 *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2005-05-19 02:08:21 $
     10*  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     11*  @date $Date: 2005-06-08 23:40:45 $
    1212*
    1313*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    130130/// @}
    131131
    132 #endif
     132#endif // #ifndef PSIMAGE_PIXEL_EXTRACT_H

  • trunk/psLib/src/imageops/psImagePixelManip.h

    r3968 r4162  
    88 *  @author Robert DeSonia, MHPCC
    99 *
    10  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2005-05-19 02:08:21 $
     10 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2005-06-08 23:40:45 $
    1212 *
    1313 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    8888);
    8989
    90 #endif
     90#endif // #ifndef PS_IMAGE_PIXEL_MANIP_H

  • trunk/psLib/src/imageops/psImageStats.h

    r3493 r4162  
    99*  @author GLG, MHPCC
    1010*
    11 *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
    12 *  @date $Date: 2005-03-24 19:39:53 $
     11*  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
     12*  @date $Date: 2005-06-08 23:40:45 $
    1313*
    1414*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1515*/
    16 #if !defined(PS_IMAGE_STATS_H)
     16#ifndef PS_IMAGE_STATS_H
    1717#define PS_IMAGE_STATS_H
    1818
    … …  
    2828/** This routine must determine the various statistics for the image.
    2929 *
    30  *  Determine statistics for image (or subimage). The statistics to be 
    31  *  determined are specified by stats. The mask allows pixels to be excluded 
    32  *  if their corresponding mask pixel value matches the value of maskVal. 
    33  *  This function must be defined for the following types: psS8, psU16, psF32, 
     30 *  Determine statistics for image (or subimage). The statistics to be
     31 *  determined are specified by stats. The mask allows pixels to be excluded
     32 *  if their corresponding mask pixel value matches the value of maskVal.
     33 *  This function must be defined for the following types: psS8, psU16, psF32,
    3434 *  psF64.
    3535 *
    … …  
    4545/** Construct a histogram from an image (or subimage).
    4646 *
    47  *  The histogram to generate is specified by psHistogram hist (see section 
    48  *  4.3.2 in SDRS). This function must be defined for the following types: 
     47 *  The histogram to generate is specified by psHistogram hist (see section
     48 *  4.3.2 in SDRS). This function must be defined for the following types:
    4949 *  psS8, psU16, psF32, psF64.
    5050 *
    … …  
    6060/** Fit a 2-D polynomial surface to an image.
    6161 *
    62  *  The input structure coeffs contains the desired order and terms of 
    63  *  interest. This function must be defined for the following types: psS8, 
     62 *  The input structure coeffs contains the desired order and terms of
     63 *  interest. This function must be defined for the following types: psS8,
    6464 *  psU16, psF32, psF64.
    6565 *
    … …  
    7474/** Evaluate a 2-D polynomial surface for the image pixels.
    7575 *
    76  *  Given the input polynomial coefficients, set the image pixel values on the 
    77  *  basis of the polynomial function. This function must be defined for the 
     76 *  Given the input polynomial coefficients, set the image pixel values on the
     77 *  basis of the polynomial function. This function must be defined for the
    7878 *  following types: psS8, psU16, psF32, psF64.
    7979 *
    … …  
    8787/// @}
    8888
    89 #endif
     89#endif // #ifndef PS_IMAGE_STATS_H

  • trunk/psLib/src/imageops/psImageStructManip.h

    r3977 r4162  
    88*  @author Robert DeSonia, MHPCC
    99*
    10 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2005-05-19 05:18:20 $
     10*  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     11*  @date $Date: 2005-06-08 23:40:45 $
    1212*
    1313*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    8282/// @}
    8383
    84 #endif
     84#endif // #ifndef PSIMAGE_STRUCT_MANIP_H
Note: See TracChangeset for help on using the changeset viewer.