Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • hrm\DatabaseConnection
  • hrm\Fileserver
  • hrm\FileserverV2
  • hrm\HuygensTemplate
  • hrm\HuygensTools
  • hrm\job\Job
  • hrm\job\JobDescription
  • hrm\job\JobQueue
  • hrm\Log
  • hrm\Mail
  • hrm\Nav
  • hrm\OmeroConnection
  • hrm\param\AberrationCorrectionMode
  • hrm\param\AberrationCorrectionNecessary
  • hrm\param\AdvancedCorrectionOptions
  • hrm\param\Autocrop
  • hrm\param\BackgroundOffsetPercent
  • hrm\param\base\AnyTypeArrayParameter
  • hrm\param\base\BooleanParameter
  • hrm\param\base\ChoiceParameter
  • hrm\param\base\NumericalArrayParameter
  • hrm\param\base\NumericalParameter
  • hrm\param\base\NumericalVectorParameter
  • hrm\param\base\Parameter
  • hrm\param\base\SingleOrMultiChannelParameter
  • hrm\param\Binning
  • hrm\param\CCDCaptorSize
  • hrm\param\CCDCaptorSizeX
  • hrm\param\ChromaticAberration
  • hrm\param\CMount
  • hrm\param\ColocAnalysis
  • hrm\param\ColocChannel
  • hrm\param\ColocCoefficient
  • hrm\param\ColocMap
  • hrm\param\ColocThreshold
  • hrm\param\CoverslipRelativePosition
  • hrm\param\DeconvolutionAlgorithm
  • hrm\param\EmissionWavelength
  • hrm\param\ExcitationWavelength
  • hrm\param\ImageFileFormat
  • hrm\param\IsMultiChannel
  • hrm\param\MicroscopeType
  • hrm\param\MultiChannelOutput
  • hrm\param\NumberOfChannels
  • hrm\param\NumberOfIterations
  • hrm\param\NumericalAperture
  • hrm\param\ObjectiveMagnification
  • hrm\param\ObjectiveType
  • hrm\param\OutputFileFormat
  • hrm\param\PerformAberrationCorrection
  • hrm\param\PinholeSize
  • hrm\param\PinholeSpacing
  • hrm\param\PointSpreadFunction
  • hrm\param\PSF
  • hrm\param\PSFGenerationDepth
  • hrm\param\QualityChangeStoppingCriterion
  • hrm\param\SampleMedium
  • hrm\param\SignalNoiseRatio
  • hrm\param\SpimCenterOffset
  • hrm\param\SpimDir
  • hrm\param\SpimExcMode
  • hrm\param\SpimFill
  • hrm\param\SpimFocusOffset
  • hrm\param\SpimGaussWidth
  • hrm\param\SpimNA
  • hrm\param\Sted3D
  • hrm\param\StedDepletionMode
  • hrm\param\StedImmunity
  • hrm\param\StedSaturationFactor
  • hrm\param\StedWavelength
  • hrm\param\TimeInterval
  • hrm\param\TubeFactor
  • hrm\param\ZStabilization
  • hrm\param\ZStepSize
  • hrm\QueueManager
  • hrm\setting\AnalysisSetting
  • hrm\setting\AnalysisSettingEditor
  • hrm\setting\base\Setting
  • hrm\setting\base\SettingEditor
  • hrm\setting\JobAnalysisSetting
  • hrm\setting\JobParameterSetting
  • hrm\setting\JobTaskSetting
  • hrm\setting\ParameterSetting
  • hrm\setting\ParameterSettingEditor
  • hrm\setting\TaskSetting
  • hrm\setting\TaskSettingEditor
  • hrm\shell\ExternalProcess
  • hrm\shell\ExternalProcessFactory
  • hrm\shell\LocalExternalProcess
  • hrm\stats\Stats
  • hrm\stats\Type
  • hrm\System
  • hrm\user\proxy\AbstractProxy
  • hrm\user\proxy\ActiveDirectoryProxy
  • hrm\user\proxy\Auth0Proxy
  • hrm\user\proxy\DatabaseProxy
  • hrm\user\proxy\LDAPProxy
  • hrm\user\proxy\ProxyFactory
  • hrm\user\UserConstants
  • hrm\user\UserManager
  • hrm\user\UserV2
  • hrm\Util
  • hrm\UtilV2
  • hrm\Validator

Functions

  • hrm\fileButton

Todo

Classes summary

hrm\param\Autocrop Whyt not using a BooleanParameter?
hrm\param\base\SingleOrMultiChannelParameter Check whether this is still used anywhere.
hrm\param\ChromaticAberration

This did not inherit from any base class. Now it inherits from Parameter. Make sure that it still works as expected!


hrm\param\IsMultiChannel Is this still in use?
hrm\param\PerformAberrationCorrection Why not a BooleanParameter?
hrm\param\ZStabilization Why not a BooleanParameter?

Methods summary

hrm\DatabaseConnection loadParameterSettings() Debug the switch blog (possibly buggy!)
hrm\DatabaseConnection loadSharedParameterSettings() Debug the second switch block (probably buggy!)
hrm\DatabaseConnection fileFormatsWith() Check if this method is still used.
hrm\DatabaseConnection geometriesWith() Check if this method is still used.
hrm\DatabaseConnection huscriptPathOn() Better management of multiple hosts.
hrm\Fileserver isReachable() Test if accessible/writable.
hrm\Fileserver files() Do not return different types!
hrm\Fileserver listFiles() Refactor!
hrm\Fileserver destFiles() Do not return different types!
hrm\Fileserver filesOfType() Refactor!
hrm\Fileserver getFilePattern() A new design and implementation of the file server is necessary.
hrm\Fileserver downloadResults() This will be replaced soon!
hrm\Fileserver uploadFiles() This will be replaced soon!
hrm\Fileserver getImageOptionLine() Check why this function taks 6 parameters and uses only one.
hrm\HuygensTools askHuCore() Do not return different types!
hrm\job\Job checkResultImage() Refactor!
hrm\job\Job checkProcessFinished() Refactor!
hrm\job\JobDescription load() Check that the ParameterSetting->numberOfChannels() exists!
hrm\job\JobDescription sourceImageName() Isn't this redundant? One could use the FileServer class!
hrm\job\JobDescription sourceImageNameWithoutPath() What about redundant slashes?
Isn't this redundant? One could use the FileServer class!
hrm\job\JobDescription relativeSourcePath() This must go into the Fileserver class!
hrm\job\JobDescription sourceImageShortName() This must go into the Fileserver class!
hrm\job\JobDescription sourceFolder() This must go into the Fileserver class!
hrm\job\JobDescription destinationImageName() This must go into the Fileserver class!
hrm\param\base\NumericalArrayParameter setValue()

Notice that right now we do not force the input argument to be an array, since this requires a large refactoring that will be done in a later stage.


hrm\param\base\NumericalVectorParameter check()

This method calls parent::check() passing one argument, but parent::check() does not take input arguments!


hrm\param\ColocCoefficient setNumberOfChannels() This can be dealt with better!
hrm\param\OutputFileFormat extension() This information is partially in the database.
hrm\QueueManager removeHuygensOutputFiles() Move to Shell.php.
hrm\QueueManager executeTemplate() Update templateName variable with templateName
hrm\QueueManager restoreOwnership() Is this still used?
hrm\QueueManager updateJobAndServerStatus() This method is a mess!
hrm\setting\base\SettingEditor huTemplate2hrmTemplate()

This method always returns false: it should return true at the end and also interpret the output of the call to HuygensTools::askHuCore() to decide whether it was successful or not!


hrm\setting\ParameterSetting threeDimensionalGeometries() Check if this is still in use.
hrm\setting\ParameterSetting timeSeriesGeometries() Check if this is still in use.
hrm\setting\ParameterSetting fixedGeometryFileFormats() Check if this is still in use.
hrm\setting\ParameterSetting singleChannelFileFormats() Check if this is still in use.
hrm\setting\ParameterSetting multiChannelFileFormats() Check if this is still in use.
hrm\setting\ParameterSetting variableChannelFileFormats() Check if this is still in use.
hrm\setting\ParameterSetting isMultiChannel() Check if this is still in use.
hrm\setting\ParameterSetting isVariableChannelFormat() Check if this is still in use.
hrm\setting\ParameterSetting isTif() Check if this is still in use.
hrm\setting\ParameterSetting pixelSize() This is redundant!
hrm\setting\ParameterSettingEditor image2hrmTemplate()

This method always returns false: it should return true at the end and also interpret the output of the call to HuygensTools::askHuCore() to decide whether it was successful or not!


hrm\setting\TaskSetting isEligibleForCAC() Why is this taking a ParameterSetting as an input?
hrm\shell\ExternalProcess rewakeHuygensProcess() Replace deprecated split() call.
hrm\shell\ExternalProcess ping() Refactor: why is this saving to hrm_tmp?
hrm\shell\ExternalProcess runHuygensTemplate() Improve the pid acquisition process.
Better management of file handles.
Refactor!
hrm\shell\LocalExternalProcess existsHuygensProcess() Refactor!
hrm\shell\LocalExternalProcess isHuygensProcessSleeping() Is it correct that this always return false?
Refactor: why is this saving to hrm_tmp?
hrm\shell\LocalExternalProcess rewakeHuygensProcess() This function is currenly doing nothing.
hrm\shell\LocalExternalProcess execute() Why sleeping 5 seconds?
hrm\Util isValueInArray() Is this really necessary?
hrm\UtilV2 getMaxUploadFileSize()

Does the php.ini value play a role in the chunk uploader (i.e., does it apply to the file chunk size)?


Properties summary

hrm\shell\ExternalProcess $host Implement better management of multiple hosts
Huygens Remote Manager API documentation generated by ApiGen