vtkITKImageSequenceReader.h

Go to the documentation of this file.

/*==========================================================================
 
  Copyright (c) Ebatinca S.L., Las Palmas de Gran Canaria, Spain
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Csaba Pinter, Ebatinca, funded
  by the grant GRT-00000485 of Children's Hospital of Philadelphia, USA.
 
==========================================================================*/
 
#ifndef __vtkITKImageSequenceReader_h
#define __vtkITKImageSequenceReader_h
 
#include "vtkMedicalImageReader2.h"
 
#include "vtkMatrix4x4.h"
 
#include "vtkITK.h"
#include "vtkITKImageWriter.h"
 
class VTK_ITK_EXPORT vtkITKImageSequenceReader : public vtkMedicalImageReader2
{
public:
  static vtkITKImageSequenceReader* New();
  vtkTypeMacro(vtkITKImageSequenceReader, vtkMedicalImageReader2);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkSetMacro(CurrentFrameIndex, unsigned int);
  vtkGetMacro(CurrentFrameIndex, unsigned int);

  vtkSetMacro(NumberOfFrames, unsigned int);
  vtkGetMacro(NumberOfFrames, unsigned int);

  vtkSetObjectMacro(RasToIjkMatrix, vtkMatrix4x4);
  vtkGetObjectMacro(RasToIjkMatrix, vtkMatrix4x4);

  vtkSetMacro(VoxelVectorType, int);
  vtkGetMacro(VoxelVectorType, int);

  const std::vector<std::string> GetHeaderKeysVector();
  const std::map<std::string, std::string> GetHeaderKeysMap();
  const char* GetHeaderValue(const char* key);

  const char* GetAxisLabel(unsigned int axis);

  const char* GetAxisUnit(unsigned int axis);

  static bool ParseSequenceItemMetadataKey(const std::string& key, unsigned int& axisIndex, unsigned int& frameIndex, std::string& attributeName);
 
  // Format axis and frame index values and attribute name into metadata key.
  // For example: "axis 3 item 0025 SomeAttributeName"
  static std::string FormatSequenceItemMetadataKey(unsigned int axisIndex, unsigned int frameIndex, const std::string& attributeName);

  static bool ParseAndStoreSequenceItemMetadata(const std::string& key,
                                                const char* attributeValue,
                                                std::vector<std::string>& attributeNames,
                                                std::vector<std::vector<std::string>>& frameAttributeValues);

  static bool IsImageSequenceFile(const char* fileName);
 
  vtkGetMacro(SequenceAxisLabel, std::string);
  vtkGetMacro(SequenceAxisUnit, std::string);

  vtkGetMacro(VoxelValueUnit, std::string);

  vtkGetMacro(VoxelValueLabel, std::string);
 
  unsigned int GetNumberOfCachedImages();
  vtkImageData* GetCachedImage(unsigned int index);
  void ClearCachedImages();
 
protected:
  vtkITKImageSequenceReader();
  ~vtkITKImageSequenceReader() override;
 
  // void ExecuteInformation() override;
  void ExecuteDataWithInformation(vtkDataObject* output, vtkInformation* outInfo) override;
 
protected:
  unsigned int CurrentFrameIndex{ 0 };

  unsigned int NumberOfFrames{ 0 };

  vtkMatrix4x4* RasToIjkMatrix{ nullptr };
 
  int VoxelVectorType{ vtkITKImageWriter::VoxelVectorTypeUndefined };

  std::map<std::string, std::string> HeaderKeyValueMap;
 
  // Axis labels read from the header.
  std::map<unsigned int, std::string> AxisLabels;
  // Axis units read from the header.
  std::map<unsigned int, std::string> AxisUnits;
  // Sequence axis label read from the header.
  std::string SequenceAxisLabel;
  // Sequence axis unit read from the header.
  std::string SequenceAxisUnit;
  // Unit of the voxel values read from the header (units of the pixel axis).
  std::string VoxelValueUnit;
  // Quantity of the voxel values read from the header (labels of the pixel axis).
  std::string VoxelValueLabel;
 
  std::vector<vtkSmartPointer<vtkImageData>> CachedImages;
 
private:
  vtkITKImageSequenceReader(const vtkITKImageSequenceReader&) = delete;
  void operator=(const vtkITKImageSequenceReader&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal{ nullptr };
};
 
#endif