 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Base/ParseFolderAndRunWorkspaceAlgorithm.h>
Algorithm to parse through folder structures and run a workspace on individual files. More...
Inheritance diagram for ParseFolderAndRunWorkspaceAlgorithm:Algorithm to parse through folder structures and run a workspace on individual files.
Note that is algorithm only parses the folder structures and obtains a file list. The loading and execution of a workspace file is in done in the controller, because this requires access to the application controller.
The workspace file to be executed on each found file may have contain the following placeholders: %(OrigFilePath) - full path of the input file %(OrigFileDirectory) - folder that contains the input file %(OrigFileStem) - input file name stem without extension %(OrigFileExt) - input file extension, including the period %(Index) - zero-based index of the current file %(IndexPadded) - zero-based index of the current file, padded with as many leading zeros as necessary
These placeholders allow a workspace file as follows:
The workspace above assumes the input file to contain one item, which will have index -1 when the workspace is executed. It is greyscale converted and saved into the original folder, with the original name plus the suffix _gray.imf.
Public Member Functions | |
| const std::vector< std::string > & | fileList () const |
| Retrieve the list of files for processing. | |
| size_t | totalFileSize () const |
| Gets the sum of files sizes of the files in fileList() in MB. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual OwningDataList | takeOutput () |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Public Attributes | |
| Parameter< std::string > | p_basePath = {"basePath", "", this} |
| Parent path to start looking for files. | |
| Parameter< std::string > | p_filterRegex = {"filterRegex", "", this} |
| Regular expression to filter particular files. | |
| Parameter< int > | p_maxDepth = {"maxDepth", -1, this} |
| Max. number of folders to be search recursively, -1 for no limit. | |
| Parameter< std::string > | p_workspaceFile = {"workspaceFile", "", this} |
| Workspace file to run after loading each file. | |
| Public Attributes inherited from Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
Methods implementing the algorithm interface | |
| void | compute () override |
| Parses the folder structures and obtains a file list. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
Additional Inherited Members | |
| Public Types inherited from Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
| Static Public Member Functions inherited from Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
| Protected Member Functions inherited from Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute() | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
overridevirtual |
Parses the folder structures and obtains a file list.
Implements Algorithm.
