vtkMINCImageAttributes.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) 2006 Atamai, Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkMINCImageAttributes_h
#define vtkMINCImageAttributes_h
 
#include "vtkIOMINCModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkStringArray;
class vtkIdTypeArray;
class vtkDoubleArray;
class vtkMatrix4x4;
 
// A special class that holds the attributes
class vtkMINCImageAttributeMap;
 
class VTKIOMINC_EXPORT vtkMINCImageAttributes : public vtkObject
{
public:
  vtkTypeMacro(vtkMINCImageAttributes, vtkObject);
 
  static vtkMINCImageAttributes* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void Reset();
 
 
  vtkSetStringMacro(Name);
  vtkGetStringMacro(Name);
 
 
  vtkSetMacro(DataType, int);
  vtkGetMacro(DataType, int);
 
 
  virtual void AddDimension(const char* dimension) { this->AddDimension(dimension, 0); }
  virtual void AddDimension(const char* dimension, vtkIdType length);
 
  virtual vtkStringArray* GetDimensionNames() { return this->DimensionNames; }
 
  virtual vtkIdTypeArray* GetDimensionLengths() { return this->DimensionLengths; }
 
  virtual vtkStringArray* GetVariableNames() { return this->VariableNames; }
 
  virtual vtkStringArray* GetAttributeNames(const char* variable);
 
 
  virtual void SetImageMin(vtkDoubleArray* imageMin);
  virtual void SetImageMax(vtkDoubleArray* imageMax);
  virtual vtkDoubleArray* GetImageMin() { return this->ImageMin; }
  virtual vtkDoubleArray* GetImageMax() { return this->ImageMax; }
 
 
  vtkGetMacro(NumberOfImageMinMaxDimensions, int);
  vtkSetMacro(NumberOfImageMinMaxDimensions, int);
 
  virtual vtkTypeBool HasAttribute(const char* variable, const char* attribute);
 
 
  virtual void SetAttributeValueAsArray(
    const char* variable, const char* attribute, vtkDataArray* array);
  virtual vtkDataArray* GetAttributeValueAsArray(const char* variable, const char* attribute);
 
 
  virtual void SetAttributeValueAsString(
    const char* variable, const char* attribute, const char* value);
  virtual const char* GetAttributeValueAsString(const char* variable, const char* attribute);
 
 
  virtual void SetAttributeValueAsInt(const char* variable, const char* attribute, int value);
  virtual int GetAttributeValueAsInt(const char* variable, const char* attribute);
 
 
  virtual void SetAttributeValueAsDouble(const char* variable, const char* attribute, double value);
  virtual double GetAttributeValueAsDouble(const char* variable, const char* attribute);
 
  virtual int ValidateAttribute(const char* varname, const char* attname, vtkDataArray* array);
 
 
  vtkSetMacro(ValidateAttributes, vtkTypeBool);
  vtkBooleanMacro(ValidateAttributes, vtkTypeBool);
  vtkGetMacro(ValidateAttributes, vtkTypeBool);
 
  virtual void ShallowCopy(vtkMINCImageAttributes* source);
 
  virtual void FindValidRange(double range[2]);
 
  virtual void FindImageRange(double range[2]);
 
 
  virtual void PrintFileHeader();
  virtual void PrintFileHeader(ostream& os);
 
protected:
  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);
 
  vtkStringArray* DimensionNames;
  vtkIdTypeArray* DimensionLengths;
 
  vtkStringArray* VariableNames;
  vtkMINCImageAttributeMap* AttributeNames;
  vtkMINCImageAttributeMap* AttributeValues;
 
  vtkStringArray* StringStore;
 
  vtkDoubleArray* ImageMin;
  vtkDoubleArray* ImageMax;
  int NumberOfImageMinMaxDimensions;
 
  int DataType;
  char* Name;
 
  vtkTypeBool ValidateAttributes;
 
private:
  vtkMINCImageAttributes(const vtkMINCImageAttributes&) = delete;
  void operator=(const vtkMINCImageAttributes&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif /* vtkMINCImageAttributes_h */