contrib/mul/mfpf/mfpf_mr_point_finder_builder.h

Go to the documentation of this file.

#ifndef mfpf_mr_point_finder_builder_h_
#define mfpf_mr_point_finder_builder_h_
//:
// \file
// \author Tim Cootes
// \brief Builder for mfpf_mr_point_finder objects.

#include <mfpf/mfpf_point_finder_builder.h>
#include <vgl/vgl_fwd.h>
#include <vcl_cassert.h>
#include <vcl_iosfwd.h>

class vimt_image_pyramid;
class mfpf_mr_point_finder;
class mfpf_pose;

//: Builder for mfpf_mr_point_finder objects.
// Contains a set of mfpf_point_finder_builders,
// each designed to work at a different resolution.
class mfpf_mr_point_finder_builder
{
 protected:

  //: Set of cost function objects.
  vcl_vector<mfpf_point_finder_builder*> builders_;

  //: Delete all the builders
  void delete_all();

 public:

  //: Dflt ctor
  mfpf_mr_point_finder_builder();

  //: Copy ctor
  mfpf_mr_point_finder_builder(const mfpf_mr_point_finder_builder&);

  //: Copy operator
  //  Required to deal with correct cloning of builders
  mfpf_mr_point_finder_builder& operator=(const mfpf_mr_point_finder_builder&);

  //: Destructor
  virtual ~mfpf_mr_point_finder_builder();

  //: Number of builders
  unsigned size() const { return builders_.size(); }

  //: Builder at level L
  const mfpf_point_finder_builder& builder(unsigned L) const
  { assert (L<builders_.size()); return *builders_[L]; }

  //: Builder at level L
  mfpf_point_finder_builder& builder(unsigned L)
  { assert (L<builders_.size()); return *builders_[L]; }

  //: Set number of builders. Any existing builders are retained
  void set_n_levels(unsigned n);

  //: Define builders.  Clone of each taken
  void set(const vcl_vector<mfpf_point_finder_builder*>& builders);

  //: Set up n builders, with step size step0*scale_step^L
  //  Takes clones of builder and sets up step sizes.
  //  Top level search parameters retained.
  //  Finer res models have search area and scale/angle
  //  ranges set to allow efficient refinement.
  void set(const mfpf_point_finder_builder& builder,
           unsigned n, double step0, double scale_step);

  //: Set up multiple builders to cover patch of size wi x wj
  //  Patch defined in world co-ords.  Selects suitable scales
  //  and levels so that region is covered and at any given
  //  level the model width (in number of samples) is in the range
  //  [min_n_samples,max_n_samples].
  //  \param base_pixel_width Pixel width in base image
  void set_size_and_levels(
                const mfpf_point_finder_builder& builder0,
                double wi, double wj,
                double scale_step,
                int min_n_samples,
                int max_n_samples,
                double base_pixel_width=1.0);

  //: Define region size in world co-ordinates
  //  Sets up ROI in each model to cover given box (in world coords),
  //  with ref point at centre.
  //  Assumes that models exist and have step size defined.
  void set_region_size(double wi, double wj);

  //: Select best level for building model using u as basis
  //  Selects pyramid level with pixel sizes best matching
  //  the model pixel size at given basis vector u.
  unsigned image_level(unsigned i,
                       const vgl_vector_2d<double>& u,
                       const vimt_image_pyramid& im_pyr) const;

  //: Initialise building
  // Must be called before any calls to add_example(...)
  void clear(unsigned n_egs);

  //: Get sample image at specified point for level L of the point_finder hierarchy
  void get_sample_vector(const vimt_image_pyramid& image_pyr,
                         const vgl_point_2d<double>& p,
                         const vgl_vector_2d<double>& u,
                         unsigned L,
                         vcl_vector<double>& v);

  //: Add one example to the model
  void add_example(const vimt_image_pyramid& image_pyr,
                   const vgl_point_2d<double>& p,
                   const vgl_vector_2d<double>& u);

  //: Build object from the data supplied in add_example()
  void build(mfpf_mr_point_finder&);

  //: Version number for I/O
  short version_no() const;

  //: Name of the class
  virtual vcl_string is_a() const;

  //: Print class to os
  virtual void print_summary(vcl_ostream& os) const;

  //: Save class to binary file stream
  virtual void b_write(vsl_b_ostream& bfs) const;

  //: Load class from binary file stream
  virtual void b_read(vsl_b_istream& bfs);
};

//: Stream output operator for class reference
vcl_ostream& operator<<(vcl_ostream& os,const mfpf_mr_point_finder_builder& b);

//: Binary file stream output operator for class reference
void vsl_b_write(vsl_b_ostream& bfs, const mfpf_mr_point_finder_builder& b);

//: Binary file stream input operator for class reference
void vsl_b_read(vsl_b_istream& bfs, mfpf_mr_point_finder_builder& b);

#endif // mfpf_mr_point_finder_builder_h_