Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
mfpf_point_finder_builder Class Reference

Base for classes which build mfpf_point_finder objects. More...

#include <mfpf_point_finder_builder.h>

Inheritance diagram for mfpf_point_finder_builder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 mfpf_point_finder_builder ()
 Dflt ctor.
virtual ~mfpf_point_finder_builder ()
 Destructor.
virtual void set_step_size (double)
 Size of step between sample points.
double step_size () const
 Size of step between sample points.
virtual void set_region_size (double wi, double wj)=0
 Define region size in world co-ordinates.
virtual void set_search_area (unsigned ni, unsigned nj)
 Define search region size.
void set_search_angle_range (unsigned nA, double dA)
 Define angle search parameters.
void set_search_scale_range (unsigned ns, double ds)
 Define scale search parameters.
int search_ni () const
int search_nj () const
unsigned search_nA () const
 Number of angles to search at (ie try at A+idA, i in [-nA,+nA]).
double search_dA () const
 Angle step size (ie try at A+idA, i in [-nA,+nA]).
unsigned search_ns () const
 Number of scales to try at.
double search_ds () const
 Scaling factor (ie try at ((ds)^i), i in [-ns,+ns].
virtual unsigned model_dim ()
 Number of dimensions in the model.
virtual mfpf_point_findernew_finder () const =0
 Create new finder of appropriate type on heap.
virtual void clear (unsigned n_egs)=0
 Initialise building.
virtual void get_sample_vector (const vimt_image_2d_of< float > &image, const vgl_point_2d< double > &p, const vgl_vector_2d< double > &u, vcl_vector< double > &v)
 Get sample of region around specified point in image.
virtual void add_example (const vimt_image_2d_of< float > &image, const vgl_point_2d< double > &p, const vgl_vector_2d< double > &u)=0
 Add one example to the model.
virtual void build (mfpf_point_finder &)=0
 Build object from the data supplied in add_example().
virtual bool set_from_stream (vcl_istream &is)
 Initialise from a string stream.
short version_no () const
 Version number for I/O.
virtual vcl_string is_a () const
 Name of the class.
virtual mfpf_point_finder_builderclone () const =0
 Create a copy on the heap and return base class pointer.
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.

Static Public Member Functions

static vcl_auto_ptr
< mfpf_point_finder_builder
create_from_stream (vcl_istream &is)
 Create a concrete object, from a text specification.

Protected Member Functions

bool base_equality (const mfpf_point_finder_builder &b) const
 Return true if base class parameters are the same in b.
void parse_base_props (mbl_read_props_type &props)
 Parse relevant parameters from props list.
void set_base_parameters (mfpf_point_finder &pf)
 Set base-class parameters of point finder.

Protected Attributes

double step_size_
 Size of step between sample points.
int search_ni_
 Number of points either side of centre to search.
int search_nj_
 Number of points either side of centre to search.
unsigned search_nA_
 Define N. angles (ie try at A+idA, i in [-nA,+nA]).
double search_dA_
 Angle step size (ie try at A+idA, i in [-nA,+nA]).
unsigned search_ns_
 Number of scales to try at.
double search_ds_
 Scaling factor (ie try at ((ds)^i), i in [-ns,+ns].

Detailed Description

Base for classes which build mfpf_point_finder objects.

Definition at line 20 of file mfpf_point_finder_builder.h.


Constructor & Destructor Documentation

mfpf_point_finder_builder::mfpf_point_finder_builder ( )

Dflt ctor.

Definition at line 23 of file mfpf_point_finder_builder.cxx.

mfpf_point_finder_builder::~mfpf_point_finder_builder ( ) [virtual]

Destructor.

Definition at line 34 of file mfpf_point_finder_builder.cxx.


Member Function Documentation

virtual void mfpf_point_finder_builder::add_example ( const vimt_image_2d_of< float > &  image,
const vgl_point_2d< double > &  p,
const vgl_vector_2d< double > &  u 
) [pure virtual]
void mfpf_point_finder_builder::b_read ( vsl_b_istream bfs) [virtual]
void mfpf_point_finder_builder::b_write ( vsl_b_ostream bfs) const [virtual]
bool mfpf_point_finder_builder::base_equality ( const mfpf_point_finder_builder b) const [protected]

Return true if base class parameters are the same in b.

Return true if base class parameters are the same in pf.

Definition at line 189 of file mfpf_point_finder_builder.cxx.

virtual void mfpf_point_finder_builder::build ( mfpf_point_finder ) [pure virtual]
virtual void mfpf_point_finder_builder::clear ( unsigned  n_egs) [pure virtual]
virtual mfpf_point_finder_builder* mfpf_point_finder_builder::clone ( ) const [pure virtual]
vcl_auto_ptr< mfpf_point_finder_builder > mfpf_point_finder_builder::create_from_stream ( vcl_istream &  is) [static]

Create a concrete object, from a text specification.

Definition at line 153 of file mfpf_point_finder_builder.cxx.

void mfpf_point_finder_builder::get_sample_vector ( const vimt_image_2d_of< float > &  image,
const vgl_point_2d< double > &  p,
const vgl_vector_2d< double > &  u,
vcl_vector< double > &  v 
) [virtual]

Get sample of region around specified point in image.

Reimplemented in mfpf_grad_corr2d_builder, and mfpf_norm_corr2d_builder.

Definition at line 74 of file mfpf_point_finder_builder.cxx.

vcl_string mfpf_point_finder_builder::is_a ( ) const [virtual]
unsigned mfpf_point_finder_builder::model_dim ( ) [virtual]
virtual mfpf_point_finder* mfpf_point_finder_builder::new_finder ( ) const [pure virtual]
void mfpf_point_finder_builder::parse_base_props ( mbl_read_props_type props) [protected]

Parse relevant parameters from props list.

Definition at line 85 of file mfpf_point_finder_builder.cxx.

void mfpf_point_finder_builder::print_summary ( vcl_ostream &  os) const [virtual]
double mfpf_point_finder_builder::search_dA ( ) const [inline]

Angle step size (ie try at A+idA, i in [-nA,+nA]).

Definition at line 90 of file mfpf_point_finder_builder.h.

double mfpf_point_finder_builder::search_ds ( ) const [inline]

Scaling factor (ie try at ((ds)^i), i in [-ns,+ns].

Definition at line 96 of file mfpf_point_finder_builder.h.

unsigned mfpf_point_finder_builder::search_nA ( ) const [inline]

Number of angles to search at (ie try at A+idA, i in [-nA,+nA]).

Definition at line 87 of file mfpf_point_finder_builder.h.

int mfpf_point_finder_builder::search_ni ( ) const [inline]

Definition at line 83 of file mfpf_point_finder_builder.h.

int mfpf_point_finder_builder::search_nj ( ) const [inline]

Definition at line 84 of file mfpf_point_finder_builder.h.

unsigned mfpf_point_finder_builder::search_ns ( ) const [inline]

Number of scales to try at.

Definition at line 93 of file mfpf_point_finder_builder.h.

void mfpf_point_finder_builder::set_base_parameters ( mfpf_point_finder pf) [protected]

Set base-class parameters of point finder.

Definition at line 126 of file mfpf_point_finder_builder.cxx.

bool mfpf_point_finder_builder::set_from_stream ( vcl_istream &  is) [virtual]
virtual void mfpf_point_finder_builder::set_region_size ( double  wi,
double  wj 
) [pure virtual]
void mfpf_point_finder_builder::set_search_angle_range ( unsigned  nA,
double  dA 
)

Define angle search parameters.

Definition at line 54 of file mfpf_point_finder_builder.cxx.

void mfpf_point_finder_builder::set_search_area ( unsigned  ni,
unsigned  nj 
) [virtual]

Define search region size.

During search, samples at points on grid [-ni,ni]x[-nj,nj], with axes defined by u.

Definition at line 47 of file mfpf_point_finder_builder.cxx.

void mfpf_point_finder_builder::set_search_scale_range ( unsigned  ns,
double  ds 
)

Define scale search parameters.

Definition at line 61 of file mfpf_point_finder_builder.cxx.

void mfpf_point_finder_builder::set_step_size ( double  s) [virtual]

Size of step between sample points.

Definition at line 39 of file mfpf_point_finder_builder.cxx.

double mfpf_point_finder_builder::step_size ( ) const [inline]

Size of step between sample points.

Definition at line 65 of file mfpf_point_finder_builder.h.

short mfpf_point_finder_builder::version_no ( ) const

Member Data Documentation

Angle step size (ie try at A+idA, i in [-nA,+nA]).

Definition at line 36 of file mfpf_point_finder_builder.h.

Scaling factor (ie try at ((ds)^i), i in [-ns,+ns].

Definition at line 42 of file mfpf_point_finder_builder.h.

Define N. angles (ie try at A+idA, i in [-nA,+nA]).

Definition at line 33 of file mfpf_point_finder_builder.h.

Number of points either side of centre to search.

Definition at line 27 of file mfpf_point_finder_builder.h.

Number of points either side of centre to search.

Definition at line 30 of file mfpf_point_finder_builder.h.

Number of scales to try at.

Definition at line 39 of file mfpf_point_finder_builder.h.

Size of step between sample points.

Definition at line 24 of file mfpf_point_finder_builder.h.


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