A binary output hyperplane classifier. More...

#include <clsfy_binary_hyperplane.h>

Inheritance diagram for clsfy_binary_hyperplane:

Public Member Functions
virtual void	class_probabilities (vcl_vector< double > &outputs, const vnl_vector< double > &input) const
	Find the posterior probability of the input being in the positive class.
virtual unsigned	classify (const vnl_vector< double > &input) const
	Classify the input vector.
virtual double	log_l (const vnl_vector< double > &input) const
	Log likelihood of being in the positive class.
void	set (const vnl_vector< double > &weights, double bias)
	Set the position of the hyperplane.
const vnl_vector< double > &	weights () const
	Get the classifier weight vector (= hyperplane normal).
double	bias () const
	Get the classifier bias.
virtual unsigned	n_dims () const
	The dimensionality of input vectors.
virtual unsigned	n_classes () const
	The number of possible output classes.
short	version_no () const
	Version number for I/O.
virtual vcl_string	is_a () const
	Name of the class.
virtual bool	is_class (vcl_string const &s) 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 a binary File Stream.
virtual clsfy_classifier_base *	clone () const
	Create a deep copy.
virtual void	b_read (vsl_b_istream &bfs)
	Load the class from a Binary File Stream.
virtual void	classify_many (vcl_vector< unsigned > &outputs, mbl_data_wrapper< vnl_vector< double > > &inputs) const
	Classify many input vectors.
Protected Attributes
vnl_vector< double >	weights_
	Hyperplane normal.
double	bias_
	Bias: \|\|weights_\|\| * distance from origin to hyperplane.

Detailed Description

A binary output hyperplane classifier.

The classifier could be considered as a single perceptron.

Definition at line 18 of file clsfy_binary_hyperplane.h.

Member Function Documentation

void clsfy_binary_hyperplane::b_read ( vsl_b_istream & bfs ) [virtual]

Load the class from a Binary File Stream.

Implements clsfy_classifier_base.

Definition at line 95 of file clsfy_binary_hyperplane.cxx.

void clsfy_binary_hyperplane::b_write ( vsl_b_ostream & bfs ) const [virtual]

Save class to a binary File Stream.

Implements clsfy_classifier_base.

Definition at line 86 of file clsfy_binary_hyperplane.cxx.

double clsfy_binary_hyperplane::bias ( ) const [inline]

Get the classifier bias.

Definition at line 50 of file clsfy_binary_hyperplane.h.

void clsfy_binary_hyperplane::class_probabilities	(	vcl_vector< double > &	outputs,
		const vnl_vector< double > &	input
	)		const `[virtual]`

Find the posterior probability of the input being in the positive class.

The result is outputs(0)

Implements clsfy_classifier_base.

Definition at line 34 of file clsfy_binary_hyperplane.cxx.

unsigned clsfy_binary_hyperplane::classify ( const vnl_vector< double > & input ) const [virtual]

Classify the input vector.

Returns a number between 0 and nClasses-1 inclusive to represent the most likely class

Returns either 0 (for negative class) or 1 (for positive class)

Reimplemented from clsfy_classifier_base.

Definition at line 23 of file clsfy_binary_hyperplane.cxx.

void clsfy_classifier_base::classify_many	(	vcl_vector< unsigned > &	outputs,
		mbl_data_wrapper< vnl_vector< double > > &	inputs
	)		const `[virtual, inherited]`