|| ||           || Doxygen's  

---

Image functors

In general, a functor is a function wrapped in an object. An image functor refers to an object that is used to make the user-specified functional part of a pattern (see Image processing patterns and variations) do what the user wants it to do.

Image functors are addressed via Image functor keys. Keys are created in the constructor of the image functors at the "real functor" level. The various parts of the key are derived from the actual template parameters via HxClassName.

Image functors are collected in the HxImgFtorTable. HxImgFtorTable contains a map of <HxImgFtorKey, HxImgFunctor*>. In general, functors are inserted in the table via declaration of a static variable that instantiates a leaf node image functor from the tree below for a specific image type. More accurately, the constructor of HxImgFunctor (the base class of the image functor hierarchy) inserts itself in the table under its key, i.e. it inserts the <key,object> combination in the table. The insert function puts a stringified version of the <key,functor> combination in the HxRegistry under ["/imagefunctortable/entries"].

When the user calls an image processing fuction, the HxImageData member functions construct a key by converting their arguments to strings and use this key to retrieve the right image functor from the table. The HxImageData member functions use the template class HxImgFtorTableTem to get statically typed access at the level of "I-nary" functors (see below) in the image functor hierarchy. The downcast is "safe" because the key used to find the "real functor" is derived from the key corresponding to the "I-nary" functor. Naturally, this implies that the image functor and key hierarchies should be kept in close harmony.

Other classes:

HxImgFtorDescription, HxImgFtorRuleBase,

The image functor tree

The tree has four levels:

1. The root level : HxImgFunctor (for insertion and retrieval from the table).
2. The "I-nary" level : I1 stands for "taking 1 image parameter", I2 for 2 image parameters, etc.
3. The "cast" level : the highest template level for casting of polymorphic HxImageData parameters to statically typed image data pointers.
4. The "real functor" level : the leaf nodes are the actual functors that introduce additional, pattern specific template parameters.

• HxImgFunctor
  • HxImgFtorI1
    • HxImgFtorI1Cast<ImgSigT>
      • HxImgFtorInOut<ImgSigT, InOutT>
      • HxImgFtorRgb2d<ImgSigT, RgbT>
      • HxImgFtorRgb3d<ImgSigT, RgbT>
      • HxImgFtorSetBorder2d<ImgSigT>
      • HxImgFtorSetBorder3d<ImgSigT>
  • HxImgFtorI2
    • HxImgFtorI2Cast<DstImgSigT, SrcImgSigT>
      • HxImgFtorExportExtra<ImgSigT,ExtraImgSigT,ExportExtraT>
      • HxImgFtorNgb2d<DstImgSigT, SrcImgSigT, NgbT>
      • HxImgFtorRecGenConv2d<ImgSigT, KerImgSigT, PixOpT, RedOpT>
      • HxImgFtorRecGenConv2dK1d<ImgSigT, KerImgSigT, PixOpT, RedOpT>
      • HxImgFtorSet<DstImgSigT, SrcImgSigT>
      • HxImgFtorTranspose2d<DstImgSigT, SrcImgSigT>
      • HxImgFtorUpo<DstImgSigT, SrcImgSigT, UpoT>
  • HxImgFtorI3
    • HxImgFtorI3Cast<DstImgSigT, Src1ImgSigT, Src2ImgSigT>
      • HxImgFtorBpo<DstImgSigT, Src1ImgSigT, Src2ImgSigT, BpoT>
      • HxImgFtorGenConv2d<DstImgSigT, SrcImgSigT, KerImgSigT, PixOpT, RedOpT, KernelT>
      • HxImgFtorGenConv2dK1d<DstImgSigT, SrcImgSigT, KerImgSigT, PixOpT, RedOpT, KernelT>
      • HxImgFtorGenConv3d<DstImgSigT, SrcImgSigT, KerImgSigT, PixOpT, RedOpT, KernelT>
      • HxImgFtorGenConv3dK1d<DstImgSigT, SrcImgSigT, KerImgSigT, PixOpT, RedOpT, KernelT>
      • HxImgFtorKernelNgb2d<DstImgSigT, SrcImgSigT, KerImgSigT, NgbT>
      • HxImgFtorNgb2dExtra<DstImgSigT, SrcImgSigT, ExtraImgSigT, NgbT>
  • HxImgFtorI4
    • HxImgFtorI4Cast<Img1SigT, Img2SigT, Img3SigT, Img4SigT>
      • HxImgFtorGenConv2dSep<DstImgSigT, SrcImgSigT, KerImgSigT, PixOpT, RedOpT, KernelT>
      • HxImgFtorNgb2dExtra2<DstImgSigT, SrcImgSigT, ExtraImgSigT, ExtraImg2SigT, NgbT>
  • HxImgFtorIM
    • HxImgFtorIMCast<DstImgSigT, SrcImgsSigT>
      • HxImgFtorMpo<DstImgSigT, SrcImgsSigT, MpoT>
  • HxImgFtorIMN
    • HxImgFtorIMNCast<DstImgsSigT, SrcImgsSigT>
      • HxImgFtorMNpo<DstImgSigT, SrcImgsSigT, MNpoT>

---

Go to the next section or go to images or return to the index.

---