#include <Modules/Loadable/Volumes/Logic/vtkSlicerVolumesReader.h>

Inheritance diagram for vtkSlicerVolumesReader:

[legend]

Collaboration diagram for vtkSlicerVolumesReader:

[legend]

Public Types
typedef vtkMRMLFileReader	Superclass

Public Types inherited from vtkMRMLFileReader
typedef vtkMRMLFileIOHandler	Superclass

Public Types inherited from vtkMRMLFileIOHandler
typedef vtkObject	Superclass

Public Member Functions
double	CanLoadFileConfidence (const std::string &filePath) override

std::string	ExamineFileList (std::vector< std::string > &fileList, vtkMRMLIOProperties *ioProperties) override

virtual const char *	GetClassName ()

void	GetOptionsDescription (vtkMRMLIOOptionsDescription *description) override

vtkSlicerVolumesLogic *	GetVolumesLogic ()

virtual int	IsA (const char *type)

bool	Load (vtkMRMLIOProperties *properties) override

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetVolumesLogic (vtkSlicerVolumesLogic *logic)

Public Member Functions inherited from vtkMRMLFileReader
void	AddLoadedNodeID (const std::string &nodeID)

virtual bool	CanLoadFile (const std::string &filePath)

void	ClearLoadedNodeIDs ()

virtual double	ExamineFileListConfidence (std::vector< std::string > &fileList, vtkMRMLIOProperties *ioProperties)

virtual double	GetConfidenceForMatchingExtension ()

const std::vector< std::string > &	GetLoadedNodeIDs () const
	The nodes the last Load added, by node ID.

std::vector< std::string >	GetSupportedNameFilters (const std::string &filePath)

std::vector< std::string >	GetSupportedNameFilters (const std::string &filePath, int &longestExtensionMatch)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetConfidenceForMatchingExtension (double)

void	SetLoadedNodeIDs (const std::vector< std::string > &nodeIDs)

Public Member Functions inherited from vtkMRMLFileIOHandler
void	FillOptionsDescription (vtkMRMLIOProperties properties, vtkMRMLIOOptionsDescription description)

virtual std::string	GetDescription ()
	What to call this in a file dialog ("Volume", "Mimics project").

const std::vector< std::string > &	GetExtensions () const

vtkMRMLFileIOManager *	GetFileIOManager () const

virtual std::string	GetFileType ()

virtual std::string	GetMatchedExtension (const std::string &filePath) const
	The longest matching extension of filePath, or an empty string.

const std::vector< std::string > &	GetNameFilters () const

vtkMRMLIOProperties *	GetOptionDefaults ()

std::string	GetOptionsDescriptionJSON (vtkMRMLIOProperties *properties)

void	GetOptionValues (vtkMRMLIOProperties properties, vtkMRMLIOProperties values)

vtkMRMLScene *	GetScene () const

vtkMRMLMessageCollection *	GetUserMessages () const

virtual bool	IsWriter () const
	Whether this writes rather than reads.

virtual bool	MatchesExtension (const std::string &filePath) const

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetDescription (std::string)

void	SetFileIOManager (vtkMRMLFileIOManager *manager)

virtual void	SetFileType (std::string)

void	SetNameFilters (const std::vector< std::string > &filters)
	The name filters, as Slicer writes them: "Mimics project (.mcs .mcs.gz)".

virtual void	SetScene (vtkMRMLScene *scene)
	Where the nodes go, and where messages for the user are collected.

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSlicerVolumesReader *	New ()

static vtkSlicerVolumesReader *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileReader
static int	IsTypeOf (const char *type)

static vtkMRMLFileReader *	New ()

static vtkMRMLFileReader *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileIOHandler
static std::vector< std::string >	ExtensionsFromNameFilter (const std::string &nameFilter)
	The extensions named by a filter such as "Mimics project (.mcs .mcs.gz)".

static std::vector< std::string >	GetMatchingNameFilters (const std::string &filePath, const std::vector< std::string > &nameFilters, bool requireReadableFile, int *longestExtensionMatch=nullptr)

static int	IsTypeOf (const char *type)

static std::string	LongestMatchingExtension (const std::string &filePath, const std::vector< std::string > &extensions)

static std::vector< std::string >	NameFilterToWildcards (const std::string &nameFilter)

static vtkMRMLFileIOHandler *	New ()

static vtkMRMLFileIOHandler *	SafeDownCast (vtkObject *o)

static bool	WildcardMatch (const std::string &pattern, const std::string &text)
	Case-insensitive wildcard matching of the whole text. Supported wildcards: '*', '?', and character sets ("[abc]", "[!abc]").

Protected Member Functions
	vtkSlicerVolumesReader ()

	~vtkSlicerVolumesReader () override

Protected Member Functions inherited from vtkMRMLFileReader
	vtkMRMLFileReader ()

	~vtkMRMLFileReader () override

Protected Member Functions inherited from vtkMRMLFileIOHandler
	vtkMRMLFileIOHandler ()

	~vtkMRMLFileIOHandler () override

Protected Attributes
vtkWeakPointer< vtkSlicerVolumesLogic >	VolumesLogic

Protected Attributes inherited from vtkMRMLFileReader
double	ConfidenceForMatchingExtension { 0.5 }

std::vector< std::string >	LoadedNodeIDs

Protected Attributes inherited from vtkMRMLFileIOHandler
std::string	Description

std::vector< std::string >	Extensions

vtkWeakPointer< vtkMRMLFileIOManager >	FileIOManager

std::string	FileType

std::vector< std::string >	NameFilters

vtkNew< vtkMRMLIOProperties >	OptionDefaults

vtkWeakPointer< vtkMRMLScene >	Scene

vtkNew< vtkMRMLMessageCollection >	UserMessages

Additional Inherited Members
Static Protected Member Functions inherited from vtkMRMLFileReader
static bool	EndsWithNoCase (const std::string &text, const std::string &suffix)
	Returns true if the string ends with the suffix (case-insensitive).

static std::string	ReadFileHeader (const std::string &filePath, size_t maxLength)

Detailed Description

Reader of volume files.

Properties: "fileName", "name", "labelmap", "center", "singleFile", "autoWindowLevel", "discardOrientation", "show", "fileNames" (list of strings), "colorNodeID".

Definition at line 35 of file vtkSlicerVolumesReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLFileReader vtkSlicerVolumesReader::Superclass

Definition at line 39 of file vtkSlicerVolumesReader.h.

Constructor & Destructor Documentation

◆ vtkSlicerVolumesReader()

vtkSlicerVolumesReader::vtkSlicerVolumesReader ( )

protected

◆ ~vtkSlicerVolumesReader()

vtkSlicerVolumesReader::~vtkSlicerVolumesReader ( )

overrideprotected

Member Function Documentation

◆ CanLoadFileConfidence()

double vtkSlicerVolumesReader::CanLoadFileConfidence ( const std::string & filePath )

overridevirtual

Returns a positive number (>0) if the reader can load this file. In case the file uses a generic file extension (such as .nrrd) then the confidence value is adjusted based on the file content: if the file contains a dwmri nrrd file then confidence is increased to 0.7

Reimplemented from vtkMRMLFileReader.

◆ ExamineFileList()

std::string vtkSlicerVolumesReader::ExamineFileList	(	std::vector< std::string > &	fileList,
		vtkMRMLIOProperties *	ioProperties )

overridevirtual

Check each file to see if it's recognized as part of a series. If so, keep it as the archetype and remove all the others from the list.

Reimplemented from vtkMRMLFileReader.

◆ GetClassName()

virtual const char * vtkSlicerVolumesReader::GetClassName ( )

virtual

Reimplemented from vtkMRMLFileReader.

◆ GetOptionsDescription()

void vtkSlicerVolumesReader::GetOptionsDescription ( vtkMRMLIOOptionsDescription * description )

overridevirtual

Options: "name", "labelmap", "singleFile", "center", "discardOrientation", "show", "colorNodeID". Default name, labelmap, and single file options are determined from the file names.

Reimplemented from vtkMRMLFileIOHandler.

◆ GetVolumesLogic()

vtkSlicerVolumesLogic * vtkSlicerVolumesReader::GetVolumesLogic ( )

◆ IsA()

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

virtual

Reimplemented from vtkMRMLFileReader.

◆ IsTypeOf()

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

static

◆ Load()

bool vtkSlicerVolumesReader::Load ( vtkMRMLIOProperties * properties )

overridevirtual

Read the file specified by the "fileName" property into the scene. Loaded nodes are reported by AddLoadedNodeID(). Returns true on success. The base class reads nothing and returns false.

Reimplemented from vtkMRMLFileReader.

◆ New()

static vtkSlicerVolumesReader * vtkSlicerVolumesReader::New ( )

static

◆ PrintSelf()

void vtkSlicerVolumesReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

override

◆ SafeDownCast()

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

static

◆ SetVolumesLogic()

void vtkSlicerVolumesReader::SetVolumesLogic ( vtkSlicerVolumesLogic * logic )

Member Data Documentation

◆ VolumesLogic

vtkWeakPointer<vtkSlicerVolumesLogic> vtkSlicerVolumesReader::VolumesLogic

protected

Definition at line 64 of file vtkSlicerVolumesReader.h.

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

Modules/Loadable/Volumes/Logic/vtkSlicerVolumesReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSlicerVolumesReader()

◆ ~vtkSlicerVolumesReader()

Member Function Documentation

◆ CanLoadFileConfidence()

◆ ExamineFileList()

◆ GetClassName()

◆ GetOptionsDescription()

◆ GetVolumesLogic()

◆ IsA()

◆ IsTypeOf()

◆ Load()

◆ New()

◆ PrintSelf()

◆ SafeDownCast()

◆ SetVolumesLogic()

Member Data Documentation

◆ VolumesLogic