Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

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

Classes

  • DatabaseConnection
  • Fileserver
  • FileserverV2
  • HuygensTemplate
  • HuygensTools
  • Log
  • Mail
  • Nav
  • OmeroConnection
  • QueueManager
  • System
  • Util
  • UtilV2
  • Validator

Functions

  • fileButton

Class HuygensTemplate

Converts deconvolution parameters into a Huygens batch template.

This class builds Tcl-compliant nested lists which summarize the tasks and properties of the deconvolution job. Tasks describing the thumbnail products of an HRM deconvolution job are also included. The resulting structure is a Huygens batch template formed by nested lists.

Template structure: - 1 Job: - Job info. - Job tasks list: - Set environment - Set task ID - Set environment: - resultDir - perJobThreadCnt - concurrentJobCnt - exportFormat - timeOut - Set image processing list: - Set image processing info: - state - tag - timeStartAbs - timeOut - Set image processing subtasks: - imgOpen - setp - deconvolution algorithm: one per channel - previewGen (one per thumbnail type) - imgSave - Set subtasks details (imgOpen, setp,..)

Namespace: hrm
Located at HuygensTemplate.php

Methods summary

public
# __construct( hrm\job\JobDescription $jobDescription )

Constructor

Constructor

Parameters

$jobDescription
JobDescription object
public string|integer
# getSamplingSizeX( )

Gets the sampling distance in the X direction.

Gets the sampling distance in the X direction.

Returns

string|integer

The sampling in the X direction, if specified by the user.

public string|integer
# getSamplingSizeY( )

Gets the sampling distance in the Y direction.

Gets the sampling distance in the Y direction.

Returns

string|integer

The sampling in the Y direction, if specified by the user.

public string|integer
# getSamplingSizeZ( )

Gets the sampling distance in the Z direction.

Gets the sampling distance in the Z direction.

Returns

string|integer

The sampling in the Z direction, if specified by the user.

public string|float
# getSamplingSizeT( )

Gets the sampling interval in T.

Gets the sampling interval in T.

Returns

string|float
The sampling in T, if specified by the user.

Properties summary

public string $template

Batch template containing the deconvolution job + thumbnail tasks.

Batch template containing the deconvolution job + thumbnail tasks.

#
public boolean $compareZviews

A boolean to know whether a Z slicer will be created.

A boolean to know whether a Z slicer will be created.

#
public boolean $compareTviews

A boolean to know whether a T slicer will be created.

A boolean to know whether a T slicer will be created.

#
Huygens Remote Manager API documentation generated by ApiGen