Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
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:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLMeasurementArea:
Collaboration graph
[legend]

Public Types

typedef vtkMRMLMeasurement Superclass
 
- Public Types inherited from vtkMRMLMeasurement
enum  ComputationResult { NoChange =0, OK, InsufficientInput, InternalError }
 
typedef vtkObject Superclass
 

Public Member Functions

void Compute () override
 Calculate area of. 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 ClearValue (ComputationResult computationResult=NoChange)
 
virtual void Copy (vtkMRMLMeasurement *aEntry)
 Copy one type into another (deep copy) More...
 
virtual void EnabledOff ()
 
virtual void EnabledOn ()
 
std::string GetAsString ()
 Get content of the object as a single machine-readable string. More...
 
virtual vtkDoubleArray * GetControlPointValues ()
 
virtual vtkCodedEntryGetDerivationCode ()
 
virtual std::string GetDescription ()
 Informal description of the measurement. More...
 
virtual bool GetEnabled ()
 
vtkMRMLNodeGetInputMRMLNode ()
 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 vtkCodedEntryGetMethodCode ()
 
virtual std::string GetName ()
 Measurement name. More...
 
virtual std::string GetPrintFormat ()
 Formatting string for displaying measurement value and units. More...
 
virtual vtkCodedEntryGetQuantityCode ()
 
virtual std::string GetUnits ()
 Measurement unit. More...
 
virtual vtkCodedEntryGetUnitsCode ()
 
virtual double GetValue ()
 Measured 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...
 
virtual void Initialize ()
 Reset state of object. 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 SetEnabled (bool)
 Enabled. More...
 
bool SetFromString (const std::string &content)
 
void SetInputMRMLNode (vtkMRMLNode *node)
 Set input MRML node used for calculating the measurement. More...
 
void SetMethodCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
 
virtual void SetName (std::string)
 
virtual void SetPrintFormat (std::string)
 
void SetQuantityCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
 
virtual void SetUnits (std::string)
 
void SetUnitsCode (vtkCodedEntry *entry)
 Copy content of coded entry. More...
 
void SetValue (double value)
 
void SetValue (double value, const std::string &units, const std::string &printFormat, int lastComputationResult)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLMeasurementAreaNew ()
 
static vtkMRMLMeasurementAreaSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLMeasurement
static int IsTypeOf (const char *type)
 
static vtkMRMLMeasurementSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLMeasurementArea &)
 
 vtkMRMLMeasurementArea ()
 
 vtkMRMLMeasurementArea (const vtkMRMLMeasurementArea &)
 
 ~vtkMRMLMeasurementArea () override
 
- Protected Member Functions inherited from vtkMRMLMeasurement
void operator= (const vtkMRMLMeasurement &)
 
 vtkMRMLMeasurement ()
 
 vtkMRMLMeasurement (const vtkMRMLMeasurement &)
 
 ~vtkMRMLMeasurement () override
 

Additional Inherited Members

- Protected Attributes inherited from vtkMRMLMeasurement
vtkDoubleArray * ControlPointValues {nullptr}
 Per-control point measurements. More...
 
vtkCodedEntryDerivationCode {nullptr}
 
std::string Description
 
bool Enabled {true}
 
vtkWeakPointer< vtkMRMLNodeInputMRMLNode
 MRML node used to calculate the measurement. More...
 
ComputationResult LastComputationResult {InsufficientInput}
 
vtkCodedEntryMethodCode {nullptr}
 
std::string Name
 
std::string PrintFormat
 
vtkCodedEntryQuantityCode {nullptr}
 
std::string Units
 
vtkCodedEntryUnitsCode {nullptr}
 
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

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.

◆ 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: