Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
mfpf_norm_corr2d_builder Class Reference

Builder for mfpf_norm_corr2d objects. More...

#include <mfpf_norm_corr2d_builder.h>

Inheritance diagram for mfpf_norm_corr2d_builder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 mfpf_norm_corr2d_builder ()
virtual ~mfpf_norm_corr2d_builder ()
void set_kernel_size (unsigned ni, unsigned nj, double ref_x, double ref_y)
 Define size of mask.
void set_kernel_size (unsigned ni, unsigned nj)
 Define size of mask.
virtual void set_region_size (double wi, double wj)
 Define region size in world co-ordinates.
unsigned ni () const
 Kernel mask is ni x nj.
unsigned nj () const
 Kernel mask is ni x nj.
virtual unsigned model_dim ()
 Number of dimensions in the model.
virtual mfpf_point_findernew_finder () const
 Create new mfpf_norm_corr2d on heap.
virtual void clear (unsigned n_egs)
 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)
 Add one example to the model.
virtual void build (mfpf_point_finder &)
 Build object from the data supplied in add_example().
virtual bool set_from_stream (vcl_istream &is)
 Initialise from a string stream.
virtual vcl_string is_a () const
 Name of the class.
virtual mfpf_point_finder_builderclone () const
 Create a copy on the heap and return base class pointer.
virtual void print_summary (vcl_ostream &os) const
 Print class to os.
short version_no () const
 Version number for I/O.
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.
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_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].

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].

Private Member Functions

void set_defaults ()
 Define default values.
void add_one_example (const vimt_image_2d_of< float > &image, const vgl_point_2d< double > &p, const vgl_vector_2d< double > &u)
 Add one example to the model.

Private Attributes

double ref_x_
 Kernel reference point (in kni_ x knj_ grid).
double ref_y_
 Kernel reference point (in kni_ x knj_ grid).
unsigned ni_
 Kernel mask is ni_ x nj_.
unsigned nj_
 Kernel mask is ni_ x nj_.
unsigned nA_
 Number of angles either side of 0 to sample at.
double dA_
 Angle displacement.
double overlap_f_
 Relative size of region used for estimating overlap.
vil_image_view< double > sum_
 Workspace for sum.
unsigned n_added_
 Number of examples added.

Detailed Description

Builder for mfpf_norm_corr2d objects.

Definition at line 13 of file mfpf_norm_corr2d_builder.h.


Constructor & Destructor Documentation

mfpf_norm_corr2d_builder::mfpf_norm_corr2d_builder ( )

Definition at line 28 of file mfpf_norm_corr2d_builder.cxx.

mfpf_norm_corr2d_builder::~mfpf_norm_corr2d_builder ( ) [virtual]

Definition at line 51 of file mfpf_norm_corr2d_builder.cxx.


Member Function Documentation

void mfpf_norm_corr2d_builder::add_example ( const vimt_image_2d_of< float > &  image,
const vgl_point_2d< double > &  p,
const vgl_vector_2d< double > &  u 
) [virtual]

Add one example to the model.

Implements mfpf_point_finder_builder.

Definition at line 193 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_norm_corr2d_builder::add_one_example ( const vimt_image_2d_of< float > &  image,
const vgl_point_2d< double > &  p,
const vgl_vector_2d< double > &  u 
) [private]

Add one example to the model.

Definition at line 129 of file mfpf_norm_corr2d_builder.cxx.

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

Load class from binary file stream.

Reimplemented from mfpf_point_finder_builder.

Definition at line 341 of file mfpf_norm_corr2d_builder.cxx.

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

Save class to binary file stream.

Reimplemented from mfpf_point_finder_builder.

Definition at line 322 of file mfpf_norm_corr2d_builder.cxx.

bool mfpf_point_finder_builder::base_equality ( const mfpf_point_finder_builder b) const [protected, inherited]

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.

void mfpf_norm_corr2d_builder::build ( mfpf_point_finder pf) [virtual]

Build object from the data supplied in add_example().

Build this object from the data supplied in add_example().

Implements mfpf_point_finder_builder.

Definition at line 213 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_norm_corr2d_builder::clear ( unsigned  n_egs) [virtual]

Initialise building.

Must be called before any calls to add_example(...)

Implements mfpf_point_finder_builder.

Definition at line 97 of file mfpf_norm_corr2d_builder.cxx.

mfpf_point_finder_builder * mfpf_norm_corr2d_builder::clone ( ) const [virtual]

Create a copy on the heap and return base class pointer.

Implements mfpf_point_finder_builder.

Definition at line 298 of file mfpf_norm_corr2d_builder.cxx.

vcl_auto_ptr< mfpf_point_finder_builder > mfpf_point_finder_builder::create_from_stream ( vcl_istream &  is) [static, inherited]

Create a concrete object, from a text specification.

Definition at line 153 of file mfpf_point_finder_builder.cxx.

void mfpf_norm_corr2d_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 from mfpf_point_finder_builder.

Definition at line 158 of file mfpf_norm_corr2d_builder.cxx.

vcl_string mfpf_norm_corr2d_builder::is_a ( ) const [virtual]

Name of the class.

Reimplemented from mfpf_point_finder_builder.

Definition at line 292 of file mfpf_norm_corr2d_builder.cxx.

unsigned mfpf_norm_corr2d_builder::model_dim ( ) [virtual]

Number of dimensions in the model.

Reimplemented from mfpf_point_finder_builder.

Definition at line 89 of file mfpf_norm_corr2d_builder.cxx.

mfpf_point_finder * mfpf_norm_corr2d_builder::new_finder ( ) const [virtual]

Create new mfpf_norm_corr2d on heap.

Implements mfpf_point_finder_builder.

Definition at line 56 of file mfpf_norm_corr2d_builder.cxx.

unsigned mfpf_norm_corr2d_builder::ni ( ) const [inline]

Kernel mask is ni x nj.

Definition at line 73 of file mfpf_norm_corr2d_builder.h.

unsigned mfpf_norm_corr2d_builder::nj ( ) const [inline]

Kernel mask is ni x nj.

Definition at line 76 of file mfpf_norm_corr2d_builder.h.

void mfpf_point_finder_builder::parse_base_props ( mbl_read_props_type props) [protected, inherited]

Parse relevant parameters from props list.

Definition at line 85 of file mfpf_point_finder_builder.cxx.

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

Print class to os.

Reimplemented from mfpf_point_finder_builder.

Definition at line 307 of file mfpf_norm_corr2d_builder.cxx.

double mfpf_point_finder_builder::search_dA ( ) const [inline, inherited]

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, inherited]

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, inherited]

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, inherited]

Definition at line 83 of file mfpf_point_finder_builder.h.

int mfpf_point_finder_builder::search_nj ( ) const [inline, inherited]

Definition at line 84 of file mfpf_point_finder_builder.h.

unsigned mfpf_point_finder_builder::search_ns ( ) const [inline, inherited]

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, inherited]

Set base-class parameters of point finder.

Definition at line 126 of file mfpf_point_finder_builder.cxx.

void mfpf_norm_corr2d_builder::set_defaults ( ) [private]

Define default values.

Definition at line 34 of file mfpf_norm_corr2d_builder.cxx.

bool mfpf_norm_corr2d_builder::set_from_stream ( vcl_istream &  is) [virtual]

Initialise from a string stream.

Reimplemented from mfpf_point_finder_builder.

Definition at line 231 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_norm_corr2d_builder::set_kernel_size ( unsigned  ni,
unsigned  nj,
double  ref_x,
double  ref_y 
)

Define size of mask.

Definition at line 61 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_norm_corr2d_builder::set_kernel_size ( unsigned  ni,
unsigned  nj 
)

Define size of mask.

Ref point is centre

Definition at line 69 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_norm_corr2d_builder::set_region_size ( double  wi,
double  wj 
) [virtual]

Define region size in world co-ordinates.

Sets up ROI to cover given box (with samples at step_size()), with ref point at centre. Currently just defines as a box.

Sets up ROI to cover given box (with samples at step_size()), with ref point at centre.

Implements mfpf_point_finder_builder.

Definition at line 79 of file mfpf_norm_corr2d_builder.cxx.

void mfpf_point_finder_builder::set_search_angle_range ( unsigned  nA,
double  dA 
) [inherited]

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, inherited]

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 
) [inherited]

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, inherited]

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, inherited]

Size of step between sample points.

Definition at line 65 of file mfpf_point_finder_builder.h.

short mfpf_norm_corr2d_builder::version_no ( ) const

Version number for I/O.

Reimplemented from mfpf_point_finder_builder.

Definition at line 317 of file mfpf_norm_corr2d_builder.cxx.


Member Data Documentation

Angle displacement.

Definition at line 30 of file mfpf_norm_corr2d_builder.h.

Number of examples added.

Definition at line 40 of file mfpf_norm_corr2d_builder.h.

unsigned mfpf_norm_corr2d_builder::nA_ [private]

Number of angles either side of 0 to sample at.

Definition at line 27 of file mfpf_norm_corr2d_builder.h.

unsigned mfpf_norm_corr2d_builder::ni_ [private]

Kernel mask is ni_ x nj_.

Definition at line 22 of file mfpf_norm_corr2d_builder.h.

unsigned mfpf_norm_corr2d_builder::nj_ [private]

Kernel mask is ni_ x nj_.

Definition at line 24 of file mfpf_norm_corr2d_builder.h.

Relative size of region used for estimating overlap.

If 0.5, then overlap requires pt inside central 50% of region.

Definition at line 34 of file mfpf_norm_corr2d_builder.h.

Kernel reference point (in kni_ x knj_ grid).

Definition at line 17 of file mfpf_norm_corr2d_builder.h.

Kernel reference point (in kni_ x knj_ grid).

Definition at line 19 of file mfpf_norm_corr2d_builder.h.

double mfpf_point_finder_builder::search_dA_ [protected, inherited]

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

Definition at line 36 of file mfpf_point_finder_builder.h.

double mfpf_point_finder_builder::search_ds_ [protected, inherited]

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

Definition at line 42 of file mfpf_point_finder_builder.h.

unsigned mfpf_point_finder_builder::search_nA_ [protected, inherited]

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

Definition at line 33 of file mfpf_point_finder_builder.h.

int mfpf_point_finder_builder::search_ni_ [protected, inherited]

Number of points either side of centre to search.

Definition at line 27 of file mfpf_point_finder_builder.h.

int mfpf_point_finder_builder::search_nj_ [protected, inherited]

Number of points either side of centre to search.

Definition at line 30 of file mfpf_point_finder_builder.h.

unsigned mfpf_point_finder_builder::search_ns_ [protected, inherited]

Number of scales to try at.

Definition at line 39 of file mfpf_point_finder_builder.h.

double mfpf_point_finder_builder::step_size_ [protected, inherited]

Size of step between sample points.

Definition at line 24 of file mfpf_point_finder_builder.h.

Workspace for sum.

Definition at line 37 of file mfpf_norm_corr2d_builder.h.


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