contrib/gel/vifa/vifa_int_face_attr_common_params.h

Go to the documentation of this file.

// This is gel/vifa/vifa_int_face_attr_common_params.h
#ifndef VIFA_INT_FACE_ATTR_COMMON_PARAMS_H
#define VIFA_INT_FACE_ATTR_COMMON_PARAMS_H

//-----------------------------------------------------------------------------
//:
// \file
// \brief Parameter mixin for intensity face attribute computation.
//
// \author Anthony Hoogs, from DDB in TargetJr
//
// \date January 2001
//
// The parameter mixin for intensity face attribute computation, for
// attributes common to single faces and groups of faces.
//
// \verbatim
//  Modifications:
//   MPP Mar/Apr 2003, Ported to VXL
// \endverbatim
//-----------------------------------------------------------------------------

#include <gevd/gevd_param_mixin.h>
#include <vul/vul_timestamp.h>
#include <vbl/vbl_ref_count.h>
#include <vdgl/vdgl_fit_lines_params.h>
#include <vifa/vifa_coll_lines_params.h>
#include <vifa/vifa_group_pgram_params.h>
#include <vifa/vifa_norm_params.h>
#include <vifa/vifa_typedefs.h>


//: Container holding parameters for common intensity face attribute computations.
class vifa_int_face_attr_common_params : public gevd_param_mixin,
                     public vul_timestamp,
                     public vbl_ref_count
{
 protected:
  vdgl_fit_lines_params_sptr    fitter_params_;
  vifa_group_pgram_params_sptr  gpp_s_;
  vifa_group_pgram_params_sptr  gpp_w_;
  vifa_coll_lines_params_sptr   cpp_;
  vifa_norm_params_sptr         np_;

 public:
  //: Line fitting parameters (incl. fit_length).
  vdgl_fit_lines_params_sptr    fitter_params() { return fitter_params_; }

  //: Strong projected parallelism parameters.
  vifa_group_pgram_params_sptr  gpp_s() { return gpp_s_; }

  //: Weak projected parallelism parameters.
  vifa_group_pgram_params_sptr  gpp_w() { return gpp_w_; }

  //: Collinearization parameters.
  vifa_coll_lines_params_sptr   cpp() { return cpp_; }

  //: Pixel normalization parameters.
  vifa_norm_params_sptr         np() { return np_; }

 public:
  //: Default constructor.
  vifa_int_face_attr_common_params(vdgl_fit_lines_params*    fitter_params = 0,
                                   vifa_group_pgram_params*  gpp_s = NULL,
                                   vifa_group_pgram_params*  gpp_w = NULL,
                                   vifa_coll_lines_params*   cpp = NULL,
                                   vifa_norm_params*         np = NULL
                                  );

  //: Copy constructor.
  vifa_int_face_attr_common_params(const vifa_int_face_attr_common_params&  old_params);

  //: Destructor.
  virtual ~vifa_int_face_attr_common_params(void);

  //: Publicly available setting of parameters.
  void  set_params(const vifa_int_face_attr_common_params&  ifap);

  //: Check that parameters are within acceptable bounds.
  bool  SanityCheck();

  //: Output contents
  void  print_info(void);

 protected:
  //: Assign internal parameter blocks.
  void  init_params(vdgl_fit_lines_params*    fitter_params,
                    vifa_group_pgram_params*  gpp_s,
                    vifa_group_pgram_params*  gpp_w,
                    vifa_coll_lines_params*   cpp,
                    vifa_norm_params*         np
                   );
  void  init_params(const vdgl_fit_lines_params&    fitter_params,
                    const vifa_group_pgram_params&  gpp_s,
                    const vifa_group_pgram_params&  gpp_w,
                    const vifa_coll_lines_params&   cpp,
                    const vifa_norm_params&         np
                   );
};

#endif  // VIFA_INT_FACE_ATTR_COMMON_PARAMS_H