CPDetectorSetting Class Reference

class, which stores all settings of one cp detector More...

#include <CPDetectorConfig.h>

Public Member Functions
	CPDetectorSetting ()
	constructor
virtual	~CPDetectorSetting ()
	destructor
bool	Read (wxConfigBase *config, wxString path)
	read setting for this generator from config
void	Write (wxConfigBase *config, wxString path)
	writes setting for this generator to config
const wxString	GetCPDetectorDesc ()
	return description of this setting
void	SetCPDetectorDesc (wxString new_desc)
	sets description of this setting
const CPDetectorType	GetType ()
	return type of this setting
void	SetType (CPDetectorType new_type)
	sets type of this setting
const wxString	GetProg ()
	return program for one step detector or feature descriptor
void	SetProg (wxString new_prog)
	sets program for one step detector or feature descriptor
const wxString	GetArgs ()
	return arguments of one step detector or feature descriptor
void	SetArgs (wxString new_args)
	sets arguments of one step detector or feature descriptor
const wxString	GetArgsCleanup ()
	return arguments for the cleanup step
void	SetArgsCleanup (wxString new_args)
	sets arguments for the cleanup step
const wxString	GetProgMatcher ()
	return program for feature matcher
void	SetProgMatcher (wxString new_prog)
	sets program for feature matcher
const wxString	GetArgsMatcher ()
	return arguments for feature matcher
void	SetArgsMatcher (wxString new_args)
	sets arguments for feature matcher
const wxString	GetProgStack ()
	return program name, which works on stacks
void	SetProgStack (wxString new_prog)
	sets program for detecting cp in stacks
const wxString	GetArgsStack ()
	return arguments of program for detection of cp in stacks
void	SetArgsStack (wxString new_args)
	sets arguments of program for detection of cp in stacks
const bool	GetOption ()
	gets options, used in multi-row and prealigned cp detectors
void	SetOption (bool new_option)
	set options, used in multi-row cp and prealigned detectors
const bool	IsTwoStepDetector ()
	returns true, if setting is suitable for two step detector otherwise false
const bool	IsCleanupPossible ()
const bool	ContainsStacks ()

Static Public Member Functions
static const bool	IsCleanupPossible (CPDetectorType _type)
	return true, if setting allows a final cleanup run
static const bool	ContainsStacks (CPDetectorType _type)
	return true, if setting contains a stack detector, even it is empty

Private Member Functions
void	CheckValues ()

Private Attributes
CPDetectorType	type
wxString	desc
wxString	prog
wxString	args
wxString	args_cleanup
wxString	prog_matcher
wxString	args_matcher
wxString	prog_stack
wxString	args_stack
bool	option

Detailed Description

class, which stores all settings of one cp detector

Definition at line 47 of file CPDetectorConfig.h.

Constructor & Destructor Documentation

CPDetectorSetting()

CPDetectorSetting::CPDetectorSetting

(

)

constructor

Definition at line 171 of file CPDetectorConfig.cpp.

References args, args_cleanup, args_matcher, args_stack, CheckValues(), CPDetector_AutoPanoSift, default_cpgenerator_args(), default_cpgenerator_desc(), default_cpgenerator_prog(), desc, option, prog, prog_matcher, prog_stack, threshold(), and type.

~CPDetectorSetting()

virtual CPDetectorSetting::~CPDetectorSetting ( )

inlinevirtual

destructor

Definition at line 53 of file CPDetectorConfig.h.

Member Function Documentation

CheckValues()

void CPDetectorSetting::CheckValues ( )

private

Definition at line 186 of file CPDetectorConfig.cpp.

References args_matcher, CPDetector_AutoPano, prog_matcher, threshold(), and type.

Referenced by CPDetectorSetting(), and Read().

ContainsStacks() [1/2]

const bool CPDetectorSetting::ContainsStacks ( )

inline

Definition at line 106 of file CPDetectorConfig.h.

References ContainsStacks().

Referenced by CPDetectorDialog::ChangeType(), ContainsStacks(), CPDetectorDialog::OnOk(), Read(), and Write().

ContainsStacks() [2/2]

const bool CPDetectorSetting::ContainsStacks ( CPDetectorType  _type )

static

return true, if setting contains a stack detector, even it is empty

Definition at line 205 of file CPDetectorConfig.cpp.

References CPDetector_AutoPanoSiftMultiRowStack, CPDetector_AutoPanoSiftStack, and threshold().

GetArgs()

const wxString CPDetectorSetting::GetArgs ( )

inline

return arguments of one step detector or feature descriptor

Definition at line 72 of file CPDetectorConfig.h.

GetArgsCleanup()

const wxString CPDetectorSetting::GetArgsCleanup ( )

inline

return arguments for the cleanup step

Definition at line 76 of file CPDetectorConfig.h.

GetArgsMatcher()

const wxString CPDetectorSetting::GetArgsMatcher ( )

inline

return arguments for feature matcher

Definition at line 84 of file CPDetectorConfig.h.

GetArgsStack()

const wxString CPDetectorSetting::GetArgsStack ( )

inline

return arguments of program for detection of cp in stacks

Definition at line 92 of file CPDetectorConfig.h.

GetCPDetectorDesc()

const wxString CPDetectorSetting::GetCPDetectorDesc ( )

inline

return description of this setting

Definition at line 60 of file CPDetectorConfig.h.

GetOption()

const bool CPDetectorSetting::GetOption ( )

inline

gets options, used in multi-row and prealigned cp detectors

Definition at line 96 of file CPDetectorConfig.h.

GetProg()

const wxString CPDetectorSetting::GetProg ( )

inline

return program for one step detector or feature descriptor

Definition at line 68 of file CPDetectorConfig.h.

GetProgMatcher()

const wxString CPDetectorSetting::GetProgMatcher ( )

inline

return program for feature matcher

Definition at line 80 of file CPDetectorConfig.h.

GetProgStack()

const wxString CPDetectorSetting::GetProgStack ( )

inline

return program name, which works on stacks

Definition at line 88 of file CPDetectorConfig.h.

GetType()

const CPDetectorType CPDetectorSetting::GetType ( )

inline

return type of this setting

Definition at line 64 of file CPDetectorConfig.h.

IsCleanupPossible() [1/2]

const bool CPDetectorSetting::IsCleanupPossible ( )

inline

Definition at line 103 of file CPDetectorConfig.h.

References IsCleanupPossible().

Referenced by CPDetectorDialog::ChangeType(), IsCleanupPossible(), Read(), and Write().

IsCleanupPossible() [2/2]

const bool CPDetectorSetting::IsCleanupPossible ( CPDetectorType  _type )

static

return true, if setting allows a final cleanup run

Definition at line 198 of file CPDetectorConfig.cpp.

References CPDetector_AutoPanoSiftMultiRow, CPDetector_AutoPanoSiftMultiRowStack, CPDetector_AutoPanoSiftPreAlign, and threshold().

IsTwoStepDetector()

const bool CPDetectorSetting::IsTwoStepDetector ( )

inline

returns true, if setting is suitable for two step detector otherwise false

Definition at line 100 of file CPDetectorConfig.h.

Read()

bool CPDetectorSetting::Read	(	wxConfigBase *	config,
		wxString	path
	)

read setting for this generator from config

Returns

true on success

Definition at line 210 of file CPDetectorConfig.cpp.

References args, args_cleanup, args_matcher, args_stack, CheckValues(), ContainsStacks(), CPDetector_AutoPanoSift, default_cpgenerator_args(), default_cpgenerator_desc(), default_cpgenerator_prog(), desc, IsCleanupPossible(), option, prog, prog_matcher, prog_stack, threshold(), and type.

SetArgs()

void CPDetectorSetting::SetArgs ( wxString  new_args )

inline

sets arguments of one step detector or feature descriptor

Definition at line 74 of file CPDetectorConfig.h.

References threshold().

SetArgsCleanup()

void CPDetectorSetting::SetArgsCleanup ( wxString  new_args )

inline

sets arguments for the cleanup step

Definition at line 78 of file CPDetectorConfig.h.

References threshold().

SetArgsMatcher()

void CPDetectorSetting::SetArgsMatcher ( wxString  new_args )

inline

sets arguments for feature matcher

Definition at line 86 of file CPDetectorConfig.h.

References threshold().

SetArgsStack()

void CPDetectorSetting::SetArgsStack ( wxString  new_args )

inline

sets arguments of program for detection of cp in stacks

Definition at line 94 of file CPDetectorConfig.h.

References threshold().

SetCPDetectorDesc()

void CPDetectorSetting::SetCPDetectorDesc ( wxString  new_desc )

inline

sets description of this setting

Definition at line 62 of file CPDetectorConfig.h.

References threshold().

SetOption()

void CPDetectorSetting::SetOption ( bool  new_option )

inline

set options, used in multi-row cp and prealigned detectors

Definition at line 98 of file CPDetectorConfig.h.

References threshold().

SetProg()

void CPDetectorSetting::SetProg ( wxString  new_prog )

inline

sets program for one step detector or feature descriptor

Definition at line 70 of file CPDetectorConfig.h.

References threshold().

Referenced by AutoPanoSiftMultiRow::automatch(), and CPEditorPanel::OnCreateCPButton().

SetProgMatcher()

void CPDetectorSetting::SetProgMatcher ( wxString  new_prog )

inline

sets program for feature matcher

Definition at line 82 of file CPDetectorConfig.h.

References threshold().

SetProgStack()

void CPDetectorSetting::SetProgStack ( wxString  new_prog )

inline

sets program for detecting cp in stacks

Definition at line 90 of file CPDetectorConfig.h.

References threshold().

SetType()

void CPDetectorSetting::SetType ( CPDetectorType  new_type )

inline

sets type of this setting

Definition at line 66 of file CPDetectorConfig.h.

References threshold().

Referenced by AutoPanoSiftStack::automatch(), and AutoPanoSiftMultiRowStack::automatch().

Write()

void CPDetectorSetting::Write	(	wxConfigBase *	config,
		wxString	path
	)

writes setting for this generator to config

Definition at line 245 of file CPDetectorConfig.cpp.

References args, args_cleanup, args_matcher, args_stack, ContainsStacks(), desc, IsCleanupPossible(), option, prog, prog_matcher, prog_stack, threshold(), and type.

Referenced by CPDetectorConfig::Write().

Member Data Documentation

args

wxString CPDetectorSetting::args

private

Definition at line 112 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

args_cleanup

wxString CPDetectorSetting::args_cleanup

private

Definition at line 113 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

args_matcher

wxString CPDetectorSetting::args_matcher

private

Definition at line 115 of file CPDetectorConfig.h.

Referenced by CheckValues(), CPDetectorSetting(), Read(), and Write().

args_stack

wxString CPDetectorSetting::args_stack

private

Definition at line 117 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

desc

wxString CPDetectorSetting::desc

private

Definition at line 110 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

option

bool CPDetectorSetting::option

private

Definition at line 118 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

prog

wxString CPDetectorSetting::prog

private

Definition at line 111 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

prog_matcher

wxString CPDetectorSetting::prog_matcher

private

Definition at line 114 of file CPDetectorConfig.h.

Referenced by CheckValues(), CPDetectorSetting(), Read(), and Write().

prog_stack

wxString CPDetectorSetting::prog_stack

private

Definition at line 116 of file CPDetectorConfig.h.

Referenced by CPDetectorSetting(), Read(), and Write().

type

CPDetectorType CPDetectorSetting::type

private

Definition at line 109 of file CPDetectorConfig.h.

Referenced by CheckValues(), CPDetectorSetting(), Read(), and Write().

---

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

• hugin1/icpfind/CPDetectorConfig.h
• hugin1/icpfind/CPDetectorConfig.cpp