Superclass for histograms working with connectomic networks. More...

#include <mitkConnectomicsHistogramBase.h>

Inheritance diagram for mitk::ConnectomicsHistogramBase:

Collaboration diagram for mitk::ConnectomicsHistogramBase:

Public Member Functions
	ConnectomicsHistogramBase ()

virtual	~ConnectomicsHistogramBase ()

virtual double	GetYMin () const
	Returns the minimal y=f(x) value of the histogram. More...

virtual double	GetYMax () const
	Returns the maximum y=f(x) value of the histogram. More...

virtual double	GetXMin () const
	Returns the minimal x value of the histogram. More...

virtual double	GetXMax () const
	Returns the maximum x value of the histogram. More...

virtual int	GetRange () const
	Returns the range of the histogram. More...

virtual void	UpdateYMax ()
	Update the Y maximum to the maximal value in the histogram. More...

virtual void	ComputeFromBaseData (BaseData *source) override
	Creates a new histogram from the source. More...

virtual void	PrintToConsole () const
	Print values to console. More...

virtual bool	IsValid () const
	Returns whether the histogram can be considered valid. More...

virtual std::string	GetSubject () const
	Returns the subject of the histogram as a string. More...

virtual void	SetSubject (std::string)
	Set the subject of the histogram as a string. More...

virtual float	GetRelativeBin (double start, double end) const override
	Get bin height for the bin between start and end. More...

virtual std::vector< double >	GetHistogramVector ()
	Get the double vector. More...

Protected Member Functions
virtual void	ComputeFromConnectomicsNetwork (ConnectomicsNetwork *source)=0
	Creates a new histogram from the network source. More...

virtual double	GetMin () const override
	Legacy method, do no use. More...

virtual double	GetMax () const override
	Legacy method, do no use. More...

Protected Attributes
bool	m_Valid
	Is this a valid histogram. More...

int	m_BaselineValue
	Which is the baseline value for the histogram This value should be zero for all network histograms. More...

int	m_TopValue
	Which is the top value for the histogram. More...

int	m_StartValue
	Which is the starting x value for the histogram. More...

std::vector< double >	m_HistogramVector
	We expect not continuous but discrete histograms. More...

std::string	m_Subject
	Subject of the histogram as a string. More...

Detailed Description

Superclass for histograms working with connectomic networks.

Definition at line 32 of file mitkConnectomicsHistogramBase.h.

Constructor & Destructor Documentation

mitk::ConnectomicsHistogramBase::ConnectomicsHistogramBase ( )

Definition at line 24 of file mitkConnectomicsHistogramBase.cpp.

mitk::ConnectomicsHistogramBase::~ConnectomicsHistogramBase ( )

virtual

Definition at line 33 of file mitkConnectomicsHistogramBase.cpp.

Member Function Documentation

void mitk::ConnectomicsHistogramBase::ComputeFromBaseData ( BaseData * source )

overridevirtual

Creates a new histogram from the source.

Implements mitk::SimpleHistogram.

Definition at line 98 of file mitkConnectomicsHistogramBase.cpp.

Referenced by mitk::ConnectomicsHistogramsContainer::ComputeFromBaseData().

virtual void mitk::ConnectomicsHistogramBase::ComputeFromConnectomicsNetwork ( ConnectomicsNetwork * source )

protectedpure virtual

Creates a new histogram from the network source.

Implemented in mitk::ConnectomicsShortestPathHistogram, mitk::ConnectomicsBetweennessHistogram, and mitk::ConnectomicsDegreeHistogram.

std::vector< double > mitk::ConnectomicsHistogramBase::GetHistogramVector ( )

virtual

Get the double vector.

Definition at line 223 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetMax ( ) const

overrideprotectedvirtual

Legacy method, do no use.

Implements mitk::SimpleHistogram.

Definition at line 53 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetMin ( ) const

overrideprotectedvirtual

Legacy method, do no use.

Implements mitk::SimpleHistogram.

Definition at line 48 of file mitkConnectomicsHistogramBase.cpp.

int mitk::ConnectomicsHistogramBase::GetRange ( ) const

virtual

Returns the range of the histogram.

Definition at line 68 of file mitkConnectomicsHistogramBase.cpp.

float mitk::ConnectomicsHistogramBase::GetRelativeBin	(	double	start,
		double	end
	)		const

overridevirtual

Get bin height for the bin between start and end.

Implements mitk::SimpleHistogram.

Definition at line 119 of file mitkConnectomicsHistogramBase.cpp.

References mitk::ConnectomicsConstantsManager::CONNECTOMICS_ERROR_BEYOND_SCOPE, mitk::ConnectomicsConstantsManager::CONNECTOMICS_ERROR_OUTSIDE_INTEGER_RANGE, mitk::ConnectomicsConstantsManager::CONNECTOMICS_ERROR_PASSED_NEGATIVE_INDEX_TO_HISTOGRAM, mitk::ConnectomicsConstantsManager::CONNECTOMICS_ERROR_TRIED_TO_ACCESS_INVALID_HISTOGRAM, MBI_WARN, and MITK_ERROR.

std::string mitk::ConnectomicsHistogramBase::GetSubject ( ) const

virtual

Returns the subject of the histogram as a string.

Definition at line 88 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetXMax ( ) const

virtual

Returns the maximum x value of the histogram.

Definition at line 63 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetXMin ( ) const

virtual

Returns the minimal x value of the histogram.

Definition at line 58 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetYMax ( ) const

virtual

Returns the maximum y=f(x) value of the histogram.

Definition at line 43 of file mitkConnectomicsHistogramBase.cpp.

double mitk::ConnectomicsHistogramBase::GetYMin ( ) const

virtual

Returns the minimal y=f(x) value of the histogram.

Definition at line 38 of file mitkConnectomicsHistogramBase.cpp.

bool mitk::ConnectomicsHistogramBase::IsValid ( ) const

virtual

Returns whether the histogram can be considered valid.

Definition at line 73 of file mitkConnectomicsHistogramBase.cpp.

void mitk::ConnectomicsHistogramBase::PrintToConsole ( ) const

virtual

Print values to console.

Definition at line 78 of file mitkConnectomicsHistogramBase.cpp.

References MITK_INFO.

void mitk::ConnectomicsHistogramBase::SetSubject ( std::string subject )

virtual

Set the subject of the histogram as a string.

Definition at line 93 of file mitkConnectomicsHistogramBase.cpp.

void mitk::ConnectomicsHistogramBase::UpdateYMax ( )

virtual

Update the Y maximum to the maximal value in the histogram.

Definition at line 212 of file mitkConnectomicsHistogramBase.cpp.

Member Data Documentation

int mitk::ConnectomicsHistogramBase::m_BaselineValue

protected

Which is the baseline value for the histogram This value should be zero for all network histograms.

Definition at line 86 of file mitkConnectomicsHistogramBase.h.

std::vector< double > mitk::ConnectomicsHistogramBase::m_HistogramVector

protected

We expect not continuous but discrete histograms.

Definition at line 93 of file mitkConnectomicsHistogramBase.h.

int mitk::ConnectomicsHistogramBase::m_StartValue

protected

Which is the starting x value for the histogram.

Definition at line 90 of file mitkConnectomicsHistogramBase.h.

std::string mitk::ConnectomicsHistogramBase::m_Subject

protected

Subject of the histogram as a string.

Definition at line 96 of file mitkConnectomicsHistogramBase.h.

Referenced by mitk::ConnectomicsBetweennessHistogram::ConnectomicsBetweennessHistogram(), mitk::ConnectomicsDegreeHistogram::ConnectomicsDegreeHistogram(), and mitk::ConnectomicsShortestPathHistogram::ConnectomicsShortestPathHistogram().

int mitk::ConnectomicsHistogramBase::m_TopValue

protected

Which is the top value for the histogram.

Definition at line 88 of file mitkConnectomicsHistogramBase.h.

bool mitk::ConnectomicsHistogramBase::m_Valid

protected

Is this a valid histogram.

Definition at line 83 of file mitkConnectomicsHistogramBase.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation