IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Mar 9, 2004, 1:49:35 PM (22 years ago)
Author:
eugene
Message:

fixed verb/noun order in the names (psAllocImage -> psImageAlloc)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/archive/pslib/include/psImages.h

    r151 r157  
    4444/// Create an image of the specified size and type.
    4545psImage *
    46 psAllocImage (int nx,                   ///< image width
     46psImageAlloc (int nx,                   ///< image width
    4747              int ny,                   ///< image height
    4848              PS_IMAGE_DEPTH depth      ///< image depth
     
    5151/// Create a subimage of the specified area.
    5252psImage *
    53 psSubsetImage (psImage *image,          ///< parent image
     53psImageSubset (psImage *image,          ///< parent image
    5454               int nx,                  ///< subimage width (<= image.nx - x0) 
    5555               int ny,                  ///< subimage width (<= image.ny - y0) 
     
    6060/// Destroy the specified image (destroy children if they exist).
    6161void
    62 psFreeImage (psImage *image             ///< free this image
     62psImageFree (psImage *image             ///< free this image
    6363);
    6464
    6565/// Destroy the children of the specified image.
    6666int
    67 psFreeImageChildren (psImage *image     ///< free children of this image
     67psImageFreeChildren (psImage *image     ///< free children of this image
    6868);
    6969
    7070/// Create a copy of the specified image.
    7171psImage *
    72 psCopyImage (psImage *output,           ///< target structure for output image data
     72psImageCopy (psImage *output,           ///< target structure for output image data
    7373             psImage *input             ///< copy this image
    7474);
     
    7777/// Extract pixels from rectlinear region to a vector.
    7878psFloatArray *
    79 psSliceImage (psImage *input,           ///< extract slice from this image
     79psImageSlice (psImage *input,           ///< extract slice from this image
    8080              int x,                    ///< starting x coord of region to slice
    8181              int y,                    ///< starting y coord of region to slice
     
    8888/// Extract pixels along a line to a vector.
    8989psFloatArray *
    90 psCutImage (psImage *input,             ///< extract cut from this image
     90psImageCut (psImage *input,             ///< extract cut from this image
    9191            float xs,                   ///< starting x coord of cut
    9292            float ys,                   ///< starting y coord of cut
     
    9999/// Extract radial annulii data to a vector.
    100100psFloatArray *
    101 psRadialCutImage (psImage *input,       ///< extract profile from this image
     101psImageRadialCut (psImage *input,       ///< extract profile from this image
    102102                  float x,              ///< center x coord of annulii
    103103                  float y,              ///< center y coord of annulii
     
    109109/// Extract a 2-d contour from an image at the given threshold.
    110110psFloatArrayArray *
    111 psContourImage (psImage *input,         ///< create contour for this image
     111psImageContour (psImage *input,         ///< create contour for this image
    112112                float threshold,        ///< contour image at this threshold
    113113                int binning             ///< bin image by this value for contour calculation
     
    116116/// Extract a 2-d contour from an image at the given threshold.
    117117psSpanArray *
    118 psContourImage (psImage *input,         ///< create contour for this image
     118psImageContour (psImage *input,         ///< create contour for this image
    119119                float threshold         ///<  image at this threshold
    120120);
     
    123123/// Rebin image to new scale.
    124124psImage *
    125 psRebinImage (psImage *input,           ///< rebin this image
     125psImageRebin (psImage *input,           ///< rebin this image
    126126              float scale,              ///< rebinning scale: doutput = scale*dinput
    127127              enum statmode             ///< statistic used in performing interpolation / summing
     
    130130/// Rotate image by given angle.
    131131psImage *
    132 psRotateImage (psImage *input,          ///< rotate this image
     132psImageRotate (psImage *input,          ///< rotate this image
    133133               float angle              ///< rotate by this amount (degrees)
    134134);
     
    137137/// Drop edge pixels, and set newly exposed pixels to 'exposed'.
    138138psImage *
    139 psShiftImage (psImage *input,           ///< shift this image
     139psImageShift (psImage *input,           ///< shift this image
    140140              float dx,                 ///< shift by this amount in x
    141141              float dy,                 ///< shift by this amount in y
     
    146146/// Edge pixels wrap to the other side (no values are lost).
    147147psImage *
    148 psRollImage (psImage *input,            ///< roll this image
     148psImageRoll (psImage *input,            ///< roll this image
    149149             int dx,                    ///< roll this amount in x
    150150             int dy                     ///< roll this amount in y
     
    155155/// How to represent the output values?
    156156void
    157 psStatImage (psImage *input, enum statmode);
     157psImageGetStats (psImage *input, enum statmode);
    158158
    159159/// Construct a histogram from an image (or subimage).
    160160psHistogram *
    161 psHistogramImage (psHistogram,          ///< input histogram description & target
     161psImageHistogram (psHistogram,          ///< input histogram description & target
    162162                  psImage *input,       ///< determine histogram of this image
    163163);
     
    165165/// Fit a 2-D polynomial surface to an image.
    166166psFloatArrayArray *
    167 psFitPolynomialImage (psImage *input,   ///< image to fit
     167psImageFitPolynomial (psImage *input,   ///< image to fit
    168168                      int xorder        ///< order of polynomial in x-dir
    169169                      int yorder        ///< order of polynomial in y-dir
     
    173173/// Read an image or subimage from a named file.
    174174psImage *
    175 psReadImageSection (psImage *output,    ///< place data in this structure for output
     175psImageReadSection (psImage *output,    ///< place data in this structure for output
    176176                    int x,              ///< starting x coord of region
    177177                    int y,              ///< starting y coord of region
     
    185185/// Read an image or subimage from file descriptor.
    186186psImage *
    187 psFReadImageSection (psImage *output,   ///< place data in this structure for output
     187psImageFReadSection (psImage *output,   ///< place data in this structure for output
    188188                     int x,             ///< starting x coord of region           
    189189                     int y,             ///< starting y coord of region           
     
    197197/// Write an image section to named file (which may exist).
    198198psImage *
    199 psWriteImageSection (psImage *input,    ///< image to write out
     199psImageWriteSection (psImage *input,    ///< image to write out
    200200                     int x,             ///< starting x coord of region           
    201201                     int y,             ///< starting y coord of region           
     
    207207/// Write an image section to named file (which may exist).
    208208psImage *
    209 psFWriteImageSection (psImage *input,   ///< image to write out
     209psImageFWriteSection (psImage *input,   ///< image to write out
    210210                      int x,            ///< starting x coord of region           
    211211                      int y,            ///< starting y coord of region           
     
    217217/// Read only header from image file.
    218218psMetadata *
    219 psReadImageHeader (psMetadata *output,  ///< read data to this structure
     219psImageReadHeader (psMetadata *output,  ///< read data to this structure
    220220                   char *extname,       ///< MEF extension name ("PHU" for primary header)
    221221                   char *filename       ///< file to read from
     
    224224/// Read only header from image file descriptor.
    225225psMetadata *
    226 psReadImageHeader (psMetadata *output,  ///< read data to this structure
     226psImageFReadHeader (psMetadata *output,         ///< read data to this structure
    227227                   char *extname,       ///< MEF extension name ("PHU" for primary header)
    228228                   FILE *f              ///< file descriptor to read from
     
    232232/// Perform an FFT on the image.
    233233psImage *
    234 psFFTImage (psImage *input,             ///< image to FFT
     234psImageFFT (psImage *input,             ///< image to FFT
    235235            enum direction              ///< FFT direction
    236236);
     
    239239/// Clip image values outside of range to given values.
    240240int
    241 psClipImage (psImage *input,            ///< clip this image
     241psImageClip (psImage *input,            ///< clip this image
    242242             float min,                 ///< clip pixels with values < min
    243243             float vmin,                ///< set min-clipped pixels to vmin
     
    248248/// Clip NaN image pixels to given value.
    249249int
    250 psClipNaNImage (psImage *input,         ///< clip this image
     250psImageClipNaN (psImage *input,         ///< clip this image
    251251                float value             ///< set nan pixels to this value
    252252);
     
    270270/// Overlay subregion of image with another image.
    271271int
    272 psOverlayImage (psImage *image,         ///< input image
     272psImageOverlaySection (psImage *image,          ///< input image
    273273                psImage *overlay,       ///< image to overlay
    274274                int x0,                 ///< x offset of overlay subimage
Note: See TracChangeset for help on using the changeset viewer.