vtkMRMLMeasurementArea Class Reference

Measurement class calculating area of a plane or enclosed by a closed curve. More...

#include <Modules/Loadable/Markups/MRML/vtkMRMLMeasurementArea.h>

Inheritance diagram for vtkMRMLMeasurementArea:

Collaboration diagram for vtkMRMLMeasurementArea:

Public Types
typedef vtkMRMLMeasurement	Superclass
Public Types inherited from vtkMRMLMeasurement
enum	ComputationResult { NoChange =0, OK, InsufficientInput, InternalError }
enum	Events { InputDataModifiedEvent = vtkCommand::UserEvent + 555 }
typedef vtkObject	Superclass

Public Member Functions
void	Compute () override
	Calculate area of. More...
VTK_NEWINSTANCE vtkMRMLMeasurement *	CreateInstance () const override
	Create a new instance of this measurement type. More...
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
Public Member Functions inherited from vtkMRMLMeasurement
virtual void	Clear ()
	Reset state of object. Removes all content. More...
virtual void	ClearValue (ComputationResult computationResult=NoChange)
virtual void	Copy (vtkMRMLMeasurement *source)
	Copy one type into another (deep copy) More...
virtual void	EnabledOff ()
virtual void	EnabledOn ()
virtual vtkDoubleArray *	GetControlPointValues ()
virtual vtkCodedEntry *	GetDerivationCode ()
virtual std::string	GetDescription ()
	Informal description of the measurement. More...
virtual double	GetDisplayCoefficient ()
double	GetDisplayValue ()
virtual bool	GetEnabled ()
	Enabled. More...
vtkMRMLNode *	GetInputMRMLNode ()
	Get input MRML node used for calculating the measurement. More...
virtual int	GetLastComputationResult ()
	Get last computation result. More...
const char *	GetLastComputationResultAsPrintableString ()
	Get last computation result as human-readable string. More...
virtual vtkPolyData *	GetMeshValue ()
virtual vtkCodedEntry *	GetMethodCode ()
virtual std::string	GetName ()
	Measurement name. More...
virtual std::string	GetPrintFormat ()
	Formatting string for displaying measurement value and units. More...
virtual vtkCodedEntry *	GetQuantityCode ()
virtual std::string	GetUnits ()
	Measurement unit. More...
virtual vtkCodedEntry *	GetUnitsCode ()
virtual double	GetValue ()
	Get quantity value. More...
virtual bool	GetValueDefined ()
	Value defined flag (whether a computed value has been set or not) More...
std::string	GetValueWithUnitsAsPrintableString ()
	Get measurement value and units as a single human-readable string. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetControlPointValues (vtkDoubleArray *inputValues)
	Set the per-control point measurement values. More...
void	SetDerivationCode (vtkCodedEntry *entry)
	Copy content of coded entry. More...
virtual void	SetDescription (std::string)
virtual void	SetDisplayCoefficient (double)
void	SetDisplayValue (double value, const char *units=nullptr, double displayCoefficient=0.0)
virtual void	SetEnabled (bool enabled)
void	SetInputMRMLNode (vtkMRMLNode *node)
	Set input MRML node used for calculating the measurement. More...
void	SetMeshValue (vtkPolyData *meshValue)
void	SetMethodCode (vtkCodedEntry *entry)
	Copy content of coded entry. More...
virtual void	SetName (std::string)
virtual void	SetPrintFormat (std::string format)
void	SetQuantityCode (vtkCodedEntry *entry)
	Copy content of coded entry. More...
virtual void	SetUnits (std::string units)
void	SetUnitsCode (vtkCodedEntry *entry)
	Copy content of coded entry. More...
void	SetValue (double value, const char *quantityName=nullptr)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLMeasurementArea *	New ()
static vtkMRMLMeasurementArea *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLMeasurement
static int	IsTypeOf (const char *type)
static vtkMRMLMeasurement *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLMeasurementArea &)
	vtkMRMLMeasurementArea ()
	vtkMRMLMeasurementArea (const vtkMRMLMeasurementArea &)
	~vtkMRMLMeasurementArea () override
Protected Member Functions inherited from vtkMRMLMeasurement
vtkMRMLUnitNode *	GetUnitNode (const char *quantityName)
	Helper function to get unit node from the scene based on quantity name. More...
void	operator= (const vtkMRMLMeasurement &)
	vtkMRMLMeasurement ()
	vtkMRMLMeasurement (const vtkMRMLMeasurement &)
	~vtkMRMLMeasurement () override

Additional Inherited Members
Protected Attributes inherited from vtkMRMLMeasurement
vtkSmartPointer< vtkDoubleArray >	ControlPointValues
	Per-control point measurements. More...
vtkSmartPointer< vtkCodedEntry >	DerivationCode
std::string	Description
double	DisplayCoefficient {1.0}
bool	Enabled {true}
vtkWeakPointer< vtkMRMLNode >	InputMRMLNode
	MRML node used to calculate the measurement. More...
ComputationResult	LastComputationResult {InsufficientInput}
vtkSmartPointer< vtkPolyData >	MeshValue
	Surface mesh for displaying computed value. More...
vtkSmartPointer< vtkCodedEntry >	MethodCode
std::string	Name
std::string	PrintFormat
vtkSmartPointer< vtkCodedEntry >	QuantityCode
std::string	Units
vtkSmartPointer< vtkCodedEntry >	UnitsCode
double	Value {0.0}
bool	ValueDefined {false}

Detailed Description

Measurement class calculating area of a plane or enclosed by a closed curve.

Definition at line 29 of file vtkMRMLMeasurementArea.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLMeasurement vtkMRMLMeasurementArea::Superclass

Definition at line 33 of file vtkMRMLMeasurementArea.h.

Constructor & Destructor Documentation

vtkMRMLMeasurementArea() [1/2]

vtkMRMLMeasurementArea::vtkMRMLMeasurementArea ( )

protected

~vtkMRMLMeasurementArea()

vtkMRMLMeasurementArea::~vtkMRMLMeasurementArea ( )

overrideprotected

vtkMRMLMeasurementArea() [2/2]

vtkMRMLMeasurementArea::vtkMRMLMeasurementArea ( const vtkMRMLMeasurementArea &  )

protected

Member Function Documentation

Compute()

void vtkMRMLMeasurementArea::Compute ( )

overridevirtual

Calculate area of.

See also

InputMRMLNode plane or closed curve markup node and store the result internally

Implements vtkMRMLMeasurement.

CreateInstance()

VTK_NEWINSTANCE vtkMRMLMeasurement* vtkMRMLMeasurementArea::CreateInstance ( ) const

inlineoverridevirtual

Create a new instance of this measurement type.

Implements vtkMRMLMeasurement.

Definition at line 38 of file vtkMRMLMeasurementArea.h.

GetClassName()

virtual const char* vtkMRMLMeasurementArea::GetClassName ( )

virtual

Reimplemented from vtkMRMLMeasurement.

IsA()

virtual int vtkMRMLMeasurementArea::IsA ( const char *  type )

virtual

Reimplemented from vtkMRMLMeasurement.

IsTypeOf()

static int vtkMRMLMeasurementArea::IsTypeOf ( const char *  type )

static

New()

static vtkMRMLMeasurementArea* vtkMRMLMeasurementArea::New ( )

static

operator=()

void vtkMRMLMeasurementArea::operator= ( const vtkMRMLMeasurementArea &  )

protected

PrintSelf()

void vtkMRMLMeasurementArea::PrintSelf ( ostream &  os, vtkIndent  indent  )

override

SafeDownCast()

static vtkMRMLMeasurementArea* vtkMRMLMeasurementArea::SafeDownCast ( vtkObject *  o )

static

---

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

• Modules/Loadable/Markups/MRML/vtkMRMLMeasurementArea.h