Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
vtkITKImageSequenceReader Class Reference

#include <Libs/vtkITK/vtkITKImageSequenceReader.h>

Inheritance diagram for vtkITKImageSequenceReader:
Collaboration diagram for vtkITKImageSequenceReader:

Public Types

typedef vtkMedicalImageReader2 Superclass
 

Public Member Functions

void ClearCachedImages ()
 
const char * GetAxisLabel (unsigned int axis)
 Get label for specified axis.
 
const char * GetAxisUnit (unsigned int axis)
 Get unit for specified axis.
 
vtkImageData * GetCachedImage (unsigned int index)
 
virtual const char * GetClassName ()
 
virtual unsigned int GetCurrentFrameIndex ()
 Get current frame index that is extracted from the sequence image to the output port.
 
const std::map< std::string, std::string > GetHeaderKeysMap ()
 Get the map of keys in the header.
 
const std::vector< std::string > GetHeaderKeysVector ()
 Get the list of keys in the header.
 
const char * GetHeaderValue (const char *key)
 Get a value given a key in the header.
 
unsigned int GetNumberOfCachedImages ()
 
virtual unsigned int GetNumberOfFrames ()
 Get number of frames in recently read image. Set in first Update. Read only.
 
virtual vtkMatrix4x4 * GetRasToIjkMatrix ()
 
virtual std::string GetSequenceAxisLabel ()
 
virtual std::string GetSequenceAxisUnit ()
 
virtual int GetVoxelVectorType ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetCurrentFrameIndex (unsigned int)
 Set current frame index that is extracted from the sequence image to the output port.
 
virtual void SetNumberOfFrames (unsigned int)
 Set number of frames in recently read image. Set in first Update. Read only.
 
virtual void SetRasToIjkMatrix (vtkMatrix4x4 *)
 Get RAS to IJK matrix. It is null until the first reading is done.
 
virtual void SetVoxelVectorType (int)
 Defines how to interpret voxel components.
 

Static Public Member Functions

static std::string FormatSequenceItemMetadataKey (unsigned int axisIndex, unsigned int frameIndex, const std::string &attributeName)
 
static int IsTypeOf (const char *type)
 
static vtkITKImageSequenceReaderNew ()
 
static bool ParseAndStoreSequenceItemMetadata (const std::string &key, const char *attributeValue, std::vector< std::string > &attributeNames, std::vector< std::vector< std::string > > &frameAttributeValues)
 
static bool ParseSequenceItemMetadataKey (const std::string &key, unsigned int &axisIndex, unsigned int &frameIndex, std::string &attributeName)
 
static vtkITKImageSequenceReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo) override
 
 vtkITKImageSequenceReader ()
 
 ~vtkITKImageSequenceReader () override
 

Protected Attributes

std::map< unsigned int, std::string > AxisLabels
 
std::map< unsigned int, std::string > AxisUnits
 
std::vector< vtkSmartPointer< vtkImageData > > CachedImages
 
unsigned int CurrentFrameIndex { 0 }
 Current frame index that is extracted from the sequence image to the output port.
 
std::map< std::string, std::string > HeaderKeyValueMap
 Key/value pairs read from the header.
 
unsigned int NumberOfFrames { 0 }
 Number of frames in recently read image. Set in first Update. Read only.
 
vtkMatrix4x4 * RasToIjkMatrix { nullptr }
 RAS to IJK matrix.
 
std::string SequenceAxisLabel
 
std::string SequenceAxisUnit
 
int VoxelVectorType { vtkITKImageWriter::VoxelVectorTypeUndefined }
 

Detailed Description

Definition at line 29 of file vtkITKImageSequenceReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMedicalImageReader2 vtkITKImageSequenceReader::Superclass

Definition at line 33 of file vtkITKImageSequenceReader.h.

Constructor & Destructor Documentation

◆ vtkITKImageSequenceReader()

vtkITKImageSequenceReader::vtkITKImageSequenceReader ( )
protected

◆ ~vtkITKImageSequenceReader()

vtkITKImageSequenceReader::~vtkITKImageSequenceReader ( )
overrideprotected

Member Function Documentation

◆ ClearCachedImages()

void vtkITKImageSequenceReader::ClearCachedImages ( )

◆ ExecuteDataWithInformation()

void vtkITKImageSequenceReader::ExecuteDataWithInformation ( vtkDataObject * output,
vtkInformation * outInfo )
overrideprotected

◆ FormatSequenceItemMetadataKey()

static std::string vtkITKImageSequenceReader::FormatSequenceItemMetadataKey ( unsigned int axisIndex,
unsigned int frameIndex,
const std::string & attributeName )
static

◆ GetAxisLabel()

const char * vtkITKImageSequenceReader::GetAxisLabel ( unsigned int axis)

Get label for specified axis.

◆ GetAxisUnit()

const char * vtkITKImageSequenceReader::GetAxisUnit ( unsigned int axis)

Get unit for specified axis.

◆ GetCachedImage()

vtkImageData * vtkITKImageSequenceReader::GetCachedImage ( unsigned int index)

◆ GetClassName()

virtual const char * vtkITKImageSequenceReader::GetClassName ( )
virtual

◆ GetCurrentFrameIndex()

virtual unsigned int vtkITKImageSequenceReader::GetCurrentFrameIndex ( )
virtual

Get current frame index that is extracted from the sequence image to the output port.

◆ GetHeaderKeysMap()

const std::map< std::string, std::string > vtkITKImageSequenceReader::GetHeaderKeysMap ( )

Get the map of keys in the header.

◆ GetHeaderKeysVector()

const std::vector< std::string > vtkITKImageSequenceReader::GetHeaderKeysVector ( )

Get the list of keys in the header.

◆ GetHeaderValue()

const char * vtkITKImageSequenceReader::GetHeaderValue ( const char * key)

Get a value given a key in the header.

◆ GetNumberOfCachedImages()

unsigned int vtkITKImageSequenceReader::GetNumberOfCachedImages ( )

◆ GetNumberOfFrames()

virtual unsigned int vtkITKImageSequenceReader::GetNumberOfFrames ( )
virtual

Get number of frames in recently read image. Set in first Update. Read only.

◆ GetRasToIjkMatrix()

virtual vtkMatrix4x4 * vtkITKImageSequenceReader::GetRasToIjkMatrix ( )
virtual

◆ GetSequenceAxisLabel()

virtual std::string vtkITKImageSequenceReader::GetSequenceAxisLabel ( )
virtual

◆ GetSequenceAxisUnit()

virtual std::string vtkITKImageSequenceReader::GetSequenceAxisUnit ( )
virtual

◆ GetVoxelVectorType()

virtual int vtkITKImageSequenceReader::GetVoxelVectorType ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkITKImageSequenceReader * vtkITKImageSequenceReader::New ( )
static

◆ ParseAndStoreSequenceItemMetadata()

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

Parse and store sequence item metadata (format: "axis M item NNNN attributename") Returns true if the string matches the expected format and stores the attribute value Updates attributeNames and frameAttributeValues vectors with the parsed data

◆ ParseSequenceItemMetadataKey()

static bool vtkITKImageSequenceReader::ParseSequenceItemMetadataKey ( const std::string & key,
unsigned int & axisIndex,
unsigned int & frameIndex,
std::string & attributeName )
static

Parse axis item attribute string (format: "axis M item NNNN attributename") Returns true if the string matches the expected format, false otherwise On success, fills axisIndex, frameIndex, and attributeName with parsed values

◆ PrintSelf()

void vtkITKImageSequenceReader::PrintSelf ( ostream & os,
vtkIndent indent )
override

◆ SafeDownCast()

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

◆ SetCurrentFrameIndex()

virtual void vtkITKImageSequenceReader::SetCurrentFrameIndex ( unsigned int )
virtual

Set current frame index that is extracted from the sequence image to the output port.

◆ SetNumberOfFrames()

virtual void vtkITKImageSequenceReader::SetNumberOfFrames ( unsigned int )
virtual

Set number of frames in recently read image. Set in first Update. Read only.

◆ SetRasToIjkMatrix()

virtual void vtkITKImageSequenceReader::SetRasToIjkMatrix ( vtkMatrix4x4 * )
virtual

Get RAS to IJK matrix. It is null until the first reading is done.

◆ SetVoxelVectorType()

virtual void vtkITKImageSequenceReader::SetVoxelVectorType ( int )
virtual

Defines how to interpret voxel components.

Member Data Documentation

◆ AxisLabels

std::map<unsigned int, std::string> vtkITKImageSequenceReader::AxisLabels
protected

Definition at line 114 of file vtkITKImageSequenceReader.h.

◆ AxisUnits

std::map<unsigned int, std::string> vtkITKImageSequenceReader::AxisUnits
protected

Definition at line 116 of file vtkITKImageSequenceReader.h.

◆ CachedImages

std::vector<vtkSmartPointer<vtkImageData> > vtkITKImageSequenceReader::CachedImages
protected

Definition at line 122 of file vtkITKImageSequenceReader.h.

◆ CurrentFrameIndex

unsigned int vtkITKImageSequenceReader::CurrentFrameIndex { 0 }
protected

Current frame index that is extracted from the sequence image to the output port.

Definition at line 100 of file vtkITKImageSequenceReader.h.

◆ HeaderKeyValueMap

std::map<std::string, std::string> vtkITKImageSequenceReader::HeaderKeyValueMap
protected

Key/value pairs read from the header.

Definition at line 111 of file vtkITKImageSequenceReader.h.

◆ NumberOfFrames

unsigned int vtkITKImageSequenceReader::NumberOfFrames { 0 }
protected

Number of frames in recently read image. Set in first Update. Read only.

Definition at line 103 of file vtkITKImageSequenceReader.h.

◆ RasToIjkMatrix

vtkMatrix4x4* vtkITKImageSequenceReader::RasToIjkMatrix { nullptr }
protected

RAS to IJK matrix.

Definition at line 106 of file vtkITKImageSequenceReader.h.

◆ SequenceAxisLabel

std::string vtkITKImageSequenceReader::SequenceAxisLabel
protected

Definition at line 118 of file vtkITKImageSequenceReader.h.

◆ SequenceAxisUnit

std::string vtkITKImageSequenceReader::SequenceAxisUnit
protected

Definition at line 120 of file vtkITKImageSequenceReader.h.

◆ VoxelVectorType

int vtkITKImageSequenceReader::VoxelVectorType { vtkITKImageWriter::VoxelVectorTypeUndefined }
protected

Definition at line 108 of file vtkITKImageSequenceReader.h.


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