VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMINCImageAttributes Class Reference

A container for a MINC image header. More...

#include <vtkMINCImageAttributes.h>

Inheritance diagram for vtkMINCImageAttributes:
[legend]
Collaboration diagram for vtkMINCImageAttributes:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMINCImageAttributesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Reset ()
 Reset all the attributes in preparation for loading new information. More...
 
virtual void SetName (const char *)
 Get the name of the image, not including the path or the extension. More...
 
virtual char * GetName ()
 
virtual void SetDataType (int)
 Get the image data type, as stored on disk. More...
 
virtual int GetDataType ()
 
virtual void AddDimension (const char *dimension)
 Add the names of up to five dimensions. More...
 
virtual void AddDimension (const char *dimension, vtkIdType length)
 
virtual vtkStringArrayGetDimensionNames ()
 Get the dimension names. More...
 
virtual vtkIdTypeArrayGetDimensionLengths ()
 Get the lengths of all the dimensions. More...
 
virtual vtkStringArrayGetVariableNames ()
 Get the names of all the variables. More...
 
virtual vtkStringArrayGetAttributeNames (const char *variable)
 List the attribute names for a variable. More...
 
virtual void SetImageMin (vtkDoubleArray *imageMin)
 Get the image min and max arrays. More...
 
virtual void SetImageMax (vtkDoubleArray *imageMax)
 
virtual vtkDoubleArrayGetImageMin ()
 
virtual vtkDoubleArrayGetImageMax ()
 
virtual int GetNumberOfImageMinMaxDimensions ()
 Get the number of ImageMinMax dimensions. More...
 
virtual void SetNumberOfImageMinMaxDimensions (int)
 
virtual int HasAttribute (const char *variable, const char *attribute)
 Check to see if a particular attribute exists. More...
 
virtual void SetAttributeValueAsArray (const char *variable, const char *attribute, vtkDataArray *array)
 Set attribute values for a variable as a vtkDataArray. More...
 
virtual vtkDataArrayGetAttributeValueAsArray (const char *variable, const char *attribute)
 
virtual void SetAttributeValueAsString (const char *variable, const char *attribute, const char *value)
 Set an attribute value as a string. More...
 
virtual const char * GetAttributeValueAsString (const char *variable, const char *attribute)
 
virtual void SetAttributeValueAsInt (const char *variable, const char *attribute, int value)
 Set an attribute value as an int. More...
 
virtual int GetAttributeValueAsInt (const char *variable, const char *attribute)
 
virtual void SetAttributeValueAsDouble (const char *variable, const char *attribute, double value)
 Set an attribute value as a double. More...
 
virtual double GetAttributeValueAsDouble (const char *variable, const char *attribute)
 
virtual int ValidateAttribute (const char *varname, const char *attname, vtkDataArray *array)
 Validate a particular attribute. More...
 
virtual void SetValidateAttributes (vtkTypeBool)
 Set this to Off if you do not want to automatically validate every attribute that is set. More...
 
virtual void ValidateAttributesOn ()
 
virtual void ValidateAttributesOff ()
 
virtual vtkTypeBool GetValidateAttributes ()
 
virtual void ShallowCopy (vtkMINCImageAttributes *source)
 Do a shallow copy. More...
 
virtual void FindValidRange (double range[2])
 Find the valid range of the data from the information stored in the attributes. More...
 
virtual void FindImageRange (double range[2])
 Find the image range of the data from the information stored in the attributes. More...
 
virtual void PrintFileHeader ()
 A diagnostic function. More...
 
virtual void PrintFileHeader (ostream &os)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMINCImageAttributesSafeDownCast (vtkObjectBase *o)
 
static vtkMINCImageAttributesNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMINCImageAttributes ()
 
 ~vtkMINCImageAttributes () override
 
const char * ConvertDataArrayToString (vtkDataArray *array)
 
virtual int ValidateGlobalAttribute (const char *attrib, vtkDataArray *array)
 
virtual int ValidateGeneralAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidateDimensionAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidateImageAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidateImageMinMaxAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidatePatientAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidateStudyAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
virtual int ValidateAcquisitionAttribute (const char *varname, const char *attname, vtkDataArray *array)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkStringArrayDimensionNames
 
vtkIdTypeArrayDimensionLengths
 
vtkStringArrayVariableNames
 
vtkMINCImageAttributeMap * AttributeNames
 
vtkMINCImageAttributeMap * AttributeValues
 
vtkStringArrayStringStore
 
vtkDoubleArrayImageMin
 
vtkDoubleArrayImageMax
 
int NumberOfImageMinMaxDimensions
 
int DataType
 
char * Name
 
vtkTypeBool ValidateAttributes
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A container for a MINC image header.

This class provides methods to access all of the information contained in the MINC header. If you read a MINC file into VTK and then write it out again, you can use writer->SetImageAttributes(reader->GetImageAttributes) to ensure that all of the medical information contained in the file is transferred from the reader to the writer. If you want to change any of the header information, you must use ShallowCopy to make a copy of the reader's attributes and then modify only the copy.

See also
vtkMINCImageReader vtkMINCImageWriter
Thanks:
Thanks to David Gobbi for writing this class and Atamai Inc. for contributing it to VTK.

Definition at line 83 of file vtkMINCImageAttributes.h.

Member Typedef Documentation

◆ Superclass

Definition at line 86 of file vtkMINCImageAttributes.h.

Constructor & Destructor Documentation

◆ vtkMINCImageAttributes()

vtkMINCImageAttributes::vtkMINCImageAttributes ( )
protected

◆ ~vtkMINCImageAttributes()

vtkMINCImageAttributes::~vtkMINCImageAttributes ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkMINCImageAttributes::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkMINCImageAttributes::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkMINCImageAttributes* vtkMINCImageAttributes::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMINCImageAttributes::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkMINCImageAttributes* vtkMINCImageAttributes::NewInstance ( ) const

◆ New()

static vtkMINCImageAttributes* vtkMINCImageAttributes::New ( )
static

◆ PrintSelf()

void vtkMINCImageAttributes::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ Reset()

virtual void vtkMINCImageAttributes::Reset ( )
virtual

Reset all the attributes in preparation for loading new information.

◆ SetName()

virtual void vtkMINCImageAttributes::SetName ( const char *  )
virtual

Get the name of the image, not including the path or the extension.

This is only needed for printing the header and there is usually no need to set it.

◆ GetName()

virtual char* vtkMINCImageAttributes::GetName ( )
virtual

◆ SetDataType()

virtual void vtkMINCImageAttributes::SetDataType ( int  )
virtual

Get the image data type, as stored on disk.

This information is useful if the file was converted to floating-point when it was loaded. When writing a file from float or double image data, you can use this method to prescribe the output type.

◆ GetDataType()

virtual int vtkMINCImageAttributes::GetDataType ( )
virtual

◆ AddDimension() [1/2]

virtual void vtkMINCImageAttributes::AddDimension ( const char *  dimension)
inlinevirtual

Add the names of up to five dimensions.

The ordering of these dimensions will determine the dimension order of the file. If no DimensionNames are set, the writer will set the dimension order of the file to be the same as the dimension order in memory.

Definition at line 125 of file vtkMINCImageAttributes.h.

◆ AddDimension() [2/2]

virtual void vtkMINCImageAttributes::AddDimension ( const char *  dimension,
vtkIdType  length 
)
virtual

◆ GetDimensionNames()

virtual vtkStringArray* vtkMINCImageAttributes::GetDimensionNames ( )
inlinevirtual

Get the dimension names.

The dimension names are same order as written in the file, starting with the slowest-varying dimension. Use this method to get the array if you need to change "space" dimensions to "frequency" after performing a Fourier transform.

Definition at line 136 of file vtkMINCImageAttributes.h.

◆ GetDimensionLengths()

virtual vtkIdTypeArray* vtkMINCImageAttributes::GetDimensionLengths ( )
inlinevirtual

Get the lengths of all the dimensions.

The dimension lengths are informative, the vtkMINCImageWriter does not look at these values but instead uses the dimension sizes of its input.

Definition at line 143 of file vtkMINCImageAttributes.h.

◆ GetVariableNames()

virtual vtkStringArray* vtkMINCImageAttributes::GetVariableNames ( )
inlinevirtual

Get the names of all the variables.

Definition at line 148 of file vtkMINCImageAttributes.h.

◆ GetAttributeNames()

virtual vtkStringArray* vtkMINCImageAttributes::GetAttributeNames ( const char *  variable)
virtual

List the attribute names for a variable.

Set the variable to the empty string to get a list of the global attributes.

◆ SetImageMin()

virtual void vtkMINCImageAttributes::SetImageMin ( vtkDoubleArray imageMin)
virtual

Get the image min and max arrays.

These are set by the reader, but they aren't used by the writer except to compute the full real data range of the original file.

◆ SetImageMax()

virtual void vtkMINCImageAttributes::SetImageMax ( vtkDoubleArray imageMax)
virtual

◆ GetImageMin()

virtual vtkDoubleArray* vtkMINCImageAttributes::GetImageMin ( )
inlinevirtual

Definition at line 164 of file vtkMINCImageAttributes.h.

◆ GetImageMax()

virtual vtkDoubleArray* vtkMINCImageAttributes::GetImageMax ( )
inlinevirtual

Definition at line 165 of file vtkMINCImageAttributes.h.

◆ GetNumberOfImageMinMaxDimensions()

virtual int vtkMINCImageAttributes::GetNumberOfImageMinMaxDimensions ( )
virtual

Get the number of ImageMinMax dimensions.

◆ SetNumberOfImageMinMaxDimensions()

virtual void vtkMINCImageAttributes::SetNumberOfImageMinMaxDimensions ( int  )
virtual

◆ HasAttribute()

virtual int vtkMINCImageAttributes::HasAttribute ( const char *  variable,
const char *  attribute 
)
virtual

Check to see if a particular attribute exists.

◆ SetAttributeValueAsArray()

virtual void vtkMINCImageAttributes::SetAttributeValueAsArray ( const char *  variable,
const char *  attribute,
vtkDataArray array 
)
virtual

Set attribute values for a variable as a vtkDataArray.

Set the variable to the empty string to access global attributes.

◆ GetAttributeValueAsArray()

virtual vtkDataArray* vtkMINCImageAttributes::GetAttributeValueAsArray ( const char *  variable,
const char *  attribute 
)
virtual

◆ SetAttributeValueAsString()

virtual void vtkMINCImageAttributes::SetAttributeValueAsString ( const char *  variable,
const char *  attribute,
const char *  value 
)
virtual

Set an attribute value as a string.

Set the variable to the empty string to access global attributes. If you specify a variable that does not exist, it will be created.

◆ GetAttributeValueAsString()

virtual const char* vtkMINCImageAttributes::GetAttributeValueAsString ( const char *  variable,
const char *  attribute 
)
virtual

◆ SetAttributeValueAsInt()

virtual void vtkMINCImageAttributes::SetAttributeValueAsInt ( const char *  variable,
const char *  attribute,
int  value 
)
virtual

Set an attribute value as an int.

Set the variable to the empty string to access global attributes. If you specify a variable that does not exist, it will be created.

◆ GetAttributeValueAsInt()

virtual int vtkMINCImageAttributes::GetAttributeValueAsInt ( const char *  variable,
const char *  attribute 
)
virtual

◆ SetAttributeValueAsDouble()

virtual void vtkMINCImageAttributes::SetAttributeValueAsDouble ( const char *  variable,
const char *  attribute,
double  value 
)
virtual

Set an attribute value as a double.

Set the variable to the empty string to access global attributes. If you specify a variable that does not exist, it will be created.

◆ GetAttributeValueAsDouble()

virtual double vtkMINCImageAttributes::GetAttributeValueAsDouble ( const char *  variable,
const char *  attribute 
)
virtual

◆ ValidateAttribute()

virtual int vtkMINCImageAttributes::ValidateAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
virtual

Validate a particular attribute.

This involves checking that the attribute is a MINC standard attribute, and checking whether it can be set (as opposed to being set automatically from the image information). The return values is 0 if the attribute is set automatically and therefore should not be copied from here, 1 if this attribute is valid and should be set, and 2 if the attribute is non-standard.

◆ SetValidateAttributes()

virtual void vtkMINCImageAttributes::SetValidateAttributes ( vtkTypeBool  )
virtual

Set this to Off if you do not want to automatically validate every attribute that is set.

◆ ValidateAttributesOn()

virtual void vtkMINCImageAttributes::ValidateAttributesOn ( )
virtual

◆ ValidateAttributesOff()

virtual void vtkMINCImageAttributes::ValidateAttributesOff ( )
virtual

◆ GetValidateAttributes()

virtual vtkTypeBool vtkMINCImageAttributes::GetValidateAttributes ( )
virtual

◆ ShallowCopy()

virtual void vtkMINCImageAttributes::ShallowCopy ( vtkMINCImageAttributes source)
virtual

Do a shallow copy.

This will copy all the attributes from the source. It is much more efficient than a DeepCopy would be, since it only copies pointers to the attribute values instead of copying the arrays themselves. You must use this method to make a copy if you want to modify any MINC attributes from a MINCReader before you pass them to a MINCWriter.

◆ FindValidRange()

virtual void vtkMINCImageAttributes::FindValidRange ( double  range[2])
virtual

Find the valid range of the data from the information stored in the attributes.

◆ FindImageRange()

virtual void vtkMINCImageAttributes::FindImageRange ( double  range[2])
virtual

Find the image range of the data from the information stored in the attributes.

◆ PrintFileHeader() [1/2]

virtual void vtkMINCImageAttributes::PrintFileHeader ( )
virtual

A diagnostic function.

Print the header of the file in the same format as ncdump or mincheader.

◆ PrintFileHeader() [2/2]

virtual void vtkMINCImageAttributes::PrintFileHeader ( ostream &  os)
virtual

◆ ConvertDataArrayToString()

const char* vtkMINCImageAttributes::ConvertDataArrayToString ( vtkDataArray array)
protected

◆ ValidateGlobalAttribute()

virtual int vtkMINCImageAttributes::ValidateGlobalAttribute ( const char *  attrib,
vtkDataArray array 
)
protectedvirtual

◆ ValidateGeneralAttribute()

virtual int vtkMINCImageAttributes::ValidateGeneralAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidateDimensionAttribute()

virtual int vtkMINCImageAttributes::ValidateDimensionAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidateImageAttribute()

virtual int vtkMINCImageAttributes::ValidateImageAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidateImageMinMaxAttribute()

virtual int vtkMINCImageAttributes::ValidateImageMinMaxAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidatePatientAttribute()

virtual int vtkMINCImageAttributes::ValidatePatientAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidateStudyAttribute()

virtual int vtkMINCImageAttributes::ValidateStudyAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

◆ ValidateAcquisitionAttribute()

virtual int vtkMINCImageAttributes::ValidateAcquisitionAttribute ( const char *  varname,
const char *  attname,
vtkDataArray array 
)
protectedvirtual

Member Data Documentation

◆ DimensionNames

vtkStringArray* vtkMINCImageAttributes::DimensionNames
protected

Definition at line 297 of file vtkMINCImageAttributes.h.

◆ DimensionLengths

vtkIdTypeArray* vtkMINCImageAttributes::DimensionLengths
protected

Definition at line 298 of file vtkMINCImageAttributes.h.

◆ VariableNames

vtkStringArray* vtkMINCImageAttributes::VariableNames
protected

Definition at line 300 of file vtkMINCImageAttributes.h.

◆ AttributeNames

vtkMINCImageAttributeMap* vtkMINCImageAttributes::AttributeNames
protected

Definition at line 301 of file vtkMINCImageAttributes.h.

◆ AttributeValues

vtkMINCImageAttributeMap* vtkMINCImageAttributes::AttributeValues
protected

Definition at line 302 of file vtkMINCImageAttributes.h.

◆ StringStore

vtkStringArray* vtkMINCImageAttributes::StringStore
protected

Definition at line 304 of file vtkMINCImageAttributes.h.

◆ ImageMin

vtkDoubleArray* vtkMINCImageAttributes::ImageMin
protected

Definition at line 306 of file vtkMINCImageAttributes.h.

◆ ImageMax

vtkDoubleArray* vtkMINCImageAttributes::ImageMax
protected

Definition at line 307 of file vtkMINCImageAttributes.h.

◆ NumberOfImageMinMaxDimensions

int vtkMINCImageAttributes::NumberOfImageMinMaxDimensions
protected

Definition at line 308 of file vtkMINCImageAttributes.h.

◆ DataType

int vtkMINCImageAttributes::DataType
protected

Definition at line 310 of file vtkMINCImageAttributes.h.

◆ Name

char* vtkMINCImageAttributes::Name
protected

Definition at line 311 of file vtkMINCImageAttributes.h.

◆ ValidateAttributes

vtkTypeBool vtkMINCImageAttributes::ValidateAttributes
protected

Definition at line 313 of file vtkMINCImageAttributes.h.


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