vtkSlicerSequencesReader Class Reference

#include <Modules/Loadable/Sequences/Logic/vtkSlicerSequencesReader.h>

Inheritance diagram for vtkSlicerSequencesReader:

Collaboration diagram for vtkSlicerSequencesReader:

Public Types
enum	{ ShowSequenceBrowserRequestedEvent = vtkCommand::UserEvent + 182 }
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
	For generic file extensions the file content is inspected to determine if it is a sequence.
virtual const char *	GetClassName ()
vtkSlicerSequencesLogic *	GetSequencesLogic ()
virtual int	IsA (const char *type)
bool	Load (vtkMRMLIOProperties *properties) override
void	SetSequencesLogic (vtkSlicerSequencesLogic *logic)
Public Member Functions inherited from vtkMRMLFileReader
void	AddLoadedNodeID (const std::string &nodeID)
virtual bool	CanLoadFile (const std::string &filePath)
void	ClearLoadedNodeIDs ()
virtual std::string	ExamineFileList (std::vector< std::string > &fileList, vtkMRMLIOProperties *ioProperties)
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 ()
virtual void	GetOptionsDescription (vtkMRMLIOOptionsDescription *description)
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 vtkSlicerSequencesReader *	New ()
static vtkSlicerSequencesReader *	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
	vtkSlicerSequencesReader ()
	~vtkSlicerSequencesReader () override
Protected Member Functions inherited from vtkMRMLFileReader
	vtkMRMLFileReader ()
	~vtkMRMLFileReader () override
Protected Member Functions inherited from vtkMRMLFileIOHandler
	vtkMRMLFileIOHandler ()
	~vtkMRMLFileIOHandler () override

Protected Attributes
vtkWeakPointer< vtkSlicerSequencesLogic >	SequencesLogic
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 sequence files.

Properties: "fileName", "name", "show" (create a sequence browser and show the proxy node), "colorNodeID".

If a sequence browser node is created then ShowSequenceBrowserRequestedEvent is invoked, with the sequence browser node as call data, so that the application can show the sequence browser toolbar.

Definition at line 40 of file vtkSlicerSequencesReader.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLFileReader vtkSlicerSequencesReader::Superclass

Definition at line 44 of file vtkSlicerSequencesReader.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
ShowSequenceBrowserRequestedEvent

Definition at line 46 of file vtkSlicerSequencesReader.h.

Constructor & Destructor Documentation

vtkSlicerSequencesReader()

vtkSlicerSequencesReader::vtkSlicerSequencesReader ( )

protected

~vtkSlicerSequencesReader()

vtkSlicerSequencesReader::~vtkSlicerSequencesReader ( )

overrideprotected

Member Function Documentation

CanLoadFileConfidence()

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

overridevirtual

For generic file extensions the file content is inspected to determine if it is a sequence.

Reimplemented from vtkMRMLFileReader.

GetClassName()

virtual const char * vtkSlicerSequencesReader::GetClassName ( )

virtual

Reimplemented from vtkMRMLFileReader.

GetSequencesLogic()

vtkSlicerSequencesLogic * vtkSlicerSequencesReader::GetSequencesLogic

(

)

IsA()

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

virtual

Reimplemented from vtkMRMLFileReader.

IsTypeOf()

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

static

Load()

bool vtkSlicerSequencesReader::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 vtkSlicerSequencesReader * vtkSlicerSequencesReader::New ( )

static

SafeDownCast()

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

static

SetSequencesLogic()

void vtkSlicerSequencesReader::SetSequencesLogic

(

vtkSlicerSequencesLogic *

logic

)

Member Data Documentation

SequencesLogic

vtkWeakPointer<vtkSlicerSequencesLogic> vtkSlicerSequencesReader::SequencesLogic

protected

Definition at line 63 of file vtkSlicerSequencesReader.h.

---

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

• Modules/Loadable/Sequences/Logic/vtkSlicerSequencesReader.h