Medical Imaging Interaction Toolkit  2018.4.99-1640525a
Medical Imaging Interaction Toolkit
mitk::ImageStatisticsContainer Class Reference

Container class for storing a StatisticsObject for each timestep. More...

#include <mitkImageStatisticsContainer.h>

Inheritance diagram for mitk::ImageStatisticsContainer:
Collaboration diagram for mitk::ImageStatisticsContainer:

Classes

class  ImageStatisticsObject
 Container class for storing the computed image statistics. More...
 

Public Types

using HistogramType = itk::Statistics::Histogram< double >
 
using RealType = double
 
using LabelIndex = unsigned int
 
using IndexType = vnl_vector< int >
 
using VoxelCountType = unsigned long
 
using StatisticsVariantType = boost::variant< RealType, VoxelCountType, IndexType >
 
using StatisticsMapType = std::map< std::string, StatisticsVariantType >
 
using StatisticsKeyType = std::string
 
using TimeStepMapType = std::map< TimeStepType, ImageStatisticsObject >
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (ImageStatisticsContainer, mitk::BaseData)
 
Pointer Clone () const
 
void SetRequestedRegionToLargestPossibleRegion () override
 Set the RequestedRegion to the LargestPossibleRegion. More...
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Determine whether the RequestedRegion is outside of the BufferedRegion. More...
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
void SetRequestedRegion (const itk::DataObject *) override
 Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...
 
unsigned int GetNumberOfTimeSteps () const
 
void Reset ()
 Deletes all stored values. More...
 
const ImageStatisticsObjectGetStatisticsForTimeStep (TimeStepType timeStep) const
 Returns the statisticObject for the given Timestep. More...
 
void SetStatisticsForTimeStep (TimeStepType timeStep, ImageStatisticsObject statistics)
 Sets the statisticObject for the given Timestep. More...
 
bool TimeStepExists (TimeStepType timeStep) const
 Checks if the Time step exists. More...
 
const HistogramTypeGetHistogramForTimeStep (TimeStepType timeStep) const
 
- Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
virtual UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 ImageStatisticsContainer ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

Additional Inherited Members

- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Container class for storing a StatisticsObject for each timestep.

Stored statistics are:

  • for the defined statistics, see GetAllStatisticNames
  • Histogram of Pixel Values

Definition at line 33 of file mitkImageStatisticsContainer.h.

Member Typedef Documentation

◆ HistogramType

using mitk::ImageStatisticsContainer::HistogramType = itk::Statistics::Histogram<double>

Definition at line 40 of file mitkImageStatisticsContainer.h.

◆ IndexType

Definition at line 43 of file mitkImageStatisticsContainer.h.

◆ LabelIndex

Definition at line 42 of file mitkImageStatisticsContainer.h.

◆ RealType

◆ StatisticsKeyType

◆ StatisticsMapType

◆ StatisticsVariantType

◆ TimeStepMapType

◆ VoxelCountType

Definition at line 44 of file mitkImageStatisticsContainer.h.

Constructor & Destructor Documentation

◆ ImageStatisticsContainer()

Member Function Documentation

◆ Clone()

Pointer mitk::ImageStatisticsContainer::Clone ( ) const

Referenced by Reset().

◆ GetHistogramForTimeStep()

const ImageStatisticsContainer::HistogramType * mitk::ImageStatisticsContainer::GetHistogramForTimeStep ( TimeStepType  timeStep) const

/brief Returns the histogram of the passed time step.

Precondition
timeStep must be valid

Definition at line 118 of file mitkImageStatisticsContainer.cpp.

References GetStatisticsForTimeStep(), and mitk::ImageStatisticsContainer::ImageStatisticsObject::m_Histogram.

◆ GetNumberOfTimeSteps()

unsigned int mitk::ImageStatisticsContainer::GetNumberOfTimeSteps ( ) const

Definition at line 164 of file mitkImageStatisticsContainer.cpp.

References mitk::BaseData::GetTimeSteps().

◆ GetStatisticsForTimeStep()

const ImageStatisticsContainer::ImageStatisticsObject & mitk::ImageStatisticsContainer::GetStatisticsForTimeStep ( TimeStepType  timeStep) const

Returns the statisticObject for the given Timestep.

Precondition
timeStep must be valid

Definition at line 123 of file mitkImageStatisticsContainer.cpp.

References mitkThrow.

Referenced by mitk::GetAllStatisticNames(), GetHistogramForTimeStep(), and PrintSelf().

◆ mitkClassMacro()

mitk::ImageStatisticsContainer::mitkClassMacro ( ImageStatisticsContainer  ,
mitk::BaseData   
)

◆ New()

static Pointer mitk::ImageStatisticsContainer::New ( )
static

◆ PrintSelf()

void mitk::ImageStatisticsContainer::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::ImageStatisticsContainer::RequestedRegionIsOutsideOfTheBufferedRegion ( )
inlineoverridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion.

This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Implements mitk::BaseData.

Definition at line 51 of file mitkImageStatisticsContainer.h.

◆ Reset()

void mitk::ImageStatisticsContainer::Reset ( void  )

◆ SetRequestedRegion()

void mitk::ImageStatisticsContainer::SetRequestedRegion ( const itk::DataObject *  data)
inlineoverridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter.

This method is implemented in the concrete subclasses of BaseData.

Implements mitk::BaseData.

Definition at line 55 of file mitkImageStatisticsContainer.h.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::ImageStatisticsContainer::SetRequestedRegionToLargestPossibleRegion ( )
inlineoverridevirtual

Set the RequestedRegion to the LargestPossibleRegion.

This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Implements mitk::BaseData.

Definition at line 49 of file mitkImageStatisticsContainer.h.

◆ SetStatisticsForTimeStep()

void mitk::ImageStatisticsContainer::SetStatisticsForTimeStep ( TimeStepType  timeStep,
ImageStatisticsObject  statistics 
)

Sets the statisticObject for the given Timestep.

Precondition
timeStep must be valid

Definition at line 134 of file mitkImageStatisticsContainer.cpp.

References mitk::BaseData::GetTimeSteps(), and mitkThrow.

◆ TimeStepExists()

bool mitk::ImageStatisticsContainer::TimeStepExists ( TimeStepType  timeStep) const

Checks if the Time step exists.

Precondition
timeStep must be valid

Definition at line 112 of file mitkImageStatisticsContainer.cpp.

◆ VerifyRequestedRegion()

bool mitk::ImageStatisticsContainer::VerifyRequestedRegion ( )
inlineoverridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion.

Implements mitk::BaseData.

Definition at line 53 of file mitkImageStatisticsContainer.h.


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