Public Member Functions | Protected Attributes
mfpf_patch_data Class Reference

Defines region size, shape, and form of model to use. More...

#include <mfpf_patch_data.h>

List of all members.

Public Member Functions

 mfpf_patch_data ()
 Dflt ctor.
virtual ~mfpf_patch_data ()
 Destructor.
vcl_string name () const
 Name of this patch.
unsigned min_width () const
 Minimum number of samples along one dimension of patch.
unsigned max_width () const
 Maximum number of samples along one dimension of patch.
mfpf_region_definerdefiner ()
 Object to define region given a set of points.
mfpf_point_finder_builderbuilder ()
 Builder to be used for this patch.
bool set_from_stream (vcl_istream &is)
 Initialise from a text stream.
short version_no () const
 Version number for I/O.
virtual vcl_string is_a () const
 Name of the class.
virtual void print_summary (vcl_ostream &os) const
 Print class to os.
virtual void b_write (vsl_b_ostream &bfs) const
 Save class to binary file stream.
virtual void b_read (vsl_b_istream &bfs)
 Load class from binary file stream.

Protected Attributes

vcl_string name_
 Name of this patch.
unsigned min_width_
 Minimum number of samples along one dimension of patch.
unsigned max_width_
 Maximum number of samples along one dimension of patch.
mbl_cloneable_ptr
< mfpf_region_definer
definer_
 Object to define region given a set of points.
mbl_cloneable_ptr
< mfpf_point_finder_builder
builder_
 Builder to be used for this patch.

Detailed Description

Defines region size, shape, and form of model to use.

Object to hold information about how to set up an mfpf_point_finder (or multi-res. version) given sets of points on each image. The position/size of the region is defined relative to the points. The type of finder to use, and details of how to set it up are also included.

The main use of the object is to parse text files defining sets of patches for more complex models.

Example of text than can be parsed by set_from_stream:

 {
   name: Test1
   min_width: 8
   max_width: 10
   region: mfpf_region_about_lineseg: { ... }
   builder: mfpf_norm_corr2d_builder: { ... }
 }

Definition at line 33 of file mfpf_patch_data.h.


Constructor & Destructor Documentation

mfpf_patch_data::mfpf_patch_data ( )

Dflt ctor.

Definition at line 20 of file mfpf_patch_data.cxx.

mfpf_patch_data::~mfpf_patch_data ( ) [virtual]

Destructor.

Definition at line 28 of file mfpf_patch_data.cxx.


Member Function Documentation

void mfpf_patch_data::b_read ( vsl_b_istream bfs) [virtual]

Load class from binary file stream.

Definition at line 114 of file mfpf_patch_data.cxx.

void mfpf_patch_data::b_write ( vsl_b_ostream bfs) const [virtual]

Save class to binary file stream.

Definition at line 100 of file mfpf_patch_data.cxx.

mfpf_point_finder_builder& mfpf_patch_data::builder ( ) [inline]

Builder to be used for this patch.

Definition at line 71 of file mfpf_patch_data.h.

mfpf_region_definer& mfpf_patch_data::definer ( ) [inline]

Object to define region given a set of points.

Definition at line 68 of file mfpf_patch_data.h.

vcl_string mfpf_patch_data::is_a ( ) const [virtual]

Name of the class.

Definition at line 77 of file mfpf_patch_data.cxx.

unsigned mfpf_patch_data::max_width ( ) const [inline]

Maximum number of samples along one dimension of patch.

Definition at line 65 of file mfpf_patch_data.h.

unsigned mfpf_patch_data::min_width ( ) const [inline]

Minimum number of samples along one dimension of patch.

Definition at line 62 of file mfpf_patch_data.h.

vcl_string mfpf_patch_data::name ( ) const [inline]

Name of this patch.

Definition at line 59 of file mfpf_patch_data.h.

void mfpf_patch_data::print_summary ( vcl_ostream &  os) const [virtual]

Print class to os.

Definition at line 83 of file mfpf_patch_data.cxx.

bool mfpf_patch_data::set_from_stream ( vcl_istream &  is)

Initialise from a text stream.

Initialise from a string stream.

Definition at line 33 of file mfpf_patch_data.cxx.

short mfpf_patch_data::version_no ( ) const

Version number for I/O.

Definition at line 67 of file mfpf_patch_data.cxx.


Member Data Documentation

Builder to be used for this patch.

Definition at line 49 of file mfpf_patch_data.h.

Object to define region given a set of points.

Definition at line 46 of file mfpf_patch_data.h.

unsigned mfpf_patch_data::max_width_ [protected]

Maximum number of samples along one dimension of patch.

Definition at line 43 of file mfpf_patch_data.h.

unsigned mfpf_patch_data::min_width_ [protected]

Minimum number of samples along one dimension of patch.

Definition at line 40 of file mfpf_patch_data.h.

vcl_string mfpf_patch_data::name_ [protected]

Name of this patch.

Definition at line 37 of file mfpf_patch_data.h.


The documentation for this class was generated from the following files: