Horus Doc || C++ Reference || Class Overview   Pixels   Images   Detector   Geometry   Registry || Doxygen's quick Index  

HxMfNgb Class Reference

Class definition of method frame for neighbourhood operations. More...

#include <HxMfNgb.h>

List of all members.

Public Methods

 HxMfNgb (HxImageData *srcImg, HxString ngbName, HxTagList &tags)
 Constructor. More...

 HxMfNgb (HxImageData *srcImg, HxImageData *extraIm, HxString ngbName, HxTagList &tags)
 Constructor. More...

 HxMfNgb (HxImageData *srcImg, HxImageData *extraIm, HxImageData *extraIm2, HxString ngbName, HxTagList &tags)
 Constructor. More...

 ~HxMfNgb ()
 Destructor. More...

HxImageData * source () const
 The argument image of the frame. More...

HxImageData * result () const
 The result image of the frame. More...

HxImageData * extra () const
 The extra image of the frame. More...

HxImageData * extra2 () const
 The second extra image of the frame. More...

bool preOpIsOk () const
 Indicates whether initialization was OK. More...

Detailed Description

Class definition of method frame for neighbourhood operations.

A result image will be allocated with the same size as the source image. The type of the result image is obtained from the HxImgFtorRuleBase via

resulttype of ngb<source,ngbName>

The required type for the extra images, if present, are obtained via

extratype of ngb<source,ngbName> and extratype2 of ngb<source,ngbName>

Constructor & Destructor Documentation

HxMfNgb::HxMfNgb (  HxImageData *    srcImg,
HxString    ngbName,
HxTagList &    tags
) 
 

Constructor. 

00020     : _source(srcImg), _extra(0), _extra2(0), _result(0), _preOpIsOk(true),
00021       _tmpExtra(0), _tmpExtra2(0)
00022 {
00023     init(ngbName, tags);
00024 }

HxMfNgb::HxMfNgb (  HxImageData *    srcImg,
HxImageData *    extraIm,
HxString    ngbName,
HxTagList &    tags
) 
 

Constructor. 

00028     : _source(srcImg), _extra(extraIm), _extra2(0), _result(0), _preOpIsOk(true),
00029       _tmpExtra(0), _tmpExtra2(0)
00030 {
00031     init(ngbName, tags);
00032 }

HxMfNgb::HxMfNgb (  HxImageData *    srcImg,
HxImageData *    extraIm,
HxImageData *    extraIm2,
HxString    ngbName,
HxTagList &    tags
) 
 

Constructor. 

00036     : _source(srcImg), _extra(extraIm), _extra2(extraIm2), _result(0),
00037       _preOpIsOk(true), _tmpExtra(0), _tmpExtra2(0)
00038 {
00039     init(ngbName, tags);
00040 }

HxMfNgb::~HxMfNgb (    ) 
 

Destructor. 

00043 {
00044     if (_tmpExtra)
00045         delete _tmpExtra;
00046     if (_tmpExtra2)
00047         delete _tmpExtra2;
00048 }

Member Function Documentation

HxImageData * HxMfNgb::source (    )  const
 

The argument image of the frame. 

00052 { 
00053     return _source; 
00054 }

HxImageData * HxMfNgb::result (    )  const
 

The result image of the frame. 

00058 { 
00059     return _result; 
00060 }

HxImageData * HxMfNgb::extra (    )  const
 

The extra image of the frame. 

00064 { 
00065     return _extra; 
00066 }

HxImageData * HxMfNgb::extra2 (    )  const
 

The second extra image of the frame. 

00070 { 
00071     return _extra2; 
00072 }

bool HxMfNgb::preOpIsOk (    )  const [inline]
 

Indicates whether initialization was OK. 

00078 {
00079     return _preOpIsOk;
00080 }

The documentation for this class was generated from the following files:
Generated on Tue Feb 3 14:19:06 2004 for C++Reference by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001