FREE::StatisticDictionary

FREE::StatisticDictionary Class Reference
[Statistics]

Class contains the dictionary information of a statistic. More...

#include <freStatisticDictionary.h>

Inheritance diagram for FREE::StatisticDictionary:

Inheritance graph
FREE::XMLStreamObject
[legend]
Collaboration diagram for FREE::StatisticDictionary:

Collaboration graph
FREE::XMLStreamObjectFREE::XMLCollectionBase\< TXMLElement \>FREE::SmartCollectionBase\< TXMLElement \>FREE::CollectionBase\< TXMLElement, itk::SmartPointer\< TXMLElement \> \>
[legend]

List of all members.

Public Types

typedef
StatisticDictionary 		Self
typedef itk::LightObject Superclass
typedef
itk::SmartPointer
< Self > 		Pointer
typedef
itk::SmartPointer
< const Self > 		ConstPointer
typedef
StatisticValueDefinition::IDType 		ValueIDType
typedef
StatisticEntryDefinition::IDType 		EntryIDType
typedef unsigned long IndexType
typedef
XMLCollectionBase
< StatisticValueDefinition > 		ValueDefinitionsType
typedef
XMLCollectionBase
< StatisticEntryDefinition > 		EntryDefinitionsType

Public Member Functions

 itkTypeMacro (StatisticDictionary, XMLStreamObject)
 itkNewMacro (StatisticDictionary)
StatisticValueDefinition * AddValueDefinition ()
StatisticValueDefinition * AddValueDefinition (const std::string &sIDPath, const std::string &sName, const std::string &sDescription)
StatisticValueDefinition * GetValueDefinitionByName (const std::string &sIDPath, const std::string &sName)
StatisticValueDefinition * GetValueDefinitionByIndex (const IndexType &index)
StatisticValueDefinition * GetValueDefinitionByID (const ValueIDType &id)
ValueIDType GetValueDefinitionIDByName (const std::string &sIDPath, const std::string &sName)
StatisticEntryDefinition * AddEntryDefinition ()
StatisticEntryDefinition * AddEntryDefinition (const std::string &sIDPath, const std::string &sName, const std::string &sControllerID, const std::string &sDescription)
StatisticEntryDefinition * GetEntryDefinitionByName (const std::string &sIDPath, const std::string &sName)
StatisticEntryDefinition * GetEntryDefinitionByIndex (const IndexType &index)
StatisticEntryDefinition * GetEntryDefinitionByID (const EntryIDType &id)
EntryIDType GetEntryDefinitionIDByName (const std::string &sIDPath, const std::string &sName)
virtual ~StatisticDictionary ()
virtual void Reset ()

Protected Member Functions

 StatisticDictionary ()
virtual void SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)
virtual std::string SaveData (const unsigned int &iDepth, bool &bHasSubElements) const

Protected Attributes

ValueDefinitionsType m_ValueDefs
EntryDefinitionsType m_EntryDefs

Detailed Description

Class contains the dictionary information of a statistic.

The dictionary can be used to store general information about the different entries and values logged in the statistic.

Definition at line 45 of file freStatisticDictionary.h.

Member Typedef Documentation

typedef StatisticDictionary FREE::StatisticDictionary::Self

Definition at line 48 of file freStatisticDictionary.h.

typedef itk::LightObject FREE::StatisticDictionary::Superclass

Definition at line 49 of file freStatisticDictionary.h.

typedef itk::SmartPointer<Self> FREE::StatisticDictionary::Pointer

Definition at line 50 of file freStatisticDictionary.h.

typedef itk::SmartPointer<const Self> FREE::StatisticDictionary::ConstPointer

Definition at line 51 of file freStatisticDictionary.h.

typedef StatisticValueDefinition::IDType FREE::StatisticDictionary::ValueIDType

Definition at line 56 of file freStatisticDictionary.h.

typedef StatisticEntryDefinition::IDType FREE::StatisticDictionary::EntryIDType

Definition at line 57 of file freStatisticDictionary.h.

typedef unsigned long FREE::StatisticDictionary::IndexType

Definition at line 58 of file freStatisticDictionary.h.

typedef XMLCollectionBase<StatisticValueDefinition> FREE::StatisticDictionary::ValueDefinitionsType

Definition at line 60 of file freStatisticDictionary.h.

typedef XMLCollectionBase<StatisticEntryDefinition> FREE::StatisticDictionary::EntryDefinitionsType

Definition at line 61 of file freStatisticDictionary.h.

Constructor & Destructor Documentation

FREE::StatisticDictionary::~StatisticDictionary (  )  [virtual]

Definition at line 172 of file freStatisticDictionary.cxx.

References Reset().

Here is the call graph for this function:

FREE::StatisticDictionary::ResetFREE::XMLCollectionBase::ResetFREE::XMLStreamObject::Reset

FREE::StatisticDictionary::StatisticDictionary (  )  [protected]

Definition at line 164 of file freStatisticDictionary.cxx.

References Reset().

Here is the call graph for this function:

FREE::StatisticDictionary::ResetFREE::XMLCollectionBase::ResetFREE::XMLStreamObject::Reset

Member Function Documentation

FREE::StatisticDictionary::itkTypeMacro ( StatisticDictionary  ,
XMLStreamObject   
)

FREE::StatisticDictionary::itkNewMacro ( StatisticDictionary   ) 

StatisticValueDefinition * FREE::StatisticDictionary::AddValueDefinition (  ) 

Implementation of FREE::StatisticDictionary ////////////////////////

Definition at line 34 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::AddElement(), FREE::SmartCollectionBase< TElement >::GetElement(), m_ValueDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Referenced by AddValueDefinition(), FREE::PrecisionSOMetric< VImageDimension >::EnlistDictionaryEntries(), FREE::ImageDifferenceSOMetricMonitor::EnlistDictionaryEntries(), FREE::ImageClassificationSOMetricMonitor::EnlistDictionaryEntries(), FREE::AccuracySOMetricMonitor::EnlistDictionaryEntries(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::VersorTransformOptimizerController::SetStatisticEntryMainComponent(), FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), FREE::SPSASOOptimizerController::SetStatisticEntryMainComponent(), FREE::SPSAOptimizerController::SetStatisticEntryMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::SetStatisticEntryMainComponent(), FREE::PrecisionSOMetricController::SetStatisticEntryMainComponent(), FREE::PowellSOOptimizerController::SetStatisticEntryMainComponent(), FREE::PowellOptimizerController::SetStatisticEntryMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::SetStatisticEntryMainComponent(), FREE::OptimizerControllerBase< TControlledOptimizer >::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::SetStatisticEntryMainComponent(), FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::LBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SetStatisticEntryMainComponent(), FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::GradientDescentOptimizerController::SetStatisticEntryMainComponent(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::SetStatisticEntryMainComponent(), FREE::ExhaustiveSOOptimizerController::SetStatisticEntryMainComponent(), FREE::ExhaustiveOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), FREE::ESCMAMutationController::SetStatisticEntryMainComponent(), FREE::ContinuousLBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), FREE::ConsistencySOMetricControllerBase< FREE::ConsistencyRegistrationMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConjugateGradientOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaOptimizerController::SetStatisticEntryMainComponent(), and FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent().

Here is the call graph for this function:

FREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticValueDefinition * FREE::StatisticDictionary::AddValueDefinition ( const std::string &  sIDPath,
const std::string &  sName,
const std::string &  sDescription 
)

Definition at line 47 of file freStatisticDictionary.cxx.

References AddValueDefinition().

Here is the call graph for this function:

FREE::StatisticDictionary::AddValueDefinitionFREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticValueDefinition * FREE::StatisticDictionary::GetValueDefinitionByName ( const std::string &  sIDPath,
const std::string &  sName 
)

Definition at line 58 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), m_ValueDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Referenced by GetValueDefinitionIDByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::VersorTransformOptimizerController::SetStatisticEntryMainComponent(), FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), FREE::SPSASOOptimizerController::SetStatisticEntryMainComponent(), FREE::SPSAOptimizerController::SetStatisticEntryMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::SetStatisticEntryMainComponent(), FREE::PrecisionSOMetricController::SetStatisticEntryMainComponent(), FREE::PowellSOOptimizerController::SetStatisticEntryMainComponent(), FREE::PowellOptimizerController::SetStatisticEntryMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::SetStatisticEntryMainComponent(), FREE::OptimizerControllerBase< TControlledOptimizer >::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::SetStatisticEntryMainComponent(), FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::LBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SetStatisticEntryMainComponent(), FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::GradientDescentOptimizerController::SetStatisticEntryMainComponent(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::SetStatisticEntryMainComponent(), FREE::ExhaustiveSOOptimizerController::SetStatisticEntryMainComponent(), FREE::ExhaustiveOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), FREE::ESCMAMutationController::SetStatisticEntryMainComponent(), FREE::ContinuousLBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), FREE::ConsistencySOMetricControllerBase< FREE::ConsistencyRegistrationMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConjugateGradientOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaOptimizerController::SetStatisticEntryMainComponent(), and FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent().

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticValueDefinition * FREE::StatisticDictionary::GetValueDefinitionByIndex ( const IndexType &  index  ) 

Definition at line 70 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), and m_ValueDefs.

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElement

StatisticValueDefinition * FREE::StatisticDictionary::GetValueDefinitionByID ( const ValueIDType &  id  ) 

Definition at line 77 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), m_ValueDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticDictionary::ValueIDType FREE::StatisticDictionary::GetValueDefinitionIDByName ( const std::string &  sIDPath,
const std::string &  sName 
)

Definition at line 89 of file freStatisticDictionary.cxx.

References FREE::StatisticValueDefinition::GetRefID(), and GetValueDefinitionByName().

Here is the call graph for this function:

FREE::StatisticValueDefinition::GetRefIDFREE::StatisticDictionary::GetValueDefinitionByNameFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticEntryDefinition * FREE::StatisticDictionary::AddEntryDefinition (  ) 

Definition at line 99 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::AddElement(), FREE::SmartCollectionBase< TElement >::GetElement(), m_EntryDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Referenced by AddEntryDefinition(), FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::PrecisionSOMetric< VImageDimension >::EnlistDictionaryEntries(), FREE::SetupOptimizationMetricMonitorBase< TResultClass >::Initialize(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

Here is the call graph for this function:

FREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticEntryDefinition * FREE::StatisticDictionary::AddEntryDefinition ( const std::string &  sIDPath,
const std::string &  sName,
const std::string &  sControllerID,
const std::string &  sDescription 
)

Definition at line 112 of file freStatisticDictionary.cxx.

References AddEntryDefinition().

Here is the call graph for this function:

FREE::StatisticDictionary::AddEntryDefinitionFREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticEntryDefinition * FREE::StatisticDictionary::GetEntryDefinitionByName ( const std::string &  sIDPath,
const std::string &  sName 
)

Definition at line 124 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), m_EntryDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), GetEntryDefinitionIDByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticEntryDefinition * FREE::StatisticDictionary::GetEntryDefinitionByIndex ( const IndexType &  index  ) 

Definition at line 136 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), and m_EntryDefs.

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElement

StatisticEntryDefinition * FREE::StatisticDictionary::GetEntryDefinitionByID ( const EntryIDType &  id  ) 

Definition at line 143 of file freStatisticDictionary.cxx.

References FREE::SmartCollectionBase< TElement >::GetElement(), m_EntryDefs, and FREE::CollectionBase< TElement, TStorageType >::Size().

Here is the call graph for this function:

FREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

StatisticDictionary::EntryIDType FREE::StatisticDictionary::GetEntryDefinitionIDByName ( const std::string &  sIDPath,
const std::string &  sName 
)

Definition at line 155 of file freStatisticDictionary.cxx.

References GetEntryDefinitionByName(), and FREE::StatisticEntryDefinition::GetRefID().

Here is the call graph for this function:

FREE::StatisticDictionary::GetEntryDefinitionByNameFREE::StatisticEntryDefinition::GetRefIDFREE::SmartCollectionBase::GetElementFREE::CollectionBase::Size

void FREE::StatisticDictionary::Reset (  )  [virtual]

Resets the value to an empty string and undefined type.

Reimplemented from FREE::XMLStreamObject.

Definition at line 179 of file freStatisticDictionary.cxx.

References m_EntryDefs, m_ValueDefs, and FREE::XMLCollectionBase< TXMLElement >::Reset().

Referenced by StatisticDictionary(), and ~StatisticDictionary().

Here is the call graph for this function:

FREE::XMLCollectionBase::ResetFREE::XMLStreamObject::Reset

void FREE::StatisticDictionary::SubElementLoadProcessing ( const std::string &  rsXMLSubTag,
const std::string &  rsXMLSubElement,
const std::string &  rsXMLSubData 
) [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 187 of file freStatisticDictionary.cxx.

References FREE::XMLStreamObject::LoadFromString(), m_EntryDefs, and m_ValueDefs.

Here is the call graph for this function:

FREE::XMLStreamObject::LoadFromStringFREE::XMLStreamObject::CB_Static_EndElementFREE::XMLStreamObject::CB_Static_StartElementFREE::XMLStreamObject::CheckValidLoadingFREE::XMLStreamObject::FinalizeLoadingFREE::XMLStreamObject::ResetFREE::XMLStreamObject::ResetLoadingHelpersFREE::XMLStreamObject::ResetRequirementsFREE::Convert::ToStrFREE::XMLStreamObject::CB_EndElementFREE::XMLStreamObject::CB_Static_CharacterDataHandlerFREE::XMLStreamObject::CommitSubElementFREE::XMLStreamObject::CB_CharacterDataHandlerFREE::XMLStreamObject::ExtractSubElementContentStringFREE::XMLStreamObject::ExtractSubElementXmlStringFREE::XMLStreamObject::NotifyFoundSubElementFREE::XMLStreamObject::SubElementLoadProcessingFREE::XMLStreamObject::CB_StartElementFREE::XMLStreamObject::AttributesLoadProcessingFREE::XMLStreamObject::ConvertExpatAttrToMapFREE::XMLStreamObject::GetXMLTagFREE::XMLStreamObject::SetNeededSubElements

std::string FREE::StatisticDictionary::SaveData ( const unsigned int &  iDepth,
bool &  bHasSubElements 
) const [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 201 of file freStatisticDictionary.cxx.

References FREE::XMLStreamObject::AddSubElement(), m_EntryDefs, and m_ValueDefs.

Here is the call graph for this function:

FREE::XMLStreamObject::AddSubElementFREE::XMLStreamObject::AddIndentationFREE::XMLStreamObject::CreateSimpleElementFREE::Convert::ToStr

Member Data Documentation

ValueDefinitionsType FREE::StatisticDictionary::m_ValueDefs [protected]

Definition at line 92 of file freStatisticDictionary.h.

Referenced by AddValueDefinition(), GetValueDefinitionByID(), GetValueDefinitionByIndex(), GetValueDefinitionByName(), Reset(), SaveData(), and SubElementLoadProcessing().

EntryDefinitionsType FREE::StatisticDictionary::m_EntryDefs [protected]

Definition at line 93 of file freStatisticDictionary.h.

Referenced by AddEntryDefinition(), GetEntryDefinitionByID(), GetEntryDefinitionByIndex(), GetEntryDefinitionByName(), Reset(), SaveData(), and SubElementLoadProcessing().

The documentation for this class was generated from the following files:
Generated at Sat Oct 13 18:29:38 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000