Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends

VolumeIndex Class Reference

Inheritance diagram for VolumeIndex:
Image Section Slice

List of all members.

Public Types

enum  IndexType { SECTION, SLICE, IMAGE }

Public Member Functions

 VolumeIndex (IndexType type)
void SaveBasic (QXmlStreamWriter &xmlWriter)
void SaveDetails ()
void SaveToolPaths (QXmlStreamWriter &xmlWriter)
IndexType Type () const
SectionGetSection ()
const SectionGetSection () const
SliceGetSlice (bool first=true)
void AddToLists (const QString &channel, const QStringList &downsamples)
QStringList GetOutputFiles (const AliasType &type, const QString &channel, bool absolutePaths=true, bool allOfThisType=false)
QStringList GetInputFiles (const QString &filter, const QString &channel, bool absolutePaths=true)
QStringList GetFilesFromDisk (const QString &filter, const QString &channel, bool absolutePaths=true)
bool HasFilesOnDisk (const QString &filter, const QString &channel)
QStringList GetIdentifierEntryList (const QDir &dir, const QString &identifier, const QString &filter) const
QString ReplacePlaceholderDirectory (const QString &str, const QString &channel="", bool first=true)
bool GetPlaceholderDirectory (QDir &result, QString &flag, QString &dirFlag, const QString &str, const QString &channel="", bool first=true)
Tool::ToolType ToolType (const QStringList &channels)
bool HasRun (AliasType type, const QString &channel)
QList< ToolInfoGetAllToolsRun ()
QString Name () const
virtual QString ControlName () const
virtual VolumeIndexControlSection () const
virtual void ToolFinished (const ReadiedProcess &finishedProcess)
virtual void ImportListOfToolsRun (const QStringList &channels)
bool operator> (const VolumeIndex &rhs)
bool operator< (const VolumeIndex &rhs)
bool operator== (const VolumeIndex &rhs)
void TakeSnapshot (const QDir &path, bool reverse=false)
void RestoreSnapshot (const QDir &path)
bool IsValid () const
bool IsValid (const QString &channel, const QString &downsample)
void Invalidate ()
QDir StosDir ()
QDir MosaicDir ()
QDir ImageDir ()
QDir ImageDir (const QString &channel)
bool IsHardLinkedToData ()
bool MosaicDirExists ()

Static Public Member Functions

static void StaticInitialize ()
static QList< VolumeIndex * > ConvertToVolumeIndexList (const QList< Section * > &list)
static QList< VolumeIndex * > ConvertToVolumeIndexList (const QList< Slice * > &list)
static void Merge (QStringList &a, const QStringList &b)
static bool GetPlaceholderTag (QString &winner, const QString &str)
static bool TagsCompatible (const QString &left, const QString &right)
static bool ComparePathsWithTags (const QString &left, const QStringList &fileList)
static QString XmlToTag (const QString &xml)

Protected Member Functions

void AddTool (AliasType type, const QStringList &channels, const QHash< QString, QStringList > &outputPaths)
bool AddTool (const ToolInfo &info)
bool RemoveTool (const ToolInfo &info)
void VerifyToolPaths ()

Protected Attributes

QList< ToolInfotoolsRun
QHash< QString, QStringList > validChannels
bool hardLinkData
QString name
QString savePath
QDir mosaicDir
QDir sliceDir
bool valid

Friends

class Volume
class VolumeImporter
class Iris::IrisTests

Member Function Documentation

QString VolumeIndex::XmlToTag ( const QString &  xml ) [static]

ToolList.xml allows specifying directories by use of the dir attribute. There are multiple different directories that are available to the tool through this tag.

Valid Tags:
  • section - Section directory. Generally 0001, 0002, ect. If a Slice requests this, it's parent section directory is used.
  • slice - Slice directory. Generally 0001-0001, 0001-0002, ect. When a Section is selected, it's first or last slice directory is used, depending on if it's the first Section the tool is using.
  • index - Slice/Section directory. The index directory will be returned. This is a slice directory for a Slice index, and the section directory for a Section index.
  • sectionfirstmosaic - Checks to make sure the directory exists. It prefers a section directory. If no valid directory exists, but a valid slice directory exists, the slice directory is used instead.
  • image - Same as index , but for images.
  • sectionimage - Same as section , but for images. Note, sections don't have image directories by default. A section image directory is created by maximum intensity projection tools.
  • sliceimage - Same as slice , but for images.
  • sliceimage - Same as sectionfirstmosaic , but for images.
  • volume - Returns the volume directory. This is the directory where the section to section (.stos) files are located.


The documentation for this class was generated from the following files:
 All Classes Functions Variables